c:/www/apache/doc2//form/form_element.incUlf WendelSuperclass of all form elements.$Id: form_element.inc,v 1.5 2000/12/12 01:37:33 uw Exp $Array describing the form elementerpreted as "GET".HTML name attribute of the form tag.Optional, JavaScript validation mode. If set to "strong" (case insensitive) each element gets checked when changed (onChange/onClick) and when the form gets submitted (onSubmit). All other values start JavaScript validation with "onSubmit".The form object uses this constructor to setup any form element.Derived constructurs are not called by the form object. If you needsome kind of setup in any of the derived form element classes overridesetup(). Setup() gets always called by form_element().Creates a new form element.form_element()The form objects expects one constructor form_element()to setup all form element object. So the constructorof every derived class gets never called. To to setupany object that's derived from form_element the derivedobject has to override this method. It's always calledby form_element.Kind of a constructor of a derived form element.Data used in form::add_element()form_errorYou should call this function if you're newto the form stuff or debugging complex forms.If there's a problem the function might "throw"several exceptions. The function will notstop work when it finds an error but continue.That means that you can't "catch" the exceptions.Make sure that exception::$AUTO_HANDLE_ERRORSis set to true so that every error messages will beprinted.Checks the data used to initialize the element.Returns the value of an element.Returns the type of this element.Returns true if the element is a button, otherwise falsesetValidator()Returns the name of the custom validation function.getValidator()form_errorSets the name of the custom validation function.Freeze the form element.Thaw out the objectAlias for unfreeze().unfreezegetfrozen()show()The value is only used with radio buttons. If the given value is equal to the value of the element when it was defined, the radio gets selected. HTML code of the element.Returns the HTML code of the element.get()show()The value is only used with radio buttons. If the given value is equal to the value of the element when it was defined, the radio gets selected. HTML code of the frozen element.Returns thr HTML code of the frozen element.getgetfrozen()show()The value is only used with radio buttons. If the given value is equal to the value of the element when it was defined, the radio gets selected.Print version of get().getvalidateLength()validateRegEx()doValidation()Error message if there is an errorReturns the result of the (serverside) validation.Optional value, if not specified $this->value gets used.Validate the length of the input value.validateLength()Optional value, if not specified $this->value gets used.Compare the element value with the specified RegExp.form_errorValidate this event?$val_eventsEighter a string with the name of one "event" or an array of "events". Known "events" are: all, length, valid, intro, js_onsubmit, js_onchange. "length" controls length_e, minlength and maxlength, "valid" controls valid_e and valid_regexp and "intro" controls "intro", "intro_e". "js_onsubmit" and "js_onchange" referr to the JavaScript event handler.Optional, if set to true the specified "events" will be validated, otherwise validation is turned off (default: true = on) Returns false if no valid events where found.form_errorYou can tell every (default) validator which "events"will be validated. This gives you detailed controlon a default validator in you dependencie validators."Event" stands for some properties of an element (length, valid, intro)as well as the used JavaScript event handler (js_onsubmit,js_onchange) for the element.Using react() you can for example switch off the validationof the RegExp (valid_e, valid_regexp) writing:$formelement->react("valid", false);Defines the events that will be validated.Sets the value of the form element.Return a JavaScript onChange attribute if strong Javascript validation is activeReturns a HTML string with the html attributes shared by all element.get()value of the hidden field. If left out $this->value get used.HTML hidden fieldReturns the element as a HTML hidden field.get()"border = 1" to the table?value of the hidden field. If left out $this->value get used.HTML tableReturns the elements as a HTML table.JS for form_js_complex.js?See form_js_simple.js and form_js_complex.js for details on the JavaScriptvalidation code. This function build a record to "feed" the JavaScript formobject.Returns JavaScript validation code. [JavaScript function code, JavaScript function name]Most elements can use document.forms[..].elements[...].value to get thevalue of an element but some need a more sophisticated function. Theseelements must override this function.The JavaScript function provided by this elements should be names "form_elmenttype",e.g. "form_select". The (JS) function gets called with two arguments:string formname, string elementname. It returns the value of the element, seeform_element_select for an example.The function returns the JavaScript code itself and a name for the codesnippet that allows the form object to avoid sending the code twice.JavaScript function used to get the value of the element. [JavaScript code, JavaScript code snippet name]Some elements need extra JavaScript functionality to befull featured. Date for example is able to draw a "now" button. When theuser clicks this button, the date selectors change their values to thecurrent date. An additional JavaScript function "form_date_now" handles the clickon the button.The function returns the JavaScript code itself and a name for the codesnippet that allows the form object to avoid sending the code twice.Returns additional JavaScript required by some complex form elements.Returns the HTML/JavaScript name of the element.Is this a hidden element?truecheckConfiguration()""Every element can have two names. One "name" usedin the generated HTML and one "alias" "elname"."elname" was introduced to access a singleradio element in a group of radio elements.Each element of that group has the same "name" (HTML)an can have a unique (form wide) "alias" elname.Alias name of the element.""Make sure that the name of select multipleelements end with a pair of empty square brackets "[]".HTML name attribute of the element.""Value of the element.""The string will be added to the generated HTML without any validation.Additional HTML attributes.falseIs the element frozen?""HTML/CSS class attribute.""HTML/CSS id attribute.""HTML/CSS style attributearray ( "type" => "string", "name" => "string" )$required_fields$shared_optional_fieldscheckConfiguration()Have a look at checkConfiguration() for more informationon debugging form elements.List of required fields every element needs and their type.array()$shared_required_fields$optional_fieldsList of required fields provided by a derived class.array ( "value" => "mixed", "elname" => "string", "additional_html" => "string", "validator" => "string", "js_validator" => "string", "frozen" => "boolean", "class" => "string", "id" => "string", "style" => "string" )$optional_fields$shared_required_fieldscheckConfiguration()Have a look at checkConfiguration() for more informationon debugging form elements.List of optional fields and their type.array()$shared_optional_fields$required_fieldsList of optional fields provided by a derived class.""Method (POST|GET) used in the form.array( "length" => true, "valid" => true, "intro" => true )Check for ... errors."""weak" => onSubmit or "strong" => onChange/onClick.JavaScript validation mode.""Name of the form that contains the element.""The function is part of MyForm.Name of a custom validation function provided by the user.""Custom JavaScript validator.introspection$cr_html$exceptionsform_commonobjectform_commonobjectform_element_buttonobjectform_element_checkobjectform_element_selectobjectform_element_dateform_element_hiddenform_element_textobjectform_element_tree