chamilo / chamilo-lms

main/inc/lib/pear/HTML/QuickForm/advanced_settings.php

Doc Comments -1 removed lines

@@ -8,7 +8,6 @@
     /**
     * Class constructor
     *
-    * @param string $text   raw HTML to add
     * @access public
     * @return void
     */

Indentation +13 added lines, -13 removed lines

@@ -6,12 +6,12 @@ 
 class HTML_QuickForm_advanced_settings extends HTML_QuickForm_static
 {
     /**
-    * Class constructor
-    *
-    * @param string $text   raw HTML to add
-    * @access public
-    * @return void
-    */
+     * Class constructor
+     *
+     * @param string $text   raw HTML to add
+     * @access public
+     * @return void
+     */
     public function __construct($name = '', $label = '')
     {
         if (empty($label)) {
@@ -26,13 +26,13 @@ 
         $this->_type = 'html';
     }
 
-   /**
-    * Accepts a renderer
-    *
-    * @param HTML_QuickForm_Renderer    renderer object (only works with Default renderer!)
-    * @access public
-    * @return void
-    */
+    /**
+     * Accepts a renderer
+     *
+     * @param HTML_QuickForm_Renderer    renderer object (only works with Default renderer!)
+     * @access public
+     * @return void
+     */
     function accept(&$renderer, $required = false, $error = null)
     {
         $renderer->renderHtml($this);

main/inc/lib/pear/HTML/QuickForm/button.php

Doc Comments +7 added lines, -7 removed lines

@@ -117,7 +117,7 @@ 
     }
 
     /**
-     * @param mixed $class
+     * @param string|null $class
      */
     public function setClass($class)
     {
@@ -125,7 +125,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string|null
      */
     public function getIcon()
     {
@@ -133,7 +133,7 @@ 
     }
 
     /**
-     * @param mixed $icon
+     * @param string $icon
      */
     public function setIcon($icon)
     {
@@ -141,7 +141,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string|null
      */
     public function getStyle()
     {
@@ -149,7 +149,7 @@ 
     }
 
     /**
-     * @param mixed $style
+     * @param string $style
      */
     public function setStyle($style)
     {
@@ -180,7 +180,7 @@ 
         $this->columnsSize = $columnsSize;
     }
     /**
-     * @param mixed $size
+     * @param string $size
      */
     public function setSize($size)
     {
@@ -207,7 +207,7 @@ 
      * Freeze the element so that only its value is returned
      *
      * @access    public
-     * @return    void
+     * @return    boolean
      */
     public function freeze()
     {

Spacing +3 added lines, -3 removed lines

@@ -94,14 +94,14 @@
             $icon = $this->getIcon();
 
             if (!empty($icon)) {
-                $icon = '<em class="' . $this->getIcon() . '"></em> ';
+                $icon = '<em class="'.$this->getIcon().'"></em> ';
             }
 
             $class = $this->getClass().' '.$this->getStyle().' '.$this->getSize();
 
             return
-                $this->_getTabs() . '
-                <button class="'.$class.'" ' . $this->_getAttrString($this->_attributes) . '>'.
+                $this->_getTabs().'
+                <button class="'.$class.'" '.$this->_getAttrString($this->_attributes).'>'.
                 $icon.
                 $value.
                 '</button>';

main/inc/lib/pear/HTML/QuickForm/Controller.php

Doc Comments +1 added lines

@@ -191,6 +191,7 @@
     * @access public
     * @param  HTML_QuickForm_Page   The page that failed to handle the action
     * @param  string                Name of the action
+    * @param HTML_QuickForm_Page $page
     * @throws PEAR_Error
     */
     function handle(&$page, $actionName)

Indentation +181 added lines, -181 removed lines

@@ -40,48 +40,48 @@ 
  */
 class HTML_QuickForm_Controller
 {
-   /**
-    * Contains the pages (HTML_QuickForm_Page objects) of the miultipage form
-    * @var array
-    */
+    /**
+     * Contains the pages (HTML_QuickForm_Page objects) of the miultipage form
+     * @var array
+     */
     var $_pages = array();
 
-   /**
-    * Contains the mapping of actions to corresponding HTML_QuickForm_Action objects
-    * @var array
-    */
+    /**
+     * Contains the mapping of actions to corresponding HTML_QuickForm_Action objects
+     * @var array
+     */
     var $_actions = array();
 
-   /**
-    * Name of the form, used to store the values in session
-    * @var string
-    */
+    /**
+     * Name of the form, used to store the values in session
+     * @var string
+     */
     var $_name;
 
-   /**
-    * Whether the form is modal
-    * @var bool
-    */
+    /**
+     * Whether the form is modal
+     * @var bool
+     */
     var $_modal = true;
 
-   /**
-    * The action extracted from HTTP request: array('page', 'action')
-    * @var array
-    */
+    /**
+     * The action extracted from HTTP request: array('page', 'action')
+     * @var array
+     */
     var $_actionName = null;
 
-   /**
-    * Class constructor.
-    *
-    * Sets the form name and modal/non-modal behaviuor. Different multipage
-    * forms should have different names, as they are used to store form
-    * values in session. Modal forms allow passing to the next page only when
-    * all of the previous pages are valid.
-    *
-    * @access public
-    * @param  string  form name
-    * @param  bool    whether the form is modal
-    */
+    /**
+     * Class constructor.
+     *
+     * Sets the form name and modal/non-modal behaviuor. Different multipage
+     * forms should have different names, as they are used to store form
+     * values in session. Modal forms allow passing to the next page only when
+     * all of the previous pages are valid.
+     *
+     * @access public
+     * @param  string  form name
+     * @param  bool    whether the form is modal
+     */
     function HTML_QuickForm_Controller($name, $modal = true)
     {
         $this->_name  = $name;
@@ -89,17 +89,17 @@ 
     }
 
 
-   /**
-    * Returns a reference to a session variable containing the form-page
-    * values and pages' validation status.
-    *
-    * This is a "low-level" method, use exportValues() if you want just to
-    * get the form's values.
-    *
-    * @access public
-    * @param  bool      If true, then reset the container: clear all default, constant and submitted values
-    * @return array
-    */
+    /**
+     * Returns a reference to a session variable containing the form-page
+     * values and pages' validation status.
+     *
+     * This is a "low-level" method, use exportValues() if you want just to
+     * get the form's values.
+     *
+     * @access public
+     * @param  bool      If true, then reset the container: clear all default, constant and submitted values
+     * @return array
+     */
     function &container($reset = false)
     {
         $name = '_' . $this->_name . '_container';
@@ -121,15 +121,15 @@ 
     }
 
 
-   /**
-    * Processes the request.
-    *
-    * This finds the current page, the current action and passes the action
-    * to the page's handle() method.
-    *
-    * @access public
-    * @throws PEAR_Error
-    */
+    /**
+     * Processes the request.
+     *
+     * This finds the current page, the current action and passes the action
+     * to the page's handle() method.
+     *
+     * @access public
+     * @throws PEAR_Error
+     */
     function run()
     {
         // the names of the action and page should be saved
@@ -138,25 +138,25 @@ 
     }
 
 
-   /**
-    * Registers a handler for a specific action.
-    *
-    * @access public
-    * @param  string                name of the action
-    * @param  HTML_QuickForm_Action the handler for the action
-    */
+    /**
+     * Registers a handler for a specific action.
+     *
+     * @access public
+     * @param  string                name of the action
+     * @param  HTML_QuickForm_Action the handler for the action
+     */
     function addAction($actionName, &$action)
     {
         $this->_actions[$actionName] =& $action;
     }
 
 
-   /**
-    * Adds a new page to the form
-    *
-    * @access public
-    * @param  HTML_QuickForm_Page
-    */
+    /**
+     * Adds a new page to the form
+     *
+     * @access public
+     * @param  HTML_QuickForm_Page
+     */
     function addPage(&$page)
     {
         $page->controller =& $this;
@@ -164,14 +164,14 @@ 
     }
 
 
-   /**
-    * Returns a page
-    *
-    * @access public
-    * @param  string                Name of a page
-    * @return HTML_QuickForm_Page   A reference to the page
-    * @throws PEAR_Error
-    */
+    /**
+     * Returns a page
+     *
+     * @access public
+     * @param  string                Name of a page
+     * @return HTML_QuickForm_Page   A reference to the page
+     * @throws PEAR_Error
+     */
     function &getPage($pageName)
     {
         if (!isset($this->_pages[$pageName])) {
@@ -181,18 +181,18 @@ 
     }
 
 
-   /**
-    * Handles an action.
-    *
-    * This will be called if the page itself does not have a handler
-    * to a specific action. The method also loads and uses default handlers
-    * for common actions, if specific ones were not added.
-    *
-    * @access public
-    * @param  HTML_QuickForm_Page   The page that failed to handle the action
-    * @param  string                Name of the action
-    * @throws PEAR_Error
-    */
+    /**
+     * Handles an action.
+     *
+     * This will be called if the page itself does not have a handler
+     * to a specific action. The method also loads and uses default handlers
+     * for common actions, if specific ones were not added.
+     *
+     * @access public
+     * @param  HTML_QuickForm_Page   The page that failed to handle the action
+     * @param  string                Name of the action
+     * @throws PEAR_Error
+     */
     function handle(&$page, $actionName)
     {
         if (isset($this->_actions[$actionName])) {
@@ -215,26 +215,26 @@ 
     }
 
 
-   /**
-    * Checks whether the form is modal.
-    *
-    * @access public
-    * @return bool
-    */
+    /**
+     * Checks whether the form is modal.
+     *
+     * @access public
+     * @return bool
+     */
     function isModal()
     {
         return $this->_modal;
     }
 
 
-   /**
-    * Checks whether the pages of the controller are valid
-    *
-    * @access public
-    * @param  string    If set, check only the pages before (not including) that page
-    * @return bool
-    * @throws PEAR_Error
-    */
+    /**
+     * Checks whether the pages of the controller are valid
+     *
+     * @access public
+     * @param  string    If set, check only the pages before (not including) that page
+     * @return bool
+     * @throws PEAR_Error
+     */
     function isValid($pageName = null)
     {
         $data =& $this->container();
@@ -273,13 +273,13 @@ 
     }
 
 
-   /**
-    * Returns the name of the page before the given.
-    *
-    * @access public
-    * @param  string
-    * @return string
-    */
+    /**
+     * Returns the name of the page before the given.
+     *
+     * @access public
+     * @param  string
+     * @return string
+     */
     function getPrevName($pageName)
     {
         $prev = null;
@@ -292,13 +292,13 @@ 
     }
 
 
-   /**
-    * Returns the name of the page after the given.
-    *
-    * @access public
-    * @param  string
-    * @return string
-    */
+    /**
+     * Returns the name of the page after the given.
+     *
+     * @access public
+     * @param  string
+     * @return string
+     */
     function getNextName($pageName)
     {
         $prev = null;
@@ -312,12 +312,12 @@ 
     }
 
 
-   /**
-    * Finds the (first) invalid page
-    *
-    * @access public
-    * @return string  Name of an invalid page
-    */
+    /**
+     * Finds the (first) invalid page
+     *
+     * @access public
+     * @return string  Name of an invalid page
+     */
     function findInvalid()
     {
         $data =& $this->container();
@@ -330,13 +330,13 @@ 
     }
 
 
-   /**
-    * Extracts the names of the current page and the current action from
-    * HTTP request data.
-    *
-    * @access public
-    * @return array     first element is page name, second is action name
-    */
+    /**
+     * Extracts the names of the current page and the current action from
+     * HTTP request data.
+     *
+     * @access public
+     * @return array     first element is page name, second is action name
+     */
     function getActionName()
     {
         if (is_array($this->_actionName)) {
@@ -360,14 +360,14 @@ 
     }
 
 
-   /**
-    * Initializes default form values.
-    *
-    * @access public
-    * @param  array  default values
-    * @param  mixed  filter(s) to apply to default values
-    * @throws PEAR_Error
-    */
+    /**
+     * Initializes default form values.
+     *
+     * @access public
+     * @param  array  default values
+     * @param  mixed  filter(s) to apply to default values
+     * @throws PEAR_Error
+     */
     function setDefaults($defaultValues = null, $filter = null)
     {
         if (is_array($defaultValues)) {
@@ -377,15 +377,15 @@ 
     }
 
 
-   /**
-    * Initializes constant form values.
-    * These values won't get overridden by POST or GET vars
-    *
-    * @access public
-    * @param  array  constant values
-    * @param  mixed  filter(s) to apply to constant values
-    * @throws PEAR_Error
-    */
+    /**
+     * Initializes constant form values.
+     * These values won't get overridden by POST or GET vars
+     *
+     * @access public
+     * @param  array  constant values
+     * @param  mixed  filter(s) to apply to constant values
+     * @throws PEAR_Error
+     */
     function setConstants($constantValues = null, $filter = null)
     {
         if (is_array($constantValues)) {
@@ -395,15 +395,15 @@ 
     }
 
 
-   /**
-    * Adds new values to defaults or constants array
-    *
-    * @access   private
-    * @param    array   array to add values to (either defaults or constants)
-    * @param    array   values to add
-    * @param    mixed   filters to apply to new values
-    * @throws   PEAR_Error
-    */
+    /**
+     * Adds new values to defaults or constants array
+     *
+     * @access   private
+     * @param    array   array to add values to (either defaults or constants)
+     * @param    array   values to add
+     * @param    mixed   filters to apply to new values
+     * @throws   PEAR_Error
+     */
     function _setDefaultsOrConstants(&$values, $newValues, $filter = null)
     {
         if (isset($filter)) {
@@ -425,14 +425,14 @@ 
     }
 
 
-   /**
-    * Recursively applies the callback function to the value
-    *
-    * @param    mixed   Callback function
-    * @param    mixed   Value to process
-    * @access   private
-    * @return   mixed   Processed values
-    */
+    /**
+     * Recursively applies the callback function to the value
+     *
+     * @param    mixed   Callback function
+     * @param    mixed   Value to process
+     * @access   private
+     * @return   mixed   Processed values
+     */
     function _arrayMapRecursive($callback, $value)
     {
         if (!is_array($value)) {
@@ -447,12 +447,12 @@ 
     }
 
 
-   /**
-    * Sets the default values for the given page
-    *
-    * @access public
-    * @param  string  Name of a page
-    */
+    /**
+     * Sets the default values for the given page
+     *
+     * @access public
+     * @param  string  Name of a page
+     */
     function applyDefaults($pageName)
     {
         $data =& $this->container();
@@ -465,13 +465,13 @@ 
     }
 
 
-   /**
-    * Returns the form's values
-    *
-    * @access public
-    * @param  string    name of the page, if not set then returns values for all pages
-    * @return array
-    */
+    /**
+     * Returns the form's values
+     *
+     * @access public
+     * @param  string    name of the page, if not set then returns values for all pages
+     * @return array
+     */
     function exportValues($pageName = null)
     {
         $data   =& $this->container();
@@ -497,14 +497,14 @@ 
     }
 
 
-   /**
-    * Returns the element's value
-    *
-    * @access public
-    * @param  string    name of the page
-    * @param  string    name of the element in the page
-    * @return mixed     value for the element
-    */
+    /**
+     * Returns the element's value
+     *
+     * @access public
+     * @param  string    name of the page
+     * @param  string    name of the element in the page
+     * @return mixed     value for the element
+     */
     function exportValue($pageName, $elementName)
     {
         $data =& $this->container();

Spacing +20 added lines, -20 removed lines

@@ -102,7 +102,7 @@ 
     */
     function &container($reset = false)
     {
-        $name = '_' . $this->_name . '_container';
+        $name = '_'.$this->_name.'_container';
         if (!isset($_SESSION[$name]) || $reset) {
             $_SESSION[$name] = array(
                 'defaults'  => array(),
@@ -147,7 +147,7 @@ 
     */
     function addAction($actionName, &$action)
     {
-        $this->_actions[$actionName] =& $action;
+        $this->_actions[$actionName] = & $action;
     }
 
 
@@ -159,8 +159,8 @@ 
     */
     function addPage(&$page)
     {
-        $page->controller =& $this;
-        $this->_pages[$page->getAttribute('id')] =& $page;
+        $page->controller = & $this;
+        $this->_pages[$page->getAttribute('id')] = & $page;
     }
 
 
@@ -175,7 +175,7 @@ 
     function &getPage($pageName)
     {
         if (!isset($this->_pages[$pageName])) {
-            return PEAR::raiseError('HTML_QuickForm_Controller: Unknown page "' . $pageName . '"');
+            return PEAR::raiseError('HTML_QuickForm_Controller: Unknown page "'.$pageName.'"');
         }
         return $this->_pages[$pageName];
     }
@@ -204,13 +204,13 @@ 
             case 'submit':
             case 'display':
             case 'jump':
-                include_once 'HTML/QuickForm/Action/' . ucfirst($actionName) . '.php';
-                $className = 'HTML_QuickForm_Action_' . $actionName;
-                $this->_actions[$actionName] =& new $className();
+                include_once 'HTML/QuickForm/Action/'.ucfirst($actionName).'.php';
+                $className = 'HTML_QuickForm_Action_'.$actionName;
+                $this->_actions[$actionName] = & new $className();
                 return $this->_actions[$actionName]->perform($page, $actionName);
                 break;
             default:
-                return PEAR::raiseError('HTML_QuickForm_Controller: Unhandled action "' . $actionName . '" in page "' . $page->getAttribute('id') . '"');
+                return PEAR::raiseError('HTML_QuickForm_Controller: Unhandled action "'.$actionName.'" in page "'.$page->getAttribute('id').'"');
         } // switch
     }
 
@@ -237,7 +237,7 @@ 
     */
     function isValid($pageName = null)
     {
-        $data =& $this->container();
+        $data = & $this->container();
         foreach (array_keys($this->_pages) as $key) {
             if (isset($pageName) && $pageName == $key) {
                 return true;
@@ -245,7 +245,7 @@ 
                 // We should handle the possible situation when the user has never
                 // seen a page of a non-modal multipage form
                 if (!$this->isModal() && null === $data['valid'][$key]) {
-                    $page =& $this->_pages[$key];
+                    $page = & $this->_pages[$key];
                     // Fix for bug #8687: the unseen page was considered
                     // submitted, so defaults for checkboxes and multiselects
                     // were not used. Shouldn't break anything since this flag
@@ -320,7 +320,7 @@ 
     */
     function findInvalid()
     {
-        $data =& $this->container();
+        $data = & $this->container();
         foreach (array_keys($this->_pages) as $key) {
             if (!$data['valid'][$key]) {
                 return $key;
@@ -343,7 +343,7 @@ 
             return $this->_actionName;
         }
         $names = array_map('preg_quote', array_keys($this->_pages));
-        $regex = '/^_qf_(' . implode('|', $names) . ')_(.+?)(_x)?$/';
+        $regex = '/^_qf_('.implode('|', $names).')_(.+?)(_x)?$/';
         foreach (array_keys($_REQUEST) as $key) {
             if (preg_match($regex, $key, $matches)) {
                 return array($matches[1], $matches[2]);
@@ -371,7 +371,7 @@ 
     function setDefaults($defaultValues = null, $filter = null)
     {
         if (is_array($defaultValues)) {
-            $data =& $this->container();
+            $data = & $this->container();
             return $this->_setDefaultsOrConstants($data['defaults'], $defaultValues, $filter);
         }
     }
@@ -389,7 +389,7 @@ 
     function setConstants($constantValues = null, $filter = null)
     {
         if (is_array($constantValues)) {
-            $data =& $this->container();
+            $data = & $this->container();
             return $this->_setDefaultsOrConstants($data['constants'], $constantValues, $filter);
         }
     }
@@ -455,7 +455,7 @@ 
     */
     function applyDefaults($pageName)
     {
-        $data =& $this->container();
+        $data = & $this->container();
         if (!empty($data['defaults'])) {
             $this->_pages[$pageName]->setDefaults($data['defaults']);
         }
@@ -474,8 +474,8 @@ 
     */
     function exportValues($pageName = null)
     {
-        $data   =& $this->container();
-        $values =  array();
+        $data   = & $this->container();
+        $values = array();
         if (isset($pageName)) {
             $pages = array($pageName);
         } else {
@@ -507,8 +507,8 @@ 
     */
     function exportValue($pageName, $elementName)
     {
-        $data =& $this->container();
-        return isset($data['values'][$pageName][$elementName])? $data['values'][$pageName][$elementName]: null;
+        $data = & $this->container();
+        return isset($data['values'][$pageName][$elementName]) ? $data['values'][$pageName][$elementName] : null;
     }
 }
 ?>

main/inc/lib/pear/HTML/QuickForm/element.php

Doc Comments +2 added lines, -2 removed lines

@@ -356,7 +356,7 @@ 
      * Sets display text for the element
      *
      * @param     string    $label  Display text for the element
-     * @param     string    $label_for Optionally add a "for" attribute
+     * @param     string    $labelFor Optionally add a "for" attribute
      * @since     1.3
      * @access    public
      * @return    void
@@ -435,7 +435,7 @@ 
      * @param     object    &$caller calling object
      * @since     1.0
      * @access    public
-     * @return    void
+     * @return    boolean
      */
     public function onQuickFormEvent($event, $arg, &$caller)
     {

Indentation +55 added lines, -55 removed lines

@@ -259,13 +259,13 @@ 
     // }}}
     // {{{ unfreeze()
 
-   /**
-    * Unfreezes the element so that it becomes editable
-    *
-    * @access public
-    * @return void
-    * @since  3.2.4
-    */
+    /**
+     * Unfreezes the element so that it becomes editable
+     *
+     * @access public
+     * @return void
+     * @since  3.2.4
+     */
     function unfreeze()
     {
         $this->_flagFrozen = false;
@@ -289,7 +289,7 @@ 
         //       $this->_getPersistantData();
 
         $value =  ('' != $value ? @htmlspecialchars($value, ENT_COMPAT, HTML_Common::charset()): ' ') .
-               $this->_getPersistantData();
+                $this->_getPersistantData();
         return '<span class="freeze">'.$value.'</span>';
         //
     } //end func getFrozenHtml
@@ -297,12 +297,12 @@ 
     // }}}
     // {{{ _getPersistantData()
 
-   /**
-    * Used by getFrozenHtml() to pass the element's value if _persistantFreeze is on
-    *
-    * @access private
-    * @return string
-    */
+    /**
+     * Used by getFrozenHtml() to pass the element's value if _persistantFreeze is on
+     *
+     * @access private
+     * @return string
+     */
     function _getPersistantData()
     {
         if (!$this->_persistantFreeze) {
@@ -310,10 +310,10 @@ 
         } else {
             $id = $this->getAttribute('id');
             return '<input' . $this->_getAttrString(array(
-                       'type'  => 'hidden',
-                       'name'  => $this->getName(),
-                       'value' => $this->getValue()
-                   ) + (isset($id)? array('id' => $id): array())) . ' />';
+                        'type'  => 'hidden',
+                        'name'  => $this->getName(),
+                        'value' => $this->getValue()
+                    ) + (isset($id)? array('id' => $id): array())) . ' />';
         }
     }
 
@@ -415,9 +415,9 @@ 
             return $values[$elementName];
         } elseif (strpos($elementName, '[')) {
             $myVar = "['" . str_replace(
-                         array('\\', '\'', ']', '['), array('\\\\', '\\\'', '', "']['"),
-                         $elementName
-                     ) . "']";
+                            array('\\', '\'', ']', '['), array('\\\\', '\\\'', '', "']['"),
+                            $elementName
+                        ) . "']";
             return eval("return (isset(\$values$myVar)) ? \$values$myVar : null;");
         } else {
             return null;
@@ -471,29 +471,29 @@ 
         return true;
     }
 
-   /**
-    * Accepts a renderer
-    *
-    * @param HTML_QuickForm_Renderer    renderer object
-    * @param bool                       Whether an element is required
-    * @param string                     An error message associated with an element
-    * @access public
-    * @return void
-    */
+    /**
+     * Accepts a renderer
+     *
+     * @param HTML_QuickForm_Renderer    renderer object
+     * @param bool                       Whether an element is required
+     * @param string                     An error message associated with an element
+     * @access public
+     * @return void
+     */
     function accept(&$renderer, $required=false, $error=null)
     {
         $renderer->renderElement($this, $required, $error);
     }
 
-   /**
-    * Automatically generates and assigns an 'id' attribute for the element.
-    *
-    * Currently used to ensure that labels work on radio buttons and
-    * checkboxes. Per idea of Alexander Radivanovich.
-    *
-    * @access private
-    * @return void
-    */
+    /**
+     * Automatically generates and assigns an 'id' attribute for the element.
+     *
+     * Currently used to ensure that labels work on radio buttons and
+     * checkboxes. Per idea of Alexander Radivanovich.
+     *
+     * @access private
+     * @return void
+     */
     function _generateId()
     {
         static $idx = 1;
@@ -503,14 +503,14 @@ 
         }
     }
 
-   /**
-    * Returns a 'safe' element's value
-    *
-    * @param  array   array of submitted values to search
-    * @param  bool    whether to return the value as associative array
-    * @access public
-    * @return mixed
-    */
+    /**
+     * Returns a 'safe' element's value
+     *
+     * @param  array   array of submitted values to search
+     * @param  bool    whether to return the value as associative array
+     * @access public
+     * @return mixed
+     */
     function exportValue(&$submitValues, $assoc = false)
     {
         $value = $this->_findValue($submitValues);
@@ -523,14 +523,14 @@ 
     // }}}
     // {{{ _prepareValue()
 
-   /**
-    * Used by exportValue() to prepare the value for returning
-    *
-    * @param  mixed   the value found in exportValue()
-    * @param  bool    whether to return the value as associative array
-    * @access private
-    * @return mixed
-    */
+    /**
+     * Used by exportValue() to prepare the value for returning
+     *
+     * @param  mixed   the value found in exportValue()
+     * @param  bool    whether to return the value as associative array
+     * @access private
+     * @return mixed
+     */
     function _prepareValue($value, $assoc)
     {
         if (null === $value) {

Spacing +10 added lines, -10 removed lines

@@ -288,7 +288,7 @@ 
         //return ('' != $value? htmlspecialchars($value): ' ') .
         //       $this->_getPersistantData();
 
-        $value =  ('' != $value ? @htmlspecialchars($value, ENT_COMPAT, HTML_Common::charset()): ' ') .
+        $value = ('' != $value ? @htmlspecialchars($value, ENT_COMPAT, HTML_Common::charset()) : ' ').
                $this->_getPersistantData();
         return '<span class="freeze">'.$value.'</span>';
         //
@@ -309,11 +309,11 @@ 
             return '';
         } else {
             $id = $this->getAttribute('id');
-            return '<input' . $this->_getAttrString(array(
+            return '<input'.$this->_getAttrString(array(
                        'type'  => 'hidden',
                        'name'  => $this->getName(),
                        'value' => $this->getValue()
-                   ) + (isset($id)? array('id' => $id): array())) . ' />';
+                   ) + (isset($id) ? array('id' => $id) : array())).' />';
         }
     }
 
@@ -344,7 +344,7 @@ 
      * @access    public
      * @return    void
      */
-    function setPersistantFreeze($persistant=false)
+    function setPersistantFreeze($persistant = false)
     {
         $this->_persistantFreeze = $persistant;
     } //end func setPersistantFreeze
@@ -414,10 +414,10 @@ 
         if (isset($values[$elementName])) {
             return $values[$elementName];
         } elseif (strpos($elementName, '[')) {
-            $myVar = "['" . str_replace(
+            $myVar = "['".str_replace(
                          array('\\', '\'', ']', '['), array('\\\\', '\\\'', '', "']['"),
                          $elementName
-                     ) . "']";
+                     )."']";
             return eval("return (isset(\$values$myVar)) ? \$values$myVar : null;");
         } else {
             return null;
@@ -480,7 +480,7 @@ 
     * @access public
     * @return void
     */
-    function accept(&$renderer, $required=false, $error=null)
+    function accept(&$renderer, $required = false, $error = null)
     {
         $renderer->renderElement($this, $required, $error);
     }
@@ -499,7 +499,7 @@ 
         static $idx = 1;
 
         if (!$this->getAttribute('id')) {
-            $this->updateAttributes(array('id' => 'qf_' . substr(md5(microtime() . $idx++), 0, 6)));
+            $this->updateAttributes(array('id' => 'qf_'.substr(md5(microtime().$idx++), 0, 6)));
         }
     }
 
@@ -543,10 +543,10 @@ 
                 return array($name => $value);
             } else {
                 $valueAry = array();
-                $myIndex  = "['" . str_replace(
+                $myIndex  = "['".str_replace(
                                 array('\\', '\'', ']', '['), array('\\\\', '\\\'', '', "']['"),
                                 $name
-                            ) . "']";
+                            )."']";
                 eval("\$valueAry$myIndex = \$value;");
                 return $valueAry;
             }

main/inc/lib/pear/HTML/QuickForm/file.php

Doc Comments +1 added lines, -1 removed lines

@@ -86,7 +86,7 @@
      *
      * @since     1.0
      * @access    public
-     * @return    int
+     * @return    string|null
      */
     function getSize()
     {

Indentation +17 added lines, -17 removed lines

@@ -38,10 +38,10 @@ 
 {
     // {{{ properties
 
-   /**
-    * Uploaded file data, from $_FILES
-    * @var array
-    */
+    /**
+     * Uploaded file data, from $_FILES
+     * @var array
+     */
     var $_value = null;
 
     // }}}
@@ -237,15 +237,15 @@ 
     // }}}
     // {{{ _ruleCheckMaxFileSize()
 
-   /**
-    * Tries to find the element value from the values array
-    *
-    * Needs to be redefined here as $_FILES is populated differently from
-    * other arrays when element name is of the form foo[bar]
-    *
-    * @access    private
-    * @return    mixed
-    */
+    /**
+     * Tries to find the element value from the values array
+     *
+     * Needs to be redefined here as $_FILES is populated differently from
+     * other arrays when element name is of the form foo[bar]
+     *
+     * @access    private
+     * @return    mixed
+     */
     function _findValue(&$values = null)
     {
         if (empty($_FILES)) {
@@ -262,12 +262,12 @@ 
             $idx   = "['" . str_replace(
                         array('\\', '\'', ']', '['), array('\\\\', '\\\'', '', "']['"),
                         substr($elementName, $pos + 1, -1)
-                     ) . "']";
+                        ) . "']";
             $props = array('name', 'type', 'size', 'tmp_name', 'error');
             $code  = "if (!isset(\$_FILES['{$base}']['name']{$idx})) {\n" .
-                     "    return null;\n" .
-                     "} else {\n" .
-                     "    \$value = array();\n";
+                        "    return null;\n" .
+                        "} else {\n" .
+                        "    \$value = array();\n";
             foreach ($props as $prop) {
                 $code .= "    \$value['{$prop}'] = \$_FILES['{$base}']['{$prop}']{$idx};\n";
             }

Spacing +10 added lines, -10 removed lines

@@ -57,7 +57,7 @@ 
      * @since     1.0
      * @access    public
      */
-    public function __construct($elementName=null, $elementLabel=null, $attributes=null)
+    public function __construct($elementName = null, $elementLabel = null, $attributes = null)
     {
         parent::__construct($elementName, $elementLabel, $attributes);
         $this->setType('file');
@@ -191,11 +191,11 @@ 
      */
     public function moveUploadedFile($dest, $fileName = '')
     {
-        if ($dest != ''  && substr($dest, -1) != '/') {
+        if ($dest != '' && substr($dest, -1) != '/') {
             $dest .= '/';
         }
         $fileName = ($fileName != '') ? $fileName : basename($this->_value['name']);
-        return move_uploaded_file($this->_value['tmp_name'], $dest . $fileName);
+        return move_uploaded_file($this->_value['tmp_name'], $dest.$fileName);
     }
 
     /**
@@ -245,23 +245,23 @@ 
         if (isset($_FILES[$elementName])) {
             return $_FILES[$elementName];
         } elseif (false !== ($pos = strpos($elementName, '['))) {
-            $base  = str_replace(
+            $base = str_replace(
                         array('\\', '\''), array('\\\\', '\\\''),
                         substr($elementName, 0, $pos)
                     );
-            $idx   = "['" . str_replace(
+            $idx = "['".str_replace(
                         array('\\', '\'', ']', '['), array('\\\\', '\\\'', '', "']['"),
                         substr($elementName, $pos + 1, -1)
-                     ) . "']";
+                     )."']";
             $props = array('name', 'type', 'size', 'tmp_name', 'error');
-            $code  = "if (!isset(\$_FILES['{$base}']['name']{$idx})) {\n" .
-                     "    return null;\n" .
-                     "} else {\n" .
+            $code  = "if (!isset(\$_FILES['{$base}']['name']{$idx})) {\n".
+                     "    return null;\n".
+                     "} else {\n".
                      "    \$value = array();\n";
             foreach ($props as $prop) {
                 $code .= "    \$value['{$prop}'] = \$_FILES['{$base}']['{$prop}']{$idx};\n";
             }
-            return eval($code . "    return \$value;\n}\n");
+            return eval($code."    return \$value;\n}\n");
         } else {
             return null;
         }

main/inc/lib/pear/HTML/QuickForm/group.php

Doc Comments +2 added lines, -1 removed lines

@@ -345,7 +345,7 @@ 
      * @param     object    &$caller calling object
      * @since     1.0
      * @access    public
-     * @return    void
+     * @return    boolean
      */
     public function onQuickFormEvent($event, $arg, &$caller)
     {
@@ -384,6 +384,7 @@ 
     * @param HTML_QuickForm_Renderer    renderer object
     * @param bool                       Whether a group is required
     * @param string                     An error message associated with a group
+    * @param HTML_QuickForm_Renderer_Default $renderer
     * @access public
     * @return void
     */

Indentation +39 added lines, -39 removed lines

@@ -68,12 +68,12 @@ 
      */
     private $_required = array();
 
-   /**
-    * Whether to change elements' names to $groupName[$elementName] or leave them as is
-    * @var      bool
-    * @since    3.0
-    * @access   private
-    */
+    /**
+     * Whether to change elements' names to $groupName[$elementName] or leave them as is
+     * @var      bool
+     * @since    3.0
+     * @access   private
+     */
     private $_appendName = true;
 
     /**
@@ -378,15 +378,15 @@ 
         return true;
     }
 
-   /**
-    * Accepts a renderer
-    *
-    * @param HTML_QuickForm_Renderer    renderer object
-    * @param bool                       Whether a group is required
-    * @param string                     An error message associated with a group
-    * @access public
-    * @return void
-    */
+    /**
+     * Accepts a renderer
+     *
+     * @param HTML_QuickForm_Renderer    renderer object
+     * @param bool                       Whether a group is required
+     * @param string                     An error message associated with a group
+     * @access public
+     * @return void
+     */
     function accept(&$renderer, $required = false, $error = null)
     {
         $this->_createElementsIfNotExist();
@@ -416,10 +416,10 @@ 
         $renderer->finishGroup($this);
     }
 
-   /**
-    * As usual, to get the group's value we access its elements and call
-    * their exportValue() methods
-    */
+    /**
+     * As usual, to get the group's value we access its elements and call
+     * their exportValue() methods
+     */
     function exportValue(&$submitValues, $assoc = false)
     {
         $value = null;
@@ -462,31 +462,31 @@ 
         return $value;
     }
 
-   /**
-    * Creates the group's elements.
-    *
-    * This should be overriden by child classes that need to create their
-    * elements. The method will be called automatically when needed, calling
-    * it from the constructor is discouraged as the constructor is usually
-    * called _twice_ on element creation, first time with _no_ parameters.
-    *
-    * @access private
-    * @abstract
-    */
+    /**
+     * Creates the group's elements.
+     *
+     * This should be overriden by child classes that need to create their
+     * elements. The method will be called automatically when needed, calling
+     * it from the constructor is discouraged as the constructor is usually
+     * called _twice_ on element creation, first time with _no_ parameters.
+     *
+     * @access private
+     * @abstract
+     */
     function _createElements()
     {
         // abstract
     }
 
-   /**
-    * A wrapper around _createElements()
-    *
-    * This method calls _createElements() if the group's _elements array
-    * is empty. It also performs some updates, e.g. freezes the created
-    * elements if the group is already frozen.
-    *
-    * @access private
-    */
+    /**
+     * A wrapper around _createElements()
+     *
+     * This method calls _createElements() if the group's _elements array
+     * is empty. It also performs some updates, e.g. freezes the created
+     * elements if the group is already frozen.
+     *
+     * @access private
+     */
     function _createElementsIfNotExist()
     {
         if (empty($this->_elements)) {

Spacing +11 added lines, -11 removed lines

@@ -91,7 +91,7 @@ 
      * @access    public
      * @return    void
      */
-    public function __construct($elementName=null, $elementLabel=null, $elements=null, $separator=null, $appendName = true)
+    public function __construct($elementName = null, $elementLabel = null, $elements = null, $separator = null, $appendName = true)
     {
         parent::__construct($elementName, $elementLabel);
         $this->_type = 'group';
@@ -174,13 +174,13 @@ 
     {
         $value = null;
         foreach (array_keys($this->_elements) as $key) {
-            $element =& $this->_elements[$key];
+            $element = & $this->_elements[$key];
             switch ($element->getType()) {
                 case 'radio':
-                    $v = $element->getChecked()? $element->getValue(): null;
+                    $v = $element->getChecked() ? $element->getValue() : null;
                     break;
                 case 'checkbox':
-                    $v = $element->getChecked()? true: null;
+                    $v = $element->getChecked() ? true : null;
                     break;
                 default:
                     $v = $element->getValue();
@@ -191,7 +191,7 @@ 
                     $value = $v;
                 } else {
                     if (!is_array($value)) {
-                        $value = is_null($value)? array(): array($value);
+                        $value = is_null($value) ? array() : array($value);
                     }
                     if ('' === $elementName) {
                         $value[] = $v;
@@ -360,9 +360,9 @@ 
                         if (is_null($elementName)) {
                             $this->_elements[$key]->setName($this->getName());
                         } elseif ('' === $elementName) {
-                            $this->_elements[$key]->setName($this->getName() . '[' . $key . ']');
+                            $this->_elements[$key]->setName($this->getName().'['.$key.']');
                         } else {
-                            $this->_elements[$key]->setName($this->getName() . '[' . $elementName . ']');
+                            $this->_elements[$key]->setName($this->getName().'['.$elementName.']');
                         }
                     }
                     $this->_elements[$key]->onQuickFormEvent('updateValue', $arg, $caller);
@@ -393,12 +393,12 @@ 
         $renderer->startGroup($this, $required, $error);
         $name = $this->getName();
         foreach (array_keys($this->_elements) as $key) {
-            $element =& $this->_elements[$key];
+            $element = & $this->_elements[$key];
 
             if ($this->_appendName) {
                 $elementName = $element->getName();
                 if (isset($elementName)) {
-                    $element->setName($name . '['. (strlen($elementName)? $elementName: $key) .']');
+                    $element->setName($name.'['.(strlen($elementName) ? $elementName : $key).']');
                 } else {
                     $element->setName($name);
                 }
@@ -429,9 +429,9 @@ 
                 if (is_null($elementName)) {
                     $this->_elements[$key]->setName($this->getName());
                 } elseif ('' === $elementName) {
-                    $this->_elements[$key]->setName($this->getName() . '[' . $key . ']');
+                    $this->_elements[$key]->setName($this->getName().'['.$key.']');
                 } else {
-                    $this->_elements[$key]->setName($this->getName() . '[' . $elementName . ']');
+                    $this->_elements[$key]->setName($this->getName().'['.$elementName.']');
                 }
             }
             $v = $this->_elements[$key]->exportValue($submitValues, $assoc);

main/inc/lib/pear/HTML/QuickForm/radio.php

Doc Comments +5 added lines, -1 removed lines

@@ -52,6 +52,10 @@ 
      * @param     string    Text to display near the radio
      * @param     string    Input field value
      * @param     mixed     Either a typical HTML attribute string or an associative array
+     * @param string $elementName
+     * @param string $elementLabel
+     * @param string $text
+     * @param string $value
      * @since     1.0
      * @access    public
      * @return    void
@@ -189,7 +193,7 @@ 
      * @param     object    &$caller calling object
      * @since     1.0
      * @access    public
-     * @return    void
+     * @return    boolean
      */
     public function onQuickFormEvent($event, $arg, &$caller)
     {

Indentation +4 added lines, -4 removed lines

@@ -150,7 +150,7 @@ 
     {
         if ($this->getChecked()) {
             return '<code>(x)</code>' .
-                   $this->_getPersistantData();
+                    $this->_getPersistantData();
         } else {
             return '<code>( )</code>';
         }
@@ -224,9 +224,9 @@ 
         return true;
     }
 
-   /**
-    * Returns the value attribute if the radio is checked, null if it is not
-    */
+    /**
+     * Returns the value attribute if the radio is checked, null if it is not
+     */
     public function exportValue(&$submitValues, $assoc = false)
     {
         $value = $this->_findValue($submitValues);

Spacing +5 added lines, -5 removed lines

@@ -129,14 +129,14 @@ 
         } else {
             $labelClass = $this->labelClass;
             $radioClass = $this->radioClass;
-            $label = '<div class="'.$radioClass.'"><label class="'.$labelClass.'">' .
-                HTML_QuickForm_input::toHtml().$this->_text .
+            $label = '<div class="'.$radioClass.'"><label class="'.$labelClass.'">'.
+                HTML_QuickForm_input::toHtml().$this->_text.
                 '</label></div>';
 
             return  $label;
         }
 
-        return HTML_QuickForm_input::toHtml() . $label;
+        return HTML_QuickForm_input::toHtml().$label;
     }
 
     /**
@@ -149,7 +149,7 @@ 
     public function getFrozenHtml()
     {
         if ($this->getChecked()) {
-            return '<code>(x)</code>' .
+            return '<code>(x)</code>'.
                    $this->_getPersistantData();
         } else {
             return '<code>( )</code>';
@@ -231,7 +231,7 @@ 
     {
         $value = $this->_findValue($submitValues);
         if (null === $value) {
-            $value = $this->getChecked()? $this->getValue(): null;
+            $value = $this->getChecked() ? $this->getValue() : null;
         } elseif ($value != $this->getValue()) {
             $value = null;
         }

main/inc/lib/pear/HTML/QuickForm/Renderer/ArraySmarty.php

Doc Comments +1 added lines

@@ -331,6 +331,7 @@
     * So we use the smarty eval plugin function	to do this.
     *
     * @param    string      The template source
+    * @param string $tplSource
     * @access   private
     * @return   void
     */

Indentation +145 added lines, -145 removed lines

@@ -87,63 +87,63 @@ 
  */
 class HTML_QuickForm_Renderer_ArraySmarty extends HTML_QuickForm_Renderer_Array
 {
-   /**#@+
+    /**#@+
     * @access private
     */
-   /**
-    * The Smarty template engine instance
-    * @var object
-    */
+    /**
+     * The Smarty template engine instance
+     * @var object
+     */
     var $_tpl = null;
 
-   /**
-    * Current element index
-    * @var integer
-    */
+    /**
+     * Current element index
+     * @var integer
+     */
     var $_elementIdx = 0;
 
     /**
-    * The current element index inside a group
-    * @var integer
-    */
+     * The current element index inside a group
+     * @var integer
+     */
     var $_groupElementIdx = 0;
 
-   /**
-    * How to handle the required tag for required fields
-    * @var string
-    * @see      setRequiredTemplate()
-    */
+    /**
+     * How to handle the required tag for required fields
+     * @var string
+     * @see      setRequiredTemplate()
+     */
     var $_required = '';
 
-   /**
-    * How to handle error messages in form validation
-    * @var string
-    * @see      setErrorTemplate()
-    */
+    /**
+     * How to handle error messages in form validation
+     * @var string
+     * @see      setErrorTemplate()
+     */
     var $_error = '';
-   /**#@-*/
+    /**#@-*/
 
-   /**
-    * Constructor
-    *
-    * @param  Smarty  reference to the Smarty template engine instance
-    * @param  bool    true: render an array of labels to many labels, $key 0 to 'label' and the oterh to "label_$key"
-    * @param  bool    true: collect all hidden elements into string; false: process them as usual form elements
-    * @access public
-    */
+    /**
+     * Constructor
+     *
+     * @param  Smarty  reference to the Smarty template engine instance
+     * @param  bool    true: render an array of labels to many labels, $key 0 to 'label' and the oterh to "label_$key"
+     * @param  bool    true: collect all hidden elements into string; false: process them as usual form elements
+     * @access public
+     */
     function HTML_QuickForm_Renderer_ArraySmarty(&$tpl, $staticLabels = false, $collectHidden = true)
     {
         $this->HTML_QuickForm_Renderer_Array($collectHidden, $staticLabels);
         $this->_tpl =& $tpl;
     } // end constructor
 
-   /**
-    * Called when visiting a header element
-    *
-    * @param    HTML_QuickForm_header   header element being visited
-    * @access   public
-    * @return   void
-    */
+    /**
+     * Called when visiting a header element
+     *
+     * @param    HTML_QuickForm_header   header element being visited
+     * @access   public
+     * @return   void
+     */
     function renderHeader(&$header)
     {
         if ($name = $header->getName()) {
@@ -154,31 +154,31 @@ 
         $this->_currentSection = $this->_sectionCount++;
     } // end func renderHeader
 
-   /**
-    * Called when visiting a group, before processing any group elements
-    *
-    * @param    HTML_QuickForm_group    group being visited
-    * @param    bool                    Whether a group is required
-    * @param    string                  An error message associated with a group
-    * @access   public
-    * @return   void
-    */
+    /**
+     * Called when visiting a group, before processing any group elements
+     *
+     * @param    HTML_QuickForm_group    group being visited
+     * @param    bool                    Whether a group is required
+     * @param    string                  An error message associated with a group
+     * @access   public
+     * @return   void
+     */
     function startGroup(&$group, $required, $error)
     {
         parent::startGroup($group, $required, $error);
         $this->_groupElementIdx = 1;
     } // end func startGroup
 
-   /**
-    * Creates an array representing an element containing
-    * the key for storing this
-    *
-    * @access private
-    * @param  HTML_QuickForm_element    form element being visited
-    * @param  bool                      Whether an element is required
-    * @param  string                    Error associated with the element
-    * @return array
-    */
+    /**
+     * Creates an array representing an element containing
+     * the key for storing this
+     *
+     * @access private
+     * @param  HTML_QuickForm_element    form element being visited
+     * @param  bool                      Whether an element is required
+     * @param  string                    Error associated with the element
+     * @return array
+     */
     function _elementToArray(&$element, $required, $error)
     {
         $ret = parent::_elementToArray($element, $required, $error);
@@ -242,13 +242,13 @@ 
         return $ret;
     } // end func _elementToArray
 
-   /**
-    * Stores an array representation of an element in the form array
-    *
-    * @access private
-    * @param array  Array representation of an element
-    * @return void
-    */
+    /**
+     * Stores an array representation of an element in the form array
+     *
+     * @access private
+     * @param array  Array representation of an element
+     * @return void
+     */
     function _storeArray($elAry)
     {
         if ($elAry) {
@@ -265,20 +265,20 @@ 
         return;
     }
 
-   /**
-    * Called when an element is required
-    *
-    * This method will add the required tag to the element label and/or the element html
-    * such as defined with the method setRequiredTemplate.
-    *
-    * @param    string      The element label
-    * @param    string      The element html rendering
-    * @param    boolean     The element required
-    * @param    string      The element error
-    * @see      setRequiredTemplate()
-    * @access   private
-    * @return   void
-    */
+    /**
+     * Called when an element is required
+     *
+     * This method will add the required tag to the element label and/or the element html
+     * such as defined with the method setRequiredTemplate.
+     *
+     * @param    string      The element label
+     * @param    string      The element html rendering
+     * @param    boolean     The element required
+     * @param    string      The element error
+     * @see      setRequiredTemplate()
+     * @access   private
+     * @return   void
+     */
     function _renderRequired(&$label, &$html, &$required, &$error)
     {
         $this->_tpl->assign(array(
@@ -296,20 +296,20 @@ 
         $this->_tpl->clear_assign(array('label', 'html', 'required'));
     } // end func _renderRequired
 
-   /**
-    * Called when an element has a validation error
-    *
-    * This method will add the error message to the element label or the element html
-    * such as defined with the method setErrorTemplate. If the error placeholder is not found
-    * in the template, the error will be displayed in the form error block.
-    *
-    * @param    string      The element label
-    * @param    string      The element html rendering
-    * @param    string      The element error
-    * @see      setErrorTemplate()
-    * @access   private
-    * @return   void
-    */
+    /**
+     * Called when an element has a validation error
+     *
+     * This method will add the error message to the element label or the element html
+     * such as defined with the method setErrorTemplate. If the error placeholder is not found
+     * in the template, the error will be displayed in the form error block.
+     *
+     * @param    string      The element label
+     * @param    string      The element html rendering
+     * @param    string      The element error
+     * @see      setErrorTemplate()
+     * @access   private
+     * @return   void
+     */
     function _renderError(&$label, &$html, &$error)
     {
         $this->_tpl->assign(array('label' => '', 'html' => '', 'error' => $error));
@@ -324,16 +324,16 @@ 
         $this->_tpl->clear_assign(array('label', 'html', 'error'));
     } // end func _renderError
 
-   /**
-    * Process an template sourced in a string with Smarty
-    *
-    * Smarty has no core function to render	a template given as a string.
-    * So we use the smarty eval plugin function	to do this.
-    *
-    * @param    string      The template source
-    * @access   private
-    * @return   void
-    */
+    /**
+     * Process an template sourced in a string with Smarty
+     *
+     * Smarty has no core function to render	a template given as a string.
+     * So we use the smarty eval plugin function	to do this.
+     *
+     * @param    string      The template source
+     * @access   private
+     * @return   void
+     */
     function _tplFetch($tplSource)
     {
         if (!function_exists('smarty_function_eval')) {
@@ -342,54 +342,54 @@ 
         return smarty_function_eval(array('var' => $tplSource), $this->_tpl);
     }// end func _tplFetch
 
-   /**
-    * Sets the way required elements are rendered
-    *
-    * You can use {$label} or {$html} placeholders to let the renderer know where
-    * where the element label or the element html are positionned according to the
-    * required tag. They will be replaced accordingly with the right value.	You
-    * can use the full smarty syntax here, especially a custom modifier for I18N.
-    * For example:
-    * {if $required}<span style="color: red;">*</span>{/if}{$label|translate}
-    * will put a red star in front of the label if the element is required and
-    * translate the label.
-    *
-    *
-    * @param    string      The required element template
-    * @access   public
-    * @return   void
-    */
+    /**
+     * Sets the way required elements are rendered
+     *
+     * You can use {$label} or {$html} placeholders to let the renderer know where
+     * where the element label or the element html are positionned according to the
+     * required tag. They will be replaced accordingly with the right value.	You
+     * can use the full smarty syntax here, especially a custom modifier for I18N.
+     * For example:
+     * {if $required}<span style="color: red;">*</span>{/if}{$label|translate}
+     * will put a red star in front of the label if the element is required and
+     * translate the label.
+     *
+     *
+     * @param    string      The required element template
+     * @access   public
+     * @return   void
+     */
     function setRequiredTemplate($template)
     {
         $this->_required = $template;
     } // end func setRequiredTemplate
 
-   /**
-    * Sets the way elements with validation errors are rendered
-    *
-    * You can use {$label} or {$html} placeholders to let the renderer know where
-    * where the element label or the element html are positionned according to the
-    * error message. They will be replaced accordingly with the right value.
-    * The error message will replace the {$error} placeholder.
-    * For example:
-    * {if $error}<span style="color: red;">{$error}</span>{/if}<br />{$html}
-    * will put the error message in red on top of the element html.
-    *
-    * If you want all error messages to be output in the main error block, use
-    * the {$form.errors} part of the rendered array that collects all raw error
-    * messages.
-    *
-    * If you want to place all error messages manually, do not specify {$html}
-    * nor {$label}.
-    *
-    * Groups can have special layouts. With this kind of groups, you have to
-    * place the formated error message manually. In this case, use {$form.group.error}
-    * where you want the formated error message to appear in the form.
-    *
-    * @param    string      The element error template
-    * @access   public
-    * @return   void
-    */
+    /**
+     * Sets the way elements with validation errors are rendered
+     *
+     * You can use {$label} or {$html} placeholders to let the renderer know where
+     * where the element label or the element html are positionned according to the
+     * error message. They will be replaced accordingly with the right value.
+     * The error message will replace the {$error} placeholder.
+     * For example:
+     * {if $error}<span style="color: red;">{$error}</span>{/if}<br />{$html}
+     * will put the error message in red on top of the element html.
+     *
+     * If you want all error messages to be output in the main error block, use
+     * the {$form.errors} part of the rendered array that collects all raw error
+     * messages.
+     *
+     * If you want to place all error messages manually, do not specify {$html}
+     * nor {$label}.
+     *
+     * Groups can have special layouts. With this kind of groups, you have to
+     * place the formated error message manually. In this case, use {$form.group.error}
+     * where you want the formated error message to appear in the form.
+     *
+     * @param    string      The element error template
+     * @access   public
+     * @return   void
+     */
     function setErrorTemplate($template)
     {
         $this->_error = $template;

Spacing +16 added lines, -16 removed lines

@@ -134,7 +134,7 @@ 
     function HTML_QuickForm_Renderer_ArraySmarty(&$tpl, $staticLabels = false, $collectHidden = true)
     {
         $this->HTML_QuickForm_Renderer_Array($collectHidden, $staticLabels);
-        $this->_tpl =& $tpl;
+        $this->_tpl = & $tpl;
     } // end constructor
 
    /**
@@ -188,7 +188,7 @@ 
             // we don't need the elements, see the array structure
             unset($ret['elements']);
         }
-        if (($required || $error) && !empty($this->_required)){
+        if (($required || $error) && !empty($this->_required)) {
             $this->_renderRequired($ret['label'], $ret['html'], $required, $error);
         }
         if ($error && !empty($this->_error)) {
@@ -206,13 +206,13 @@ 
             if (isset($matches[1])) {
                 $sKeysSub = substr_replace($ret['name'], '', 0, strlen($matches[1]));
                 $sKeysSub = str_replace(
-                    array('\\',   '\'',   '['  ,   ']', '[\'\']'),
-                    array('\\\\', '\\\'', '[\'', '\']', '[]'    ),
+                    array('\\', '\'', '[', ']', '[\'\']'),
+                    array('\\\\', '\\\'', '[\'', '\']', '[]'),
                     $sKeysSub
                 );
-                $sKeys = '[\'' . str_replace(array('\\', '\''), array('\\\\', '\\\''), $matches[1]) . '\']' . $sKeysSub;
+                $sKeys = '[\''.str_replace(array('\\', '\''), array('\\\\', '\\\''), $matches[1]).'\']'.$sKeysSub;
             } else {
-                $sKeys = '[\'' . str_replace(array('\\', '\''), array('\\\\', '\\\''), $ret['name']) . '\']';
+                $sKeys = '[\''.str_replace(array('\\', '\''), array('\\\\', '\\\''), $ret['name']).'\']';
             }
             // special handling for elements in native groups
             if ($this->_currentGroup) {
@@ -228,14 +228,14 @@ 
             }
         // element without a name
         } elseif ($ret['name'] == '') {
-            $sKeys = '[\'element_' . $this->_elementIdx . '\']';
+            $sKeys = '[\'element_'.$this->_elementIdx.'\']';
         // other elements
         } else {
-            $sKeys = '[\'' . str_replace(array('\\', '\''), array('\\\\', '\\\''), $ret['name']) . '\']';
+            $sKeys = '[\''.str_replace(array('\\', '\''), array('\\\\', '\\\''), $ret['name']).'\']';
         }
         // for radios: add extra key from value
         if ('radio' == $ret['type'] and substr($sKeys, -2) != '[]') {
-            $sKeys .= '[\'' . str_replace(array('\\', '\''), array('\\\\', '\\\''), $ret['value']) . '\']';
+            $sKeys .= '[\''.str_replace(array('\\', '\''), array('\\\\', '\\\''), $ret['value']).'\']';
         }
         $this->_elementIdx++;
         $ret['keys'] = $sKeys;
@@ -256,9 +256,9 @@ 
             unset($elAry['keys']);
             // where should we put this element...
             if (is_array($this->_currentGroup) && ('group' != $elAry['type'])) {
-                $toEval = '$this->_currentGroup' . $sKeys . ' = $elAry;';
+                $toEval = '$this->_currentGroup'.$sKeys.' = $elAry;';
             } else {
-                $toEval = '$this->_ary' . $sKeys . ' = $elAry;';
+                $toEval = '$this->_ary'.$sKeys.' = $elAry;';
             }
             eval($toEval);
         }
@@ -287,10 +287,10 @@ 
             'required' => $required,
             'error'    => $error
         ));
-        if (!empty($label) && strpos($this->_required, $this->_tpl->left_delimiter . '$label') !== false) {
+        if (!empty($label) && strpos($this->_required, $this->_tpl->left_delimiter.'$label') !== false) {
             $label = $this->_tplFetch($this->_required);
         }
-        if (!empty($html) && strpos($this->_required, $this->_tpl->left_delimiter . '$html') !== false) {
+        if (!empty($html) && strpos($this->_required, $this->_tpl->left_delimiter.'$html') !== false) {
             $html = $this->_tplFetch($this->_required);
         }
         $this->_tpl->clear_assign(array('label', 'html', 'required'));
@@ -316,9 +316,9 @@ 
         $error = $this->_tplFetch($this->_error);
         $this->_tpl->assign(array('label' => $label, 'html'  => $html));
 
-        if (!empty($label) && strpos($this->_error, $this->_tpl->left_delimiter . '$label') !== false) {
+        if (!empty($label) && strpos($this->_error, $this->_tpl->left_delimiter.'$label') !== false) {
             $label = $this->_tplFetch($this->_error);
-        } elseif (!empty($html) && strpos($this->_error, $this->_tpl->left_delimiter . '$html') !== false) {
+        } elseif (!empty($html) && strpos($this->_error, $this->_tpl->left_delimiter.'$html') !== false) {
             $html = $this->_tplFetch($this->_error);
         }
         $this->_tpl->clear_assign(array('label', 'html', 'error'));
@@ -337,7 +337,7 @@ 
     function _tplFetch($tplSource)
     {
         if (!function_exists('smarty_function_eval')) {
-            require SMARTY_DIR . '/plugins/function.eval.php';
+            require SMARTY_DIR.'/plugins/function.eval.php';
         }
         return smarty_function_eval(array('var' => $tplSource), $this->_tpl);
     }// end func _tplFetch

main/inc/lib/pear/HTML/QuickForm/Renderer/Default.php

Doc Comments +5 added lines, -1 removed lines

@@ -40,7 +40,7 @@ 
     private $customElementTemplate;
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getCustomElementTemplate()
     {
@@ -457,6 +457,7 @@ 
      *
      * @param       string      The HTML surrounding an element
      * @param       string      (optional) Name of the element to apply template for
+     * @param string $html
      * @access      public
      * @return      void
      */
@@ -504,6 +505,7 @@ 
      * Sets header template
      *
      * @param       string      The HTML surrounding the header
+     * @param string $html
      * @access      public
      * @return      void
      */
@@ -516,6 +518,7 @@ 
      * Sets form template
      *
      * @param     string    The HTML surrounding the form tags
+     * @param string $html
      * @access    public
      * @return    void
      */
@@ -527,6 +530,7 @@ 
      * Sets the note indicating required fields template
      *
      * @param       string      The HTML surrounding the required note
+     * @param string $html
      * @access      public
      * @return      void
      */

Indentation +159 added lines, -159 removed lines

@@ -56,128 +56,128 @@ 
         $this->customElementTemplate = $customElementTemplate;
     }
 
-   /**
-    * The HTML of the form
-    * @var      string
-    * @access   private
-    */
+    /**
+     * The HTML of the form
+     * @var      string
+     * @access   private
+     */
     var $_html;
 
-   /**
-    * Header Template string
-    * @var      string
-    * @access   private
-    */
+    /**
+     * Header Template string
+     * @var      string
+     * @access   private
+     */
     var $_headerTemplate =
         "\n\t<tr>\n\t\t<td style=\"white-space: nowrap; background-color: #CCCCCC;\" align=\"left\" valign=\"top\" colspan=\"2\"><b>{header}</b></td>\n\t</tr>";
 
-   /**
-    * Element template string
-    * @var      string
-    * @access   private
-    */
+    /**
+     * Element template string
+     * @var      string
+     * @access   private
+     */
     var $_elementTemplate =
         "\n\t<tr>\n\t\t<td align=\"right\" valign=\"top\"><!-- BEGIN required --><span style=\"color: #ff0000\">*</span><!-- END required --><b>{label}</b></td>\n\t\t<td valign=\"top\" align=\"left\"><!-- BEGIN error --><span style=\"color: #ff0000\">{error}</span><br /><!-- END error -->\t{element}</td>\n\t</tr>";
 
-   /**
-    * Form template string
-    * @var      string
-    * @access   private
-    */
+    /**
+     * Form template string
+     * @var      string
+     * @access   private
+     */
     var $_formTemplate =
         "\n<form{attributes}>\n<div>\n{hidden}<table border=\"0\">\n{content}\n</table>\n</div>\n</form>";
 
-   /**
-    * Required Note template string
-    * @var      string
-    * @access   private
-    */
+    /**
+     * Required Note template string
+     * @var      string
+     * @access   private
+     */
     var $_requiredNoteTemplate =
         "\n\t<tr>\n\t\t<td></td>\n\t<td align=\"left\" valign=\"top\">{requiredNote}</td>\n\t</tr>";
 
-   /**
-    * Array containing the templates for customised elements
-    * @var      array
-    * @access   private
-    */
+    /**
+     * Array containing the templates for customised elements
+     * @var      array
+     * @access   private
+     */
     var $_templates = array();
 
-   /**
-    * Array containing the templates for group wraps.
-    *
-    * These templates are wrapped around group elements and groups' own
-    * templates wrap around them. This is set by setGroupTemplate().
-    *
-    * @var      array
-    * @access   private
-    */
+    /**
+     * Array containing the templates for group wraps.
+     *
+     * These templates are wrapped around group elements and groups' own
+     * templates wrap around them. This is set by setGroupTemplate().
+     *
+     * @var      array
+     * @access   private
+     */
     var $_groupWraps = array();
 
-   /**
-    * Array containing the templates for elements within groups
-    * @var      array
-    * @access   private
-    */
+    /**
+     * Array containing the templates for elements within groups
+     * @var      array
+     * @access   private
+     */
     var $_groupTemplates = array();
 
-   /**
-    * True if we are inside a group
-    * @var      bool
-    * @access   private
-    */
+    /**
+     * True if we are inside a group
+     * @var      bool
+     * @access   private
+     */
     var $_inGroup = false;
 
-   /**
-    * Array with HTML generated for group elements
-    * @var      array
-    * @access   private
-    */
+    /**
+     * Array with HTML generated for group elements
+     * @var      array
+     * @access   private
+     */
     var $_groupElements = array();
 
-   /**
-    * Template for an element inside a group
-    * @var      string
-    * @access   private
-    */
+    /**
+     * Template for an element inside a group
+     * @var      string
+     * @access   private
+     */
     var $_groupElementTemplate = '';
 
-   /**
-    * HTML that wraps around the group elements
-    * @var      string
-    * @access   private
-    */
+    /**
+     * HTML that wraps around the group elements
+     * @var      string
+     * @access   private
+     */
     var $_groupWrap = '';
 
-   /**
-    * HTML for the current group
-    * @var      string
-    * @access   private
-    */
+    /**
+     * HTML for the current group
+     * @var      string
+     * @access   private
+     */
     var $_groupTemplate = '';
 
-   /**
-    * Collected HTML of the hidden fields
-    * @var      string
-    * @access   private
-    */
+    /**
+     * Collected HTML of the hidden fields
+     * @var      string
+     * @access   private
+     */
     var $_hiddenHtml = '';
 
-   /**
-    * Constructor
-    *
-    * @access public
-    */
+    /**
+     * Constructor
+     *
+     * @access public
+     */
     public function HTML_QuickForm_Renderer_Default()
     {
         parent::__construct();
     } // end constructor
 
-   /**
-    * returns the HTML generated for the form
-    *
-    * @access public
-    * @return string
-    */
+    /**
+     * returns the HTML generated for the form
+     *
+     * @access public
+     * @return string
+     */
     public function toHtml()
     {
         // _hiddenHtml is cleared in finishForm(), so this only matters when
@@ -185,13 +185,13 @@ 
         return $this->_hiddenHtml . $this->_html;
     } // end func toHtml
 
-   /**
-    * Called when visiting a form, before processing any form elements
-    *
-    * @param    HTML_QuickForm  form object being visited
-    * @access   public
-    * @return   void
-    */
+    /**
+     * Called when visiting a form, before processing any form elements
+     *
+     * @param    HTML_QuickForm  form object being visited
+     * @access   public
+     * @return   void
+     */
     function startForm(&$form)
     {
         $this->setForm($form);
@@ -218,14 +218,14 @@ 
 
 
 
-   /**
-    * Called when visiting a form, after processing all form elements
-    * Adds required note, form attributes, validation javascript and form content.
-    *
-    * @param    HTML_QuickForm  form object being visited
-    * @access   public
-    * @return   void
-    */
+    /**
+     * Called when visiting a form, after processing all form elements
+     * Adds required note, form attributes, validation javascript and form content.
+     *
+     * @param    HTML_QuickForm  form object being visited
+     * @access   public
+     * @return   void
+     */
     public function finishForm(&$form)
     {
         // add a required note, if one is needed
@@ -248,13 +248,13 @@ 
         }
     } // end func finishForm
 
-   /**
-    * Called when visiting a header element
-    *
-    * @param    HTML_QuickForm_header   header element being visited
-    * @access   public
-    * @return   void
-    */
+    /**
+     * Called when visiting a header element
+     *
+     * @param    HTML_QuickForm_header   header element being visited
+     * @access   public
+     * @return   void
+     */
     function renderHeader(&$header)
     {
         $name = $header->getName();
@@ -265,17 +265,17 @@ 
         }
     } // end func renderHeader
 
-   /**
-    * Helper method for renderElement
-    *
-    * @param    HTML_QuickForm_element $element
-    * @param    bool        Whether an element is required
-    * @param    string      $required Error message associated with the element
-    * @param    string      $error Label for ID
-    * @access   private
-    * @see      renderElement()
-    * @return   string      Html for element
-    */
+    /**
+     * Helper method for renderElement
+     *
+     * @param    HTML_QuickForm_element $element
+     * @param    bool        Whether an element is required
+     * @param    string      $required Error message associated with the element
+     * @param    string      $error Label for ID
+     * @access   private
+     * @see      renderElement()
+     * @return   string      Html for element
+     */
     private function _prepareTemplate(HTML_QuickForm_element $element, $required, $error)
     {
         $name = $element->getName();
@@ -343,16 +343,16 @@ 
         return $html;
     } // end func _prepareTemplate
 
-   /**
-    * Renders an element Html
-    * Called when visiting an element
-    *
-    * @param HTML_QuickForm_element form element being visited
-    * @param bool                   Whether an element is required
-    * @param string                 An error message associated with an element
-    * @access public
-    * @return void
-    */
+    /**
+     * Renders an element Html
+     * Called when visiting an element
+     *
+     * @param HTML_QuickForm_element form element being visited
+     * @param bool                   Whether an element is required
+     * @param string                 An error message associated with an element
+     * @access public
+     * @return void
+     */
     public function renderElement(&$element, $required, $error)
     {
         if (!$this->_inGroup) {
@@ -379,40 +379,40 @@ 
         }
     } // end func renderElement
 
-   /**
-    * Renders an hidden element
-    * Called when visiting a hidden element
-    *
-    * @param HTML_QuickForm_element     form element being visited
-    * @access public
-    * @return void
-    */
+    /**
+     * Renders an hidden element
+     * Called when visiting a hidden element
+     *
+     * @param HTML_QuickForm_element     form element being visited
+     * @access public
+     * @return void
+     */
     function renderHidden(&$element)
     {
         $this->_hiddenHtml .= $element->toHtml() . "\n";
     } // end func renderHidden
 
-   /**
-    * Called when visiting a raw HTML/text pseudo-element
-    *
-    * @param  HTML_QuickForm_html   element being visited
-    * @access public
-    * @return void
-    */
+    /**
+     * Called when visiting a raw HTML/text pseudo-element
+     *
+     * @param  HTML_QuickForm_html   element being visited
+     * @access public
+     * @return void
+     */
     function renderHtml(&$data)
     {
         $this->_html .= $data->toHtml();
     } // end func renderHtml
 
-   /**
-    * Called when visiting a group, before processing any group elements
-    *
-    * @param HTML_QuickForm_group   group being visited
-    * @param bool       Whether a group is required
-    * @param string     An error message associated with a group
-    * @access public
-    * @return void
-    */
+    /**
+     * Called when visiting a group, before processing any group elements
+     *
+     * @param HTML_QuickForm_group   group being visited
+     * @param bool       Whether a group is required
+     * @param string     An error message associated with a group
+     * @access public
+     * @return void
+     */
     function startGroup(&$group, $required, $error)
     {
         $name = $group->getName();
@@ -423,13 +423,13 @@ 
         $this->_inGroup              = true;
     } // end func startGroup
 
-   /**
-    * Called when visiting a group, after processing all group elements
-    *
-    * @param    HTML_QuickForm_group    group being visited
-    * @access   public
-    * @return   void
-    */
+    /**
+     * Called when visiting a group, after processing all group elements
+     *
+     * @param    HTML_QuickForm_group    group being visited
+     * @access   public
+     * @return   void
+     */
     function finishGroup(&$group)
     {
         $separator = $group->_separator;

Spacing +9 added lines, -9 removed lines

@@ -182,7 +182,7 @@ 
     {
         // _hiddenHtml is cleared in finishForm(), so this only matters when
         // finishForm() was not called (e.g. group::toHtml(), bug #3511)
-        return $this->_hiddenHtml . $this->_html;
+        return $this->_hiddenHtml.$this->_html;
     } // end func toHtml
 
    /**
@@ -244,7 +244,7 @@ 
         $this->_html = str_replace('{content}', $this->_html, $html);
         // add a validation script
         if ('' != ($script = $form->getValidationScript())) {
-            $this->_html = $script . "\n" . $this->_html;
+            $this->_html = $script."\n".$this->_html;
         }
     } // end func finishForm
 
@@ -289,7 +289,7 @@ 
             $nameLabel = $label;
         }
 
-        $labelFor = !empty($labelForId) ? 'for="' . $labelForId . '"' : 'for="' . $element->getName() . '"';
+        $labelFor = !empty($labelForId) ? 'for="'.$labelForId.'"' : 'for="'.$element->getName().'"';
 
         if (isset($this->_templates[$name])) {
             // Custom template
@@ -330,7 +330,7 @@ 
         }
         if (is_array($label)) {
             foreach ($label as $key => $text) {
-                $key  = is_int($key)? $key + 2: $key;
+                $key  = is_int($key) ? $key + 2 : $key;
                 $html = str_replace("{label_{$key}}", $text, $html);
                 $html = str_replace("<!-- BEGIN label_{$key} -->", '', $html);
                 $html = str_replace("<!-- END label_{$key} -->", '', $html);
@@ -389,7 +389,7 @@ 
     */
     function renderHidden(&$element)
     {
-        $this->_hiddenHtml .= $element->toHtml() . "\n";
+        $this->_hiddenHtml .= $element->toHtml()."\n";
     } // end func renderHidden
 
    /**
@@ -417,8 +417,8 @@ 
     {
         $name = $group->getName();
         $this->_groupTemplate        = $this->_prepareTemplate($group, $required, $error);
-        $this->_groupElementTemplate = empty($this->_groupTemplates[$name])? '': $this->_groupTemplates[$name];
-        $this->_groupWrap            = empty($this->_groupWraps[$name])? '': $this->_groupWraps[$name];
+        $this->_groupElementTemplate = empty($this->_groupTemplates[$name]) ? '' : $this->_groupTemplates[$name];
+        $this->_groupWrap            = empty($this->_groupWraps[$name]) ? '' : $this->_groupWraps[$name];
         $this->_groupElements        = array();
         $this->_inGroup              = true;
     } // end func startGroup
@@ -437,13 +437,13 @@ 
             $count = count($separator);
             $html  = '';
             for ($i = 0; $i < count($this->_groupElements); $i++) {
-                $html .= (0 == $i? '': $separator[($i - 1) % $count]) . $this->_groupElements[$i];
+                $html .= (0 == $i ? '' : $separator[($i - 1) % $count]).$this->_groupElements[$i];
             }
         } else {
             if (is_null($separator)) {
                 $separator = '&nbsp;';
             }
-            $html = implode((string)$separator, $this->_groupElements);
+            $html = implode((string) $separator, $this->_groupElements);
         }
         if (!empty($this->_groupWrap)) {
             $html = str_replace('{content}', $html, $this->_groupWrap);