chamilo / chamilo-lms

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');
@@ -192,11 +192,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);
     } // end func moveUploadedFile
 
     // }}}
@@ -255,23 +255,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/hidden.php

Doc Comments +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
      * Freeze the element so that only its value is returned
      *
      * @access    public
-     * @return    void
+     * @return    boolean
      */
     function freeze()
     {

Indentation +7 added lines, -7 removed lines

@@ -71,13 +71,13 @@
     // }}}
     // {{{ accept()
 
-   /**
-    * Accepts a renderer
-    *
-    * @param HTML_QuickForm_Renderer    renderer object
-    * @access public
-    * @return void
-    */
+    /**
+     * Accepts a renderer
+     *
+     * @param HTML_QuickForm_Renderer    renderer object
+     * @access public
+     * @return void
+     */
     //function accept(&$renderer)
     function accept(&$renderer, $required=false, $error=null)
     {

Spacing +1 added lines, -1 removed lines

@@ -79,7 +79,7 @@
     * @return void
     */
     //function accept(&$renderer)
-    function accept(&$renderer, $required=false, $error=null)
+    function accept(&$renderer, $required = false, $error = null)
     {
         $renderer->renderHidden($this);
     } // end func accept

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

Doc Comments +1 added lines, -1 removed lines

@@ -161,7 +161,7 @@
      * @param     object    &$caller calling object
      * @since     1.0
      * @access    public
-     * @return    void
+     * @return    boolean
      * @throws
      */
     function onQuickFormEvent($event, $arg, &$caller)

Indentation +3 added lines, -3 removed lines

@@ -183,9 +183,9 @@
         return true;
     }
 
-   /**
-    * We don't need values from button-type elements (except submit) and files
-    */
+    /**
+     * We don't need values from button-type elements (except submit) and files
+     */
     function exportValue(&$submitValues, $assoc = false)
     {
         $type = $this->getType();

Spacing +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
      * @access    public
      * @return    void
      */
-    public function __construct($elementName=null, $elementLabel=null, $attributes=null)
+    public function __construct($elementName = null, $elementLabel = null, $attributes = null)
     {
         parent::__construct($elementName, $elementLabel, $attributes);
     } //end constructor
@@ -146,7 +146,7 @@ 
         if ($this->_flagFrozen) {
             return $this->getFrozenHtml();
         } else {
-            return $this->_getTabs() . '<input' . $this->_getAttrString($this->_attributes) . ' />';
+            return $this->_getTabs().'<input'.$this->_getAttrString($this->_attributes).' />';
         }
     } //end func toHtml
 

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/Array.php

Doc Comments +3 added lines

@@ -211,6 +211,9 @@
     } // end func renderHeader
 
 
+    /**
+     * @param boolean $required
+     */
     function renderElement(&$element, $required, $error)
     {
         $elAry = $this->_elementToArray($element, $required, $error);

Indentation +68 added lines, -68 removed lines

@@ -109,60 +109,60 @@ 
  */
 class HTML_QuickForm_Renderer_Array extends HTML_QuickForm_Renderer
 {
-   /**#@+
+    /**#@+
     * @access private
     */
-   /**
-    * An array being generated
-    * @var array
-    */
+    /**
+     * An array being generated
+     * @var array
+     */
     var $_ary;
 
-   /**
-    * Number of sections in the form (i.e. number of headers in it)
-    * @var integer
-    */
+    /**
+     * Number of sections in the form (i.e. number of headers in it)
+     * @var integer
+     */
     var $_sectionCount;
 
-   /**
-    * Current section number
-    * @var integer
-    */
+    /**
+     * Current section number
+     * @var integer
+     */
     var $_currentSection;
 
-   /**
-    * Array representing current group
-    * @var array
-    */
+    /**
+     * Array representing current group
+     * @var array
+     */
     var $_currentGroup = null;
 
-   /**
-    * Additional style information for different elements
-    * @var array
-    */
+    /**
+     * Additional style information for different elements
+     * @var array
+     */
     var $_elementStyles = array();
 
-   /**
-    * true: collect all hidden elements into string; false: process them as usual form elements
-    * @var bool
-    */
+    /**
+     * true: collect all hidden elements into string; false: process them as usual form elements
+     * @var bool
+     */
     var $_collectHidden = false;
 
-   /**
-    * true:  render an array of labels to many labels, $key 0 named 'label', the rest "label_$key"
-    * false: leave labels as defined
-    * @var bool
-    */
+    /**
+     * true:  render an array of labels to many labels, $key 0 named 'label', the rest "label_$key"
+     * false: leave labels as defined
+     * @var bool
+     */
     var $_staticLabels = false;
-   /**#@-*/
+    /**#@-*/
 
-   /**
-    * Constructor
-    *
-    * @param  bool    true: collect all hidden elements into string; false: process them as usual form elements
-    * @param  bool    true: render an array of labels to many labels, $key 0 to 'label' and the oterh to "label_$key"
-    * @access public
-    */
+    /**
+     * Constructor
+     *
+     * @param  bool    true: collect all hidden elements into string; false: process them as usual form elements
+     * @param  bool    true: render an array of labels to many labels, $key 0 to 'label' and the oterh to "label_$key"
+     * @access public
+     */
     function HTML_QuickForm_Renderer_Array($collectHidden = false, $staticLabels = false)
     {
         $this->HTML_QuickForm_Renderer();
@@ -171,12 +171,12 @@ 
     } // end constructor
 
 
-   /**
-    * Returns the resultant array
-    *
-    * @access public
-    * @return array
-    */
+    /**
+     * Returns the resultant array
+     *
+     * @access public
+     * @return array
+     */
     function toArray()
     {
         return $this->_ary;
@@ -247,15 +247,15 @@ 
     } // end func finishGroup
 
 
-   /**
-    * Creates an array representing an element
-    *
-    * @access private
-    * @param  HTML_QuickForm_element    element being processed
-    * @param  bool                      Whether an element is required
-    * @param  string                    Error associated with the element
-    * @return array
-    */
+    /**
+     * Creates an array representing an element
+     *
+     * @access private
+     * @param  HTML_QuickForm_element    element being processed
+     * @param  bool                      Whether an element is required
+     * @param  string                    Error associated with the element
+     * @return array
+     */
     function _elementToArray(&$element, $required, $error)
     {
         $ret = array(
@@ -295,13 +295,13 @@ 
     }
 
 
-   /**
-    * 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)
     {
         // where should we put this element...
@@ -315,14 +315,14 @@ 
     }
 
 
-   /**
-    * Sets a style to use for element rendering
-    *
-    * @param mixed      element name or array ('element name' => 'style name')
-    * @param string     style name if $elementName is not an array
-    * @access public
-    * @return void
-    */
+    /**
+     * Sets a style to use for element rendering
+     *
+     * @param mixed      element name or array ('element name' => 'style name')
+     * @param string     style name if $elementName is not an array
+     * @access public
+     * @return void
+     */
     function setElementStyle($elementName, $styleName = null)
     {
         if (is_array($elementName)) {

Spacing +4 added lines, -4 removed lines

@@ -224,7 +224,7 @@ 
     function renderHidden(&$element)
     {
         if ($this->_collectHidden) {
-            $this->_ary['hidden'] .= $element->toHtml() . "\n";
+            $this->_ary['hidden'] .= $element->toHtml()."\n";
         } else {
             $this->renderElement($element, false, null);
         }
@@ -269,12 +269,12 @@ 
         // render label(s)
         $labels = $element->getLabel();
         if (is_array($labels) && $this->_staticLabels) {
-            foreach($labels as $key => $label) {
-                $key = is_int($key)? $key + 1: $key;
+            foreach ($labels as $key => $label) {
+                $key = is_int($key) ? $key + 1 : $key;
                 if (1 === $key) {
                     $ret['label'] = $label;
                 } else {
-                    $ret['label_' . $key] = $label;
+                    $ret['label_'.$key] = $label;
                 }
             }
         } else {

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
      */

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);

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 __construct()
     {
         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;

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

Doc Comments +1 added lines

@@ -480,6 +480,7 @@
     * the block contents on get() a bit differently
     *
     * @param    string  Block name
+    * @param string $block
     * @return   string  Block contents
     */
     function _getTplBlock($block)

Indentation +172 added lines, -172 removed lines

@@ -38,88 +38,88 @@ 
  */
 class HTML_QuickForm_Renderer_ITStatic extends HTML_QuickForm_Renderer
 {
-   /**#@+
+    /**#@+
     * @access private
     */
-   /**
-    * An HTML_Template_IT or some other API compatible Template instance
-    * @var object
-    */
+    /**
+     * An HTML_Template_IT or some other API compatible Template instance
+     * @var object
+     */
     var $_tpl = null;
 
-   /**
-    * Rendered form name
-    * @var string
-    */
+    /**
+     * Rendered form name
+     * @var string
+     */
     var $_formName = 'form';
 
-   /**
-    * The errors that were not shown near concrete fields go here
-    * @var array
-    */
+    /**
+     * The errors that were not shown near concrete fields go here
+     * @var array
+     */
     var $_errors = array();
 
-   /**
-    * Show the block with required note?
-    * @var bool
-    */
+    /**
+     * Show the block with required note?
+     * @var bool
+     */
     var $_showRequired = false;
 
-   /**
-    * Which group are we currently parsing ?
-    * @var string
-    */
+    /**
+     * Which group are we currently parsing ?
+     * @var string
+     */
     var $_inGroup;
 
-   /**
-    * Index of the element in its group
-    * @var int
-    */
+    /**
+     * Index of the element in its group
+     * @var int
+     */
     var $_elementIndex = 0;
 
-   /**
-    * If elements have been added with the same name
-    * @var array
-    */
+    /**
+     * If elements have been added with the same name
+     * @var array
+     */
     var $_duplicateElements = array();
 
-   /**
-    * How to handle the required tag for required fields
-    * @var string
-    */
+    /**
+     * How to handle the required tag for required fields
+     * @var string
+     */
     var $_required = '{label}<font size="1" color="red">*</font>';
 
-   /**
-    * How to handle error messages in form validation
-    * @var string
-    */
+    /**
+     * How to handle error messages in form validation
+     * @var string
+     */
     var $_error = '<font color="red">{error}</font><br />{html}';
 
-   /**
-    * Collected HTML for hidden elements, if needed
-    * @var string
-    */
+    /**
+     * Collected HTML for hidden elements, if needed
+     * @var string
+     */
     var $_hidden = '';
-   /**#@-*/
+    /**#@-*/
 
-   /**
-    * Constructor
-    *
-    * @param HTML_Template_IT|HTML_Template_Sigma   Template object to use
-    */
+    /**
+     * Constructor
+     *
+     * @param HTML_Template_IT|HTML_Template_Sigma   Template object to use
+     */
     function HTML_QuickForm_Renderer_ITStatic(&$tpl)
     {
         $this->HTML_QuickForm_Renderer();
         $this->_tpl =& $tpl;
     } // end constructor
 
-   /**
-    * 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->_formName = $form->getAttribute('id');
@@ -132,13 +132,13 @@ 
         }
     } // end func startForm
 
-   /**
-    * Called when visiting a form, after processing all form elements
-    *
-    * @param    HTML_QuickForm  form object being visited
-    * @access   public
-    * @return   void
-    */
+    /**
+     * Called when visiting a form, after processing all form elements
+     *
+     * @param    HTML_QuickForm  form object being visited
+     * @access   public
+     * @return   void
+     */
     function finishForm(&$form)
     {
         // display errors above form
@@ -162,13 +162,13 @@ 
         $this->_tpl->setVariable($this->_formName.'_javascript', $form->getValidationScript());
     } // 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();
@@ -181,15 +181,15 @@ 
         $this->_tpl->setVariable($varName, $header->toHtml());
     } // end func renderHeader
 
-   /**
-    * 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
-    */
+    /**
+     * 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
+     */
     function renderElement(&$element, $required, $error)
     {
         $name = $element->getName();
@@ -257,13 +257,13 @@ 
         }
     } // end func renderElement
 
-   /**
-    * Called when visiting a hidden element
-    *
-    * @param    HTML_QuickForm_element  hidden element being visited
-    * @access   public
-    * @return   void
-    */
+    /**
+     * Called when visiting a hidden element
+     *
+     * @param    HTML_QuickForm_element  hidden element being visited
+     * @access   public
+     * @return   void
+     */
     function renderHidden(&$element)
     {
         if ($this->_tpl->placeholderExists($this->_formName . '_hidden')) {
@@ -275,15 +275,15 @@ 
         }
     } // end func renderHidden
 
-   /**
-    * 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();
@@ -328,77 +328,77 @@ 
         $this->_inGroup = $varName;
     } // 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)
     {
         $this->_inGroup = '';
     } // end func finishGroup
 
-   /**
-    * 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.
-    * For example:
-    * <font color="red">*</font>{label}
-    * will put a red star in front of the label if the element is required.
-    *
-    * @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.
+     * For example:
+     * <font color="red">*</font>{label}
+     * will put a red star in front of the label if the element is required.
+     *
+     * @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} place holder.
-    * For example:
-    * <font color="red">{error}</font><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, do not specify
-    * {html} nor {label}.
-    *
-    * Groups can have special layouts. With this kind of groups, the renderer will need
-    * to know where to place the error message. In this case, use error blocks like:
-    * <!-- BEGIN form_group_error -->{form_group_error}<!-- END form_group_error -->
-    * where you want the 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} place holder.
+     * For example:
+     * <font color="red">{error}</font><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, do not specify
+     * {html} nor {label}.
+     *
+     * Groups can have special layouts. With this kind of groups, the renderer will need
+     * to know where to place the error message. In this case, use error blocks like:
+     * <!-- BEGIN form_group_error -->{form_group_error}<!-- END form_group_error -->
+     * where you want the error message to appear in the form.
+     *
+     * @param    string      The element error template
+     * @access   public
+     * @return   void
+     */
     function setErrorTemplate($template)
     {
         $this->_error = $template;
     } // end func setErrorTemplate
 
-   /**
-    * 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
-    * @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
+     * @see      setRequiredTemplate()
+     * @access   private
+     * @return   void
+     */
     function _renderRequired(&$label, &$html)
     {
         if ($this->_tpl->blockExists($tplBlock = $this->_formName . '_required_block')) {
@@ -428,20 +428,20 @@ 
         }
     } // 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)
     {
         if ($this->_tpl->blockExists($tplBlock = $this->_formName . '_error_block')) {
@@ -473,15 +473,15 @@ 
     }// end func _renderError
 
 
-   /**
-    * Returns the block's contents
-    *
-    * The method is needed because ITX and Sigma implement clearing
-    * the block contents on get() a bit differently
-    *
-    * @param    string  Block name
-    * @return   string  Block contents
-    */
+    /**
+     * Returns the block's contents
+     *
+     * The method is needed because ITX and Sigma implement clearing
+     * the block contents on get() a bit differently
+     *
+     * @param    string  Block name
+     * @return   string  Block contents
+     */
     function _getTplBlock($block)
     {
         $this->_tpl->parse($block);

Spacing +20 added lines, -20 removed lines

@@ -110,7 +110,7 @@ 
     function HTML_QuickForm_Renderer_ITStatic(&$tpl)
     {
         $this->HTML_QuickForm_Renderer();
-        $this->_tpl =& $tpl;
+        $this->_tpl = & $tpl;
     } // end constructor
 
    /**
@@ -154,7 +154,7 @@ 
         }
         // add hidden elements, if collected
         if (!empty($this->_hidden)) {
-            $this->_tpl->setVariable($this->_formName . '_hidden', $this->_hidden);
+            $this->_tpl->setVariable($this->_formName.'_hidden', $this->_hidden);
         }
         // assign form attributes
         $this->_tpl->setVariable($this->_formName.'_attributes', $form->getAttributes(true));
@@ -203,7 +203,7 @@ 
                 $this->_elementIndex++;
             }
             if ($varName != $this->_inGroup) {
-                $varName .= '_' == substr($varName, -1)? '': '_';
+                $varName .= '_' == substr($varName, -1) ? '' : '_';
                 // element name is of type : group[name]
                 $label = $element->getLabel();
                 $html = $element->toHtml();
@@ -266,7 +266,7 @@ 
     */
     function renderHidden(&$element)
     {
-        if ($this->_tpl->placeholderExists($this->_formName . '_hidden')) {
+        if ($this->_tpl->placeholderExists($this->_formName.'_hidden')) {
             $this->_hidden .= $element->toHtml();
         } else {
             $name = $element->getName();
@@ -307,14 +307,14 @@ 
             // <!-- BEGIN form_group_error -->{form_group_error}<!-- END form_group_error -->
             if (!empty($error)) {
                 if ($this->_tpl->placeholderExists($varName.'_error')) {
-                    if ($this->_tpl->blockExists($this->_formName . '_error_block')) {
-                        $this->_tpl->setVariable($this->_formName . '_error', $error);
-                        $error = $this->_getTplBlock($this->_formName . '_error_block');
+                    if ($this->_tpl->blockExists($this->_formName.'_error_block')) {
+                        $this->_tpl->setVariable($this->_formName.'_error', $error);
+                        $error = $this->_getTplBlock($this->_formName.'_error_block');
                     } elseif (strpos($this->_error, '{html}') !== false || strpos($this->_error, '{label}') !== false) {
                         $error = str_replace('{error}', $error, $this->_error);
                     }
                 }
-                $this->_tpl->setVariable($varName . '_error', $error);
+                $this->_tpl->setVariable($varName.'_error', $error);
                 array_pop($this->_errors);
             }
         }
@@ -401,17 +401,17 @@ 
     */
     function _renderRequired(&$label, &$html)
     {
-        if ($this->_tpl->blockExists($tplBlock = $this->_formName . '_required_block')) {
-            if (!empty($label) && $this->_tpl->placeholderExists($this->_formName . '_label', $tplBlock)) {
-                $this->_tpl->setVariable($this->_formName . '_label', is_array($label)? $label[0]: $label);
+        if ($this->_tpl->blockExists($tplBlock = $this->_formName.'_required_block')) {
+            if (!empty($label) && $this->_tpl->placeholderExists($this->_formName.'_label', $tplBlock)) {
+                $this->_tpl->setVariable($this->_formName.'_label', is_array($label) ? $label[0] : $label);
                 if (is_array($label)) {
                     $label[0] = $this->_getTplBlock($tplBlock);
                 } else {
                     $label    = $this->_getTplBlock($tplBlock);
                 }
             }
-            if (!empty($html) && $this->_tpl->placeholderExists($this->_formName . '_html', $tplBlock)) {
-                $this->_tpl->setVariable($this->_formName . '_html', $html);
+            if (!empty($html) && $this->_tpl->placeholderExists($this->_formName.'_html', $tplBlock)) {
+                $this->_tpl->setVariable($this->_formName.'_html', $html);
                 $html = $this->_getTplBlock($tplBlock);
             }
         } else {
@@ -444,21 +444,21 @@ 
     */
     function _renderError(&$label, &$html, $error)
     {
-        if ($this->_tpl->blockExists($tplBlock = $this->_formName . '_error_block')) {
-            $this->_tpl->setVariable($this->_formName . '_error', $error);
-            if (!empty($label) && $this->_tpl->placeholderExists($this->_formName . '_label', $tplBlock)) {
-                $this->_tpl->setVariable($this->_formName . '_label', is_array($label)? $label[0]: $label);
+        if ($this->_tpl->blockExists($tplBlock = $this->_formName.'_error_block')) {
+            $this->_tpl->setVariable($this->_formName.'_error', $error);
+            if (!empty($label) && $this->_tpl->placeholderExists($this->_formName.'_label', $tplBlock)) {
+                $this->_tpl->setVariable($this->_formName.'_label', is_array($label) ? $label[0] : $label);
                 if (is_array($label)) {
                     $label[0] = $this->_getTplBlock($tplBlock);
                 } else {
                     $label    = $this->_getTplBlock($tplBlock);
                 }
-            } elseif (!empty($html) && $this->_tpl->placeholderExists($this->_formName . '_html', $tplBlock)) {
-                $this->_tpl->setVariable($this->_formName . '_html', $html);
+            } elseif (!empty($html) && $this->_tpl->placeholderExists($this->_formName.'_html', $tplBlock)) {
+                $this->_tpl->setVariable($this->_formName.'_html', $html);
                 $html = $this->_getTplBlock($tplBlock);
             }
             // clean up after ourselves
-            $this->_tpl->setVariable($this->_formName . '_error', null);
+            $this->_tpl->setVariable($this->_formName.'_error', null);
         } elseif (!empty($label) && strpos($this->_error, '{label}') !== false) {
             if (is_array($label)) {
                 $label[0] = str_replace(array('{label}', '{error}'), array($label[0], $error), $this->_error);