/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/form/FormElement.inc

Diff of /nfo/php/libs/com.newsblob.phphtmllib/form/FormElement.inc

Parent Directory | Revision Log | View Patch Patch

-revision 1.1 by jonen,
Sat Feb 22 21:07:42 2003 UTC
+revision 1.3 by jonen,
Thu May  6 16:27:22 2004 UTC
 Line 23
   * get_value() - This gets the current
   *   'value' of the FormElement.
   *   NOTE: This can be a 'complex' FormElement
   *         in which it may return an array of
   *         values.
   *
   * set_value() - Set the current value
 Line 31
   *
   * get_label() - returns the label for this
   *   FormElement.
   *
   *
   * @package phpHtmlLib
   * @subpackage FormProcessing
 Line 58 
 class FormElement {
      var $_is_required = TRUE;
      /**
+      * holds the array of errors
+      * for this element.
+      */
+     var $_errors = array();
+     /**
       * Holds the error message text
       * for validation errors, if any
       *
-Line 98 
 class FormElement {
+Line 104 
 class FormElement {
       */
      var $_is_disabled = FALSE;
+     /**
+      * automatically strip slashes from
+      * form values?
+      */
+     var $_stripslashes = FALSE;
+     /**
+      * This holds the name of the form
+      * for js that needs it
+      */
+     var $_form_name;
+     /**
+      * This Form Element needs to
+      * propogate some js to the
+      * Form tag's onsubmit attribute
+      *
+      * @var string
+      */
+     var $_has_form_on_submit = false;
+     /**
+      * This holds an array of FormElement objects
+      * that are slaves of this element
+      */
+     var $_slave_elements;
+     /**
+      * The required field string
+      *
+      */
+     var $_required_field_marker = "*";
      /**
       * The constructor
-Line 117 
 class FormElement {
+Line 157 
 class FormElement {
          $this->set_value( $this->get_init_value() );
      }
+     /**
+      * This function will return the
+      * slaves of this element
+      *
+      * @return array of slave elements
+      */
+     function &get_slave_elements() {
+         return $this->_slave_elements;
+     }
+     /**
+      * This function will set the
+      * slaves of this element
+      *
+      * @param array of slave elements (element references &)
+      */
+     function set_slave_elements($slaveElements) {
+         $this->_slave_elements = $slaveElements;
+         $this->set_data_all_slaves( $this->get_value() );
+     }
+     /**
+      * This function will set the
+      * data the parent wants to set for the slave
+      *
+      * @param the slave
+      * @param the value being set for the parent
+      */
+     function set_slave_data(&$slave, $parentValue) {
+         ; //override to set the data for the slave
+     }
      /**
       * This function will return the
-Line 145 
 class FormElement {
+Line 217 
 class FormElement {
       * @return mixed
       */
      function get_value() {
-         return $this->_value;
+         if ($this->_stripslashes) {
+             return stripslashes($this->_value);
+         } else {
+             return $this->_value;
+         }
      }
      /**
       * This function will set the
       * initial value for the element
-Line 156 
 class FormElement {
+Line 233 
 class FormElement {
       */
      function set_value($value) {
          $this->_value = $value;
+         $this->set_data_all_slaves($value);
+     }
+     /**
+      * This function will call set_slave_data for all slaves
+      * should be called when value of parent changes
+      *
+      * @param string - the current value of parent
+      */
+     function set_data_all_slaves($parentValue){
+         $slaves = &$this->get_slave_elements();
+         $num_slaves = count($slaves);
+         if ($num_slaves) {
+             for($i=0; $i < $num_slaves; $i++){
+                 $this->set_slave_data($slaves[$i], $parentValue);
+             }
+         }
+     }
+     /**
+      * in case anyone in JS land
+      * needs the name of the form that
+      * this element lives in
+      *
+      * @param string - the form name
+      */
+     function set_form_name($name) {
+         $this->_form_name = $name;
      }
      /**
       * This provides a method
       * for the FormContent
       * to get access to the
       * text associated with a
       * field.  This is only available
       * on FormElements that have text
       * associated with a field.
       * It is used during Confirmation
       *
-      * @param mixed - the value to look up
+      * @param mixed the value to look up
       * @return string - the text associated
       */
-     function get_value_text($value) {
+     function get_value_text() {
          return $this->get_value();
      }
-Line 204 
 class FormElement {
+Line 310 
 class FormElement {
       * @return mixed
       */
      function get_init_value() {
-         return $_REQUEST[str_replace("[]","",$this->get_element_name())];
+         return @$_REQUEST[str_replace("[]","",$this->get_element_name())];
      }
-Line 227 
 class FormElement {
+Line 333 
 class FormElement {
          return $this->_is_disabled;
      }
+         /**
+          * This sets the stripslashes flag for
+          * this object.
+          *
+          * @param boolean
+          */
+         function set_stripslashes( $flag = TRUE ) {
+                 $this->_stripslashes = $flag;
+         }
      /********* Tag attributes methods *********/
-Line 277 
 class FormElement {
+Line 393 
 class FormElement {
          $this->_style_attributes[$name] = $value;
      }
+     /**
+      * Sets the element's tab index
+      *
+      * @param int the # for the tabindex
+      */
+     function set_tabindex($index) {
+         $this->set_attribute('tabindex', $index);
+     }
+     /**
+      * Gets the current tab index if any
+      *
+      * @return int returns 0 if there is none set.
+      */
+     function get_tabindex() {
+         if (isset($this->_attributes['tabindex'])) {
+             return $this->_attributes['tabindex'];
+         } else {
+             return 0;
+         }
+     }
      /********* Error handling methods *********/
-Line 285 
 class FormElement {
+Line 423 
 class FormElement {
       * sets the error flag to true
       *
       * @param mesage text - error message
-      */
+      * @param label text - a label to provide
-     function set_error_message($message) {
+      *                     for the error.  This is
-         $this->_error_message = $message;
+      *                     only needed for a complex
+      *                     element that has multiple
+      *                     'hidden/magic' fields.
+      */
+     function set_error_message($message, $label=NULL) {
+         if ($label == NULL) {
+             $label = $this->get_label_text();
+         }
+         $this->_errors[] = array("label" => $label,
+                                  "message" => $message);
          $this->_has_error = TRUE;
      }
+     /**
+      * This returns the array of errors
+      * for this element
+      *
+      * @param array of errors
+      */
+     function get_errors() {
+         return $this->_errors;
+     }
      /**
       * Returns the current error message
-Line 308 
 class FormElement {
+Line 465 
 class FormElement {
       *
       * @return bool error state
       */
-     function has_error() {
+     function has_error($label=NULL) {
-         return $this->_has_error;
+         if ($label==NULL) {
+             return $this->_has_error;
+         } else {
+             //they are looking for a specific error
+             foreach( $this->_errors as $error) {
+                 if ($error['label'] == $label) {
+                     return TRUE;
+                 }
+             }
+             return FALSE;
+         }
      }
-Line 331 
 class FormElement {
+Line 499 
 class FormElement {
                  $name[$i] = "_";
          }
+         $this->set_element_name($name);
+     }
+     /**
+      * This allows you to force the element
+      * name to whatever you like, so you
+      * don't have to use the default name, which is
+      * generated based on the label.
+      *
+      * @param string the form element's name
+      * @return none
+      */
+     function set_element_name($name) {
          $this->_element_name = $name;
      }
-Line 357 
 class FormElement {
+Line 538 
 class FormElement {
       * validation and setting the appropriate error message
       * in case of a failed validation
       *
+      * @param FormValidation object.
       */
-     function validate() {
+     function validate(&$_FormValidation) {
          return TRUE;
      }
-Line 367 
 class FormElement {
+Line 549 
 class FormElement {
       * This function checks if the validation
       * is nesseccary and calls the validate method
       *
+      * @param FormValidation object.
       */
-     function _do_validation() {
+     function _do_validation(&$_FormValidation) {
-         if ($this->get_value() != NULL) {
+         $value = $this->get_value();
-             return $this->validate();
+         $has_value = FALSE;
+         if (is_array($value)) {
+             foreach($value as $entry) {
+                 if ($entry != NULL) {
+                     $has_value = TRUE;
+                 }
+             }
+         } else {
+             if ($value != NULL) {
+                 $has_value = TRUE;
+             }
+         }
+         if ($has_value && !$this->is_disabled()) {
+             return $this->validate($_FormValidation);
          } else if ($this->is_required()) {
              $this->set_error_message("This field cannot be empty");
              return FALSE;
-Line 382 
 class FormElement {
+Line 579 
 class FormElement {
      /********* JavaScript event methods *********/
+     /**
+      * This method is used for adding any javascript
+      * that is used by this element.  This will automatically
+      * get called and added to the page by the FormProcessor
+      *
+      * @return string - raw js
+      */
+     function javascript() {
+         return NULL;
+     }
      /**
       * This function return the javaScript code for
       * an onClick event
-Line 444 
 class FormElement {
+Line 653 
 class FormElement {
          $javascript = array();
          if (($js=$this->onClick()) != NULL) {
-             $javascript[] = "onClick=\"" . $js . "\"";
+             $javascript[] = "onclick=\"" . $js . "\"";
          }
          if (($js=$this->onFocus()) != NULL) {
-             $javascript[] = "onFocus=\"" . $js . "\"";
+             $javascript[] = "onfocus=\"" . $js . "\"";
          }
          if (($js=$this->onSubmit()) != NULL) {
-             $javascript[] = "onSubmit=\"" . $js . "\"";
+             $javascript[] = "onsubmit=\"" . $js . "\"";
          }
          if (($js=$this->onBlur()) != NULL) {
-             $javascript[] = "onBlur=\"" . $js . "\"";
+             $javascript[] = "onblur=\"" . $js . "\"";
          }
          if (($js=$this->onChange()) != NULL) {
-             $javascript[] = "onChange=\"" . $js . "\"";
+             $javascript[] = "onchange=\"" . $js . "\"";
          }
          if (count($javascript)>0) {
-Line 472 
 class FormElement {
+Line 681 
 class FormElement {
      }
+     /**
+      * This is a method for getting the JS needed
+      * for the form tag's onsubmit attribute.
+      *
+      * @return string
+      */
+     function form_tag_onsubmit() {
+         return '';
+     }
      /********* rendering methods *********/
-Line 482 
 class FormElement {
+Line 702 
 class FormElement {
       * @return string - required symbol
       */
      function get_required_symbol() {
-         return '*';
+         return $this->_required_field_marker;
+     }
+     /**
+      * This allows you to customize the
+      * require string marker
+      *
+      * @param string
+      */
+     function set_required_symbol($symbol) {
+         $this->_required_field_marker;
      }
      /**
-Line 524 
 class FormElement {
+Line 754 
 class FormElement {
       * label object based on the label text
       * and error conditions
       *
+      * @param FormContent object that holds the
+      *        required field marker
       * @return object SPANtag
       */
-     function get_label() {
+     function get_label($form_content=NULL) {
          $label = $this->get_label_text();
+         $text = $label;
-         if ($this->is_required()) $label .= ' ' . $this->get_required_symbol();
+         if ($this->is_required()) {
+             $text .= ' ' .  ($form_content ? $form_content->_required_field_marker :
+                              $this->get_required_symbol());
+         }
-         $span = html_span("formlabel", $label);
+         $span = html_span("formlabel", $text);
          if ($this->has_error()) {
              $span->set_tag_attribute("style","color:red;");
-Line 555 
 class FormElement {
+Line 791 
 class FormElement {
          return $span;
      }
+     /**
+      * This method returns the hidden version of this
+      * element for a confirmation page.
+      *
+      * NOTE: This is called by the FormProcessor only.
+      * It shouldn't be called manually.
+      *
+      * @return INPUTtag of type hidden
+      */
+     function get_confirm_element() {
+         $values = $this->get_value();
+         $name = $this->get_element_name();
+         if (is_array($values)) {
+             $c = container();
+             foreach ( $values as $value ) {
+                 $c->add( form_hidden($name, $value ) );
+             }
+             return $c;
+         } else {
+             return form_hidden($name, $this->get_value() );
+         }
+     }
  } // FormElement
  ?>

 Legend:



Removed from v.1.1
 


changed lines


 
Added in v.1.3
 Legend:



Removed from v.1.1
 


changed lines


 
Added in v.1.3
-Removed from v.1.1
+Added in v.1.3

MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26