c:/www/apache/doc2//form/form.incUlf WendelThe form classes provide a way to generate and validate a HTMLform without the need to write a single line of HTML. Serverside and clientside(JavaScript1.2) validation is done automatically. This code is thesuccessor of the OOH Forms. See pages/form/ for examples.A form consists of an object of this class which controls lots of form elements.Form known all HTML form element types plus some compound types:- button- checkbox- combo (text + select box)- date (lots of select boxes)- file- hidden- image- password- radio- select box- submit- text- textarea- tree (select box with options show as a tree)Object oriented HTML form generation and validation.$Id: form.inc,v 1.14 2000/12/19 10:39:49 uw Exp $"weak" or "strong", if "strong" validation will be done onChange/onClick otherwise only onSubmit.Sets the JavaScript validation mode.autoloadValues()$method"POST" or "GET"Sets the method used by this form.of one element or array of elements. An empty string causes a fallback to all elements.Loads the form with HTTP_[POST|GET]_VARS.of values, $values[ name ] = valueform_errorSets the value of one element or a group of elements.ValidationOn()ValidationOff()Eigther the name of one element of an array of elements: $ellist [ name ] = events.The default of false turns off the validation, true turns it on.The new forms provide a way to validate depencencies between form elements.You may define a dependencie validation method for any element(attribute: validator). It gets called in the very first lines ofvalidate() and controls the default validators by turning them on/offfor certain elements using validation().Controls the default validation of an element.Validation()Name of one element or array of elements.Public handle to turn default validation off.Validation()Name of one element or array of elements.Public handle to turn default validation on.validationoffelement namename of validation functionform_errorSets the name of a custom validation function.form name. If empty no JavaScript validation will be done.method attribute: "POST" or "GET".action attribute. If empty $PHP_SELF gets used.target attribute.HTML form-TagGenerates the opening HTML form tag, <form>.form name. If empty no JavaScript validation will be done.method attribute: "POST" or "GET".action attribute. If empty $PHP_SELF gets used.target attribute.Generate and print <form>-TaggetstartOptional, additional HTML inserted in front of the generated HTML.Session ClassGenerates the closing HTML form tag and handles the hidden elements.Optional, additional HTML inserted in front of the generated HTML.Session ClassGenerate and print closing </form>-Tag.getfinishgetStart()getFinish()form name. If empty no JavaScript validation will be done.method attribute: "POST" or "GET".action attribute. If empty $PHP_SELF gets used.target attribute.HTML added right before the closing form-TagHTML form-TagGenerate the complete form.getStart()getFinish()form name. If empty no JavaScript validation will be done.method attribute: "POST" or "GET".action attribute. If empty $PHP_SELF gets used.target attribute.HTML added right before the closing form-TagGenerate and print the complete form.getform_errorAdds an element to the form object.namevalue, only used with radio - FIXMEHTML form_errorGenerate and return the html representation of an element.form_errorReturn the type of an element.element nameform_errorUse the function within your custom validation functions.Return the current value of an element.namevalue, only used with radio - FIXMEform_errorReturn and print an element.getelement ($error_msg, $error_flags)Validate a form.getValidationResult()validate()element nameform_errorSets the validation error message for of an element.setValidationError()validate() ($error_msg, $error_flags)Returns an array that holds the results of the last validation. $k => $custom_functionReturns an array of all custom validation functionsA user can't change the value of an frozen element.Freeze an element, frozen elements are drawn in an non editable way.freeze()of one element or list of elements to unfreeze. An empty string causes a fallback to all elements.Thaw out an element.name of the elementJavaScript codeform_errorFIXMEAdds JavaScript validation code to an element JavaScript validation codeform_errorReturns JavaScript validation code.getJS()code snippetcompressed codeWarning: do not use this function with user supplied code.The function replaces most tabs and spaces with an empty string beforeit starts to remove some newlines. The resulting code is usually15-25% shorter than the orginial code.Removes tabs, spaces and newlines from the given JavaScript code.freeze()of one element or list of elements to unfreeze. An empty string causes a fallback to all elements.Thaw out an element.unfreeze [ name ] = nameReturns an array of all elements.String with the name of one element or a list of elements.form_errorComboboxes expand their option list. Take care that you savethe expanded option list so that you can reload the newoption list after the form was submittet.FIXME getOptions()Return an array of all options of a combo list.name of the requested elementChecks the existance of a certain element.$defaults$default [ attribute ] = valueform_errorYou can use this function to define default values forelements.Sets default element attributes.Adds default values to an element if they haven't been overriden.FIXMEFIXMEReformate generated codeReturns an array with elname => value pairs, that can be usedto be stored in a session. new_assistant needs thisFIXME$element_prefixSets a global Prefix for element names.nameIs this checkboxobject checked?element nameReturns the latest combo entry of the usergetNewComboOption()SetOptions()getOptions()= ""Add a new option to a combo|array $ellistReturns the tree for a certain value of an treeview elementIt's just implementet to make the api completeFIXME FIXMEform_errorHelpful with dynamically changing treesSet the tree of an treeview elementName of the function that calls this methodName of a form elementform_error$js_error_prefix$js_error_postfixSets the JavaScript error message pre- and postfix text.array( # text element defaults "textsize" => 0, "textmaxlength" => 0, # file element defaults "filesize" => 0, # image element defaults "imageborder" => 0, # select objects "selectintro" => "", "selectintro_e" => "", # HTML CSS defaults "cssid" => "", "cssclass" => "", "cssstyle" => "" )setDefaults()Some default values.array()Array of all elements.array()List of all element names.""setElementnamePrefix()In multipage forms a global element name prefix can beused to avoid name clashes.Global element name prefix.array()validate()setValidationError()getValidationResult()$validation_msgResults of the last validation.""validate()setValidationError()getValidationResult()$validation_flagsString with all error messages.array()Hidden elements are treated different than in the old oohforms. Now you cangive a hidden element an html name (attribute name) and an alias name (elname)to access the element. That caused the introduction of some translationtables.Array of hidden elements.array()Array of radio elements.""If no name is given no JavaScript validation will be done.HTML name attribute of the opening form Tag."strong"Form knows two kinds of JavaScript validation: "strong" and "weak"."strong" means that validation will be performed onChange/onClick,"weak" stands for onSubmit.JavaScript validation mode"There're errors in the form: \n\n"$js_error_postfixsetJSError()Prefix displayed in front of the errors in a JavaScript alert box.JavaScript error message prefix."\n\nPlease correct the input."$js_error_prefixsetJSError()Postfix displayed right after the errors in a JavaScript alert box.JavaScript error message postfix."POST"Start()autoloadValues()Method used in the form.trueaddElement() will call form_elements_loader() if the flag is set to true.It's strongly recommended that you use the Form Loader unless you'reusing the Zend Cache or a similar product.Flag indication that you're using the Form Loader.falseFlag indicating that a file upload button is in the form.introspection$cr_html$exceptionsform_commonobjectform_commonobjectexample_form