Update the comment formatting to not use the pound bar anymore and to put a space...
[isso.git] / PrinterRootForm.php
index 8c0deb8416dc3f69f10e1884081ff1e34854db01..f5f42a55f320e119ee87bb5992e6f72196513fa9 100644 (file)
 \*=====================================================================*/
 
 /**
-* Printer Root Element: Form (PrinterRootForm.php)
-*
-* @package     ISSO
-*/
+ * Printer Root Element: Form (PrinterRootForm.php)
+ *
+ * @package    ISSO
+ */
 
 require_once(ISSO . '/PrinterRootAbstract.php');
 
 /**
-* Printer Root Element: Form
-*
-* Represents a <form> object. This can have a parent or not: if it does,
-* then it will be painted as a child, otherwise it will act as a root.
-*
-* @author              Blue Static
-* @copyright   Copyright (c)2005 - 2008, Blue Static
-* @package             ISSO
-*
-*/
+ * Printer Root Element: Form
+ *
+ * Represents a <form> object. This can have a parent or not: if it does,
+ * then it will be painted as a child, otherwise it will act as a root.
+ *
+ * @author             Blue Static
+ * @copyright  Copyright (c)2005 - 2008, Blue Static
+ * @package            ISSO
+ *
+ */
 class BSPrinterRootForm extends BSPrinterRootAbstract
 {
        /**
-       * The form's action
-       * @var string
-       */
+        * The form's action
+        * @var string
+        */
        private $action;
        
        /**
-       * "Do" parameter
-       * @var string
-       */
+        * "Do" parameter
+        * @var string
+        */
        private $do;
        
        /**
-       * The form's name
-       * @var string
-       */
+        * The form's name
+        * @var string
+        */
        private $name;
        
        /**
-       * This form is upload-ready
-       * @var bool
-       */
+        * This form is upload-ready
+        * @var bool
+        */
        private $upload;
        
-       // ###################################################################
        /**
-       * Constructor
-       */
+        * Constructor
+        */
        public function __construct($action, $do, $name = 'issoform')
        {
                $this->action = $action;
@@ -87,40 +86,37 @@ class BSPrinterRootForm extends BSPrinterRootAbstract
                return $obj->newInstanceArgs($args);
        }
        
-       // ###################################################################
        /**
-       * Should this form be used for upload?
-       *
-       * @param        bool    Upload?
-       * 
-       * @return       fluent interface
-       */
+        * Should this form be used for upload?
+        *
+        * @param       bool    Upload?
+        
+        * @return      fluent interface
+        */
        public function setUpload($upload)
        {
                $this->upload = $upload;
                return $this;
        }
        
-       // ###################################################################
        /**
-       * Adds a table row into the child list
-       *
-       * @param        BSPrinterAbstract       Table element
-       * 
-       * @return       fluent interface
-       */
+        * Adds a table row into the child list
+        *
+        * @param       BSPrinterAbstract       Table element
+        
+        * @return      fluent interface
+        */
        public function addChild(BSPrinterAbstract $tr)
        {
                $this->children[] = $tr;
                return $this;
        }
        
-       // ###################################################################
        /**
-       * Returns the HTML for all printed children elements
-       *
-       * @return       string  Printed HTML
-       */
+        * Returns the HTML for all printed children elements
+        *
+        * @return      string  Printed HTML
+        */
        protected function _paintChildren()
        {
                $builder = '';
@@ -133,12 +129,11 @@ class BSPrinterRootForm extends BSPrinterRootAbstract
                return $builder;
        }
        
-       // ###################################################################
        /**
-       * Paints the <table>
-       *
-       * @return       string  Table HTML code
-       */
+        * Paints the <table>
+        *
+        * @return      string  Table HTML code
+        */
        public function paint()
        {
                array_push($this->children, new BSPrinterElement('hidden', 'do', $this->do));