Zikula_Template_Plugins
[ class tree: Zikula_Template_Plugins ] [ index: Zikula_Template_Plugins ] [ all elements ]
Packages:
Zikula 1.0.1
axmls
PHPLayersMenu
PHPMailer
phpSniff
pnForm
PostNuke_Core
RC4Crypt
SafeHTML
Services_JSON
SimplePie
Smarty
Xanthia_Templating_Environment
XML_HTMLSax3
ZikulaTemplate_Plugins
Zikula_Core
Zikula_Docs
Zikula_System_Modules
Zikula_Template_Plugins
Zikula_Themes
Zikula_Value_Addons

Source for file function.pnformbutton.php

Documentation is available at function.pnformbutton.php

  1. <?php
  2. /**
  3.  * Button plugin
  4.  *
  5.  * @copyright (c) 2006, Zikula Development Team
  6.  * @link http://www.zikula.org
  7.  * @version $Id: function.pnformbutton.php 24342 2008-06-06 12:03:14Z markwest $
  8.  * @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
  9.  * @author Jorn Wildt
  10.  * @package Zikula_Template_Plugins
  11.  * @subpackage Functions
  12.  */
  13.  
  14. /**
  15.  * Button
  16.  *
  17.  * Buttons can be used to fire command events in your form event handler.
  18.  * When the user activates a button the command name and command argument
  19.  * will be sent to the form event handlers handleCommand function.
  20.  * Example:
  21.  * <code>
  22.  *  function handleCommand(&$render, &$args)
  23.  *  {
  24.  *    if ($args['commandName'] == 'update')
  25.  *    {
  26.  *      if (!$render->pnFormIsValid())
  27.  *        return false;
  28.  *
  29.  *      $data = $render->pnFormGetValues();
  30.  *
  31.  *      DBUtil::updateObject($data, 'demo_data');
  32.  *    }
  33.  *
  34.  *    return true;
  35.  *  }
  36.  * </code>
  37.  *
  38.  * The command arguments ($args) passed to the handler contains 'commandName' and
  39.  * 'commandArgument' with the values you passed to the button in the template.
  40.  *
  41.  * @package pnForm
  42.  * @subpackage Plugins
  43.  */
  44. class pnFormButton extends pnFormStyledPlugin
  45. {
  46.     /**
  47.      * Displayed text on the button
  48.      *
  49.      * You can use _XXX language defines directly as the text, no need to call <!--[pnml]--> for
  50.      * translation.
  51.      * @var string 
  52.      */
  53.     var $text;
  54.  
  55.     /**
  56.      * Name of command event handler method
  57.      * @var string Default is "handleCommand"
  58.      */
  59.     var $onCommand = 'handleCommand';
  60.  
  61.     /**
  62.      * Command name
  63.      * 
  64.      * This is the "commandName" parameter to pass in the event args of the command handler.
  65.      * @var string 
  66.      */
  67.     var $commandName;
  68.  
  69.     /**
  70.      * Command argument
  71.      *
  72.      * This value is passed in the event arguments to the form event handler as the commandArgument value.
  73.      * @var string 
  74.      */
  75.     var $commandArgument;
  76.  
  77.     /**
  78.      * Confirmation message
  79.      *
  80.      * If you set a confirmation message then a ok/cancel dialog box pops and asks the user to confirm
  81.      * the button click - very usefull for buttons that deletes items.
  82.      * You can use _XXX language defines directly as the message, no need to call <!--[pnml]--> for
  83.      * translation.
  84.      * @var string 
  85.      */
  86.     var $confirmMessage;
  87.  
  88.     /**
  89.      * CSS styling
  90.      *
  91.      * Please ignore - to be changed.
  92.      * @internal
  93.      */
  94.     var $styleHtml;
  95.  
  96.  
  97.     function getFilename()
  98.     {
  99.         return __FILE__; // FIXME: may be found in smarty's data???
  100.     }
  101.  
  102.  
  103.     function render(&$render)
  104.     {
  105.         $idHtml = $this->getIdHtml();
  106.  
  107.         $fullName = $this->id . '_' . $this->commandName;
  108.  
  109.         $onclickHtml = '';
  110.         if ($this->confirmMessage != null)
  111.         {
  112.           $msg = $render->pnFormTranslateForDisplay($this->confirmMessage) . '?';
  113.           $onclickHtml = " onclick=\"return confirm('$msg');\"";
  114.         }
  115.  
  116.         $text = $render->pnFormTranslateForDisplay($this->text);
  117.  
  118.         $attributes = $this->renderAttributes($render);
  119.  
  120.         $result = "<input $idHtml type=\"submit\" name=\"$fullName\" value=\"$text\"$onclickHtml{$attributes}/>";
  121.  
  122.         return $result;
  123.     }
  124.  
  125.  
  126.     function decodePostBackEvent(&$render)
  127.     {
  128.         $fullName = $this->id . '_' . $this->commandName;
  129.  
  130.         if (isset($_POST[$fullName]))
  131.         {
  132.             $args = array('commandName' => $this->commandName,
  133.                           'commandArgument' => $this->commandArgument);
  134.             if (!empty($this->onCommand))
  135.                 if ($render->pnFormRaiseEvent($this->onCommand, $args) === false)
  136.                     return false;
  137.         }
  138.  
  139.         return true;
  140.     }
  141. }
  142.  
  143.  
  144. function smarty_function_pnformbutton($params, &$render)
  145. {
  146.     return $render->pnFormRegisterPlugin('pnFormButton', $params);
  147. }
Documentation generated on Fri, 18 Jul 2008 21:45:40 +0200 by phpDocumentor 1.4.1