C:/usr/local/lib/php/blueshoes-4.2/core/html/form/Bs_Form.class.phpandrej arnimplementation of an html form. holds (uses) instances of FormElement.this flowchart shows how records can be added/editedusing this form class. the delete mode works slightlydifferent (there is no validation).+---------------------------+| || +----------------+ | +--------------+| | | | | || | +----------------------+ || | | FORM | || | | | || | | <preview> <save> | || error +----------------------+ error| occured | | occured| | | | || +---- < validate > < validate > ---+| | || | || +--------------------+ || | PREVIEW | || | | || | <edit> <save> | || +--------------------+ || | | |+-----------+ | || |+--------------------+| DONE || || thank you |+--------------------+the hash 'bs_form' including the following hidden vars is submitted alongwith the form all the time:NAME VALUE DESCRIPTIONname the name of this form (see var $internalName)mode add|edit|delete|view (see var $mode)step 2 (see var $step)recordId 5541 (see var $recordId)viewCount int (see var $viewCount)startTimestamp unix timestamp (see var $startTimestamp)language de|en|fr... (see var $language)state form|preview|done (see var $state)user ''|guest|member|root|... (see var $user)avoid cheating and the use of templates:with most forms you can cheat in that you save the form on your harddisk,change hidden and default values, and submit it from your disk.you could check the http_referer to see if the request comes from yourserver, but this is a bad idea. you'd block out users with old/strangeclients that don't send the http_referer, ppl using anomyzers/firewalls,and then a cheater could send a modified http_referer anyway.now with form templates thing is that not all form fields may be used.how does the validater know which fields have been in the form, andthus which fields he has to validate? we could loop $HTTP_POST_VARSbecause every submitted field has a key in this array. but again,we get the *submitted* fields, and not those which someone has removedwith the save-to-disc cheat.so the only secure way is to send a cryptified list of fields as ahidden input. we'd need to crypt hidden values also, but let's notget paranoid at the moment.also the use of the preview mode might be a risk. when submitting thepreview page, the inputs are not checked again. good place to cheat...features:o) multilevel forms (yah! :)o) templates (for the form AND for containers)o) multilingualo) very strong on input validationo) can deal with hitting enter in text fieldso) offers some nice domapi form element implementationso) and some more ready-to-use out-of-the-box special fields.o) can deal with include-once and onLoad javascript stufffeatures to add: (wishlist)o) cache the form (html output) for each language. then spit this outinstead of generating the form on every (first) request. the cacheneeds to be updated if someone makes changes to form/elements. thiswill make the forms load alot faster on the first request, take someload from the cpu, and prolly give a headache to someone findinga bug cause there was a cached not-up-to-date form. especially ifthe form depends on realtime data. but for simple forms this mightbe neat.o) prolly lots of documentation.o) encryption of hidden inputs so they are not seen in plaintext.o) some sort of hash to make sure the unchangeable (hidden) valueshave not been tricked by the user. (saved the form to his harddisk,...). checking the http_referer doesn't do it, of course.o) if possible, detect if the user changed something at all (in editmode). this could be useful to not update the data on the server.an update often starts a chain of human work. and if nothing changedanyway this only confuses ppl. hrm. mysql only updates the fieldsthat you set to a different value anyway. but does it also not toucha timestamp if nothing changed? this would help... but doesn't helpif you're going to update a datetime field yourself.todo:o) problem with valueDefault in multi-level forms. after level 1 itis not used anymore. step is 2 then, crap. recode a bit. 2002/05/06 --andrejo) on the server side, only validate the real inputs, not the hiddenfields, this is a waste of time.o) write a nice tutorial. document all the features. ppl don't wantto read the phpdoc :( especially step-by-step examples are needed.note: after the <form> tag there is the tag <bs_after_formopen_tag/>before the </form> tag there is the tag <bs_before_formclose_tag/>feel free to replace them with anything you want. eg add in somehidden fields, some html text, whatever.dependencies: Bs_FormContainer, Bs_ObjPersisterForMySql, Bs_FormTemplateParser,Bs_Db (for the saveToDb option), Bs_Array, Bs_HtmlUtil, $APP,Bs_Url, Bs_TextUtil, Bs_LanguageHandlerForm Class4.0.$id$blueshoes.orgConstructor.getIncludeOnce()getOnLoadCode()(if the error table should automatically come with it if errors occured. default is FALSE.) (html code)with all its form fields.Returns html code to send to the browser which will display the web formsome html code.returns the form tag.some html code.and hidden/internal fields.returns the 'form head' which includes the <form> tag, [javascripts]some html code.returns the 'form foot' which includes the </form> tag and the used fields (hidden).it has 2 hidden fields, one for the fields used, one md5 to avoid cheating.you have to call this method after doing the $this->elementContainer->getElement()because otherwise the fields don't know yet if they will be used or not.does not move the pointer of $this->clearingHouse.returns an html string that will be sent to the client inside the form.$buttonsthe return value depends on the mode we're in.returns a html string with the buttons to use.$thistells if this form is a multilevel form.$levelif it's not a multilevel form then 1 is returned.a simple form can be seen as a 1-level form.returns the number of levels used in that form.$levelnote: also returns TRUE if it's not a multilevel form causethen it's the first level aswell.tells if we're in the first level of a multilevel form.$levelnote: also returns TRUE if it's not a multilevel form causethen it's the last level aswell.tells if we're in the last level of a multilevel form.$thistrue if it's a multipart form, false if not.a multipart form is one with at least one <input type=file> field.the form turns into a multipart form when one of these conditions is true:1) the user set $this->encType to 'multipart/form-data'2) the form has at least one file field which is in use.Tells whether this form is (or has to be treated as) a multipart form.$thisone of 'add', 'edit', 'delete', 'view'. the mode that is set, or '' if nothing is set.returns the form mode we're in.$hasJavascriptTRUE if the client has javascript, FALSE if not. @throw NULL if we don't knowtells whether the client browser has javascript support or not.(the name of the form field or element)one of 'element' (default), 'caption', 'text', 'error', 'help'.(used to return just some of the radio options.) (text or html)empty string '' if no such element.caution: moves the pointer of $this->clearingHouse.returns the element of one of the elements of this form.$thischanges $this->state, $this->step and $this->level if needed.sets $this->usedTime if needed.caution: moves the pointer of $this->clearingHouse.validates the inputs of all fields that were sent. fills $this->errors if needed.a string (may include html) that is set above of the html table. $param string $style default is 'default', nothing available yet.an html string.string an empty string if no errors occured.to display on the website.returns a basic html string (html table) filled with the error messages$thisif $fieldName is NULL it is considered a vector element. see $this->errors.adds an error to this form.NULL if no such fieldnot a fieldor not capable to tell.input was ok/accepted.does not move the pointer of $this->clearingHouse.tells if the user filled in the given field *somehow*. does not tell if theone of 'internal' (default), 'default', 'received', 'display'.a vector with exactly one element (key = 0) that holds the field value. this way of returning is needed to make a difference to 'dunno'.NULL if no such fieldnot a fieldor not capable to tell.does not move the pointer of $this->clearingHouse.returns the field value you want.caution: moves the pointer of $this->clearingHouse.sets the fields valueInternal and valueDisplay to the same value as valueDefault is.TRUE bs_exceptionalso calls setBsFormData() if needed.!!! does not modify $step any more. 2002/05/07 --andrejcaution: moves the pointer of $this->clearingHouse.Sets the received values to the form fields of this form.(hash where key=fieldname and value=value.)also sets $step to 1. call setBsFormData() yourself if you need it.caution: moves the pointer of $this->clearingHouse.Sets the loaded values to the form fields of this form.caution: moves the pointer of $this->clearingHouse.calls the post load triggers of the fields of this form.(see class description for details)TRUE on success, FALSE if there's a problem with the md5 stuff. (cheater)so if you want to use different values, have this method be called first,then change what you want.sets the appropriate bs_form vars.$clearingHousedefault is TRUE. if set to true it will only be done if $clearingHouse is not set yet.seeds the var $clearingHouse.$_includeOncegetIncludeOnce() (TRUE if the script was added, FALSE if it was already there.)it's a good practise to write them the same way all the time (relative/absolute)to avoid problems.adds a javascript source file to the include-once todo list.$_includeOnceaddIncludeOnce()(see above) (array or string, see param $how)param $how: can be 'array' (default) or 'string'.for 'array' you get a vector with all script url's (empty array if none).for 'string' you get an html string with the script tags to echoto your browser (empty string if none).returns the include-once script files.$_onLoadgetOnLoadCode()(javascript code)TRUE .javascript code that needs to be executed in the onLoad event of the page.$_onLoadaddOnLoadCode()(default is TRUE, see above.)of the page.if param $withCodeTags is TRUE then you'll get script tags wrapped around,everything is prepared to paste it into the html-document. example:<script type='text/javascript'><!--onload=function() {//javascript code is here}// --></script>returns the javascript code that needs to be executed in the onLoad event$_inHeaddocument head.adds some code into the _inHead array that can later be included in the$_inHeadreturns the code that should be added in the document head.$persisterIDspecial method for the persister. rtfm.set the form id for all elements.unpersist()default is TRUEtrue on success @throw bs_exception on error (db exception)persist the form settings (with the attached form elements by default).persist()the internally used form name. if not set, $this->persisterID is used. so set it before!default is TRUEtrue on success, false on failure @throw bs_exception on error (db exception)unpersist (load) the form settings (with the attached form elements by default).$saveToDb$dbTableName (bool FALSE if nothing had to be saved, bool TRUE on a successful update, int >=1 on a successful insert (=the new record id)) @throw bs_exception if something should have been saved but failed somewhere.if the db table doesn't exist yet, it will be created automatically.if it exists and problems occure while inserting, the table structurewill be updated.on an insert, $this->recordId will be set.saves the received form inputs according to the settings.$saveToDb$dbTableName$thisTRUE if it exists, FALSE if not @throw Bs_Exceptionvalues should get persisted.tells if the db table exists. i mean the db table where the submitted$this$saveToDb$dbTableNamedefault is NULL which means get it yourself. you may pass it here if you already have it as optimization.default is TRUE. if the table could have been created lately you better set it to FALSE.TRUE if it exists, FALSE if not @throw Bs_Exceptionvalues should get persisted.tells if the db table exists. i mean the db table where the submitted$this$thisdefault is NULL which means get it yourself. you may pass it here if you already have it as optimization.the output of $this->getSaveToDbArray().TRUE on success @throw Bs_Exceptioncreates the db table. i mean the db table where the submitted values should get persisted.createDbTable()updateDbTableStructure()moved here so it can be used from createDbTable() and updateDbTableStructure().returns an sql fragment that can be used in create/alter table queries.default is NULL which means get it yourself. you may pass it here if you already have it as optimization.the output of $this->getSaveToDbArray().default is FALSE. if set to true, no changes will be made.TRUE if we have made changes, FALSE if not @throw bs_exceptionchecks if the db table structure is up-to-date and updates what's needed. (hash, see above)the scructure looks like this:$hash['fieldName'] = array('valueInternal' =>'something','neededDataType' =>'varchar','neededIndex' =>FALSE,'availableDataType' =>'varchar','availableIndex' =>FALSE,'shouldModifyType' =>FALSE,'shouldAddIndex' =>FALSE,'shouldPersist' =>TRUE);so the key of the hash is the fieldname (as it should be in the db).valueInternal is what we got from the browser. mostly a string, buttake care, it might be an array (explodable fields,select fields with property 'multiple').it is a reference, so don't fuck with it.neededDataType is $dbDataType of the field, or if not set then it'swhat we made up for it. the the received value doesn'tfit into that, then we might have to use some imagination.neededIndex is TRUE if the field is set to mustBeUnique, FALSE otherwise.availableDataType is the field type that we currently have in the db.availableIndex is if there's currently an index set in the db.shouldModifyType is true if we should convert the field type. we neverdownsize anything. a few notes:char is always converted to varchar. varchar always usesthe max (255) as size. int is never downsized to tinyint, etc.shouldAddIndex as you can see, the var name is shouldADD not shouldMODIFY.we never 'downsize' here also. someone could have gone intothe db directly and set an index, so we will never remove one.all we do is add it if the field has become mutBeUniquesuddenly.shouldPersist tells us if we should persist the data we got this time.for example in edit mode we don't update some things.creates a hash with the information about which data to persist, and how.default is TRUE. if set to true, only the fields are returned that should be used/persisted on the serverside.one of 'valueInternal', 'valueDisplay' (default), 'valueReceived', 'valueDefault'(default is FALSE. would return a hash holding vectors where element 0 is the value and element 1 is the caption (in the current language).)(default is null. if not given then the lang setting of the form is used.)(if you want nice human-readable output for values, set this to true. eg checkboxes return 'yes/no' instead of 0/1 values.)(vector filled with integers, null means all steps.) (hash where key is the internally used field name, value the value or a hash (see param $withCaption). may be an empty array if nothing is available.)does not move the pointer of $this->clearingHouse.returns the desired values of the submitted fields (that we should use)._loadInterfaceLanguage()$_guiLangHashempty string '' if a key is not defined or a language can in no way be loaded.returns a text string.getInterfaceText()$_guiLangHash(what lang you want to load, if not specified then the lang of this form will be loaded.) (TRUE on success, FALSE on failure. also TRUE if already loaded.)desired language.it is possible that we need to load more than one language for a form,for example if the customer fills in the form in german, but the webmasterwants the results by email in english. at least with field captions that'sthe case, not sure here. but it could be possible, so we code it that way.if the lang is already loaded, it won't be done again.loads a language file to be able to communicate with the user in thewe have it wrapped here so we are in the scope of this call and thuscan use $this-> things.evaluate code in it's own scope and return what the eval'd code returns.NULLinstance of Bs_ObjPersisterForMySql to persist the settings.$thisreserved var for the persister. don't fuck with this.used for the saveToDb option.reference to the globally used db object.reference to the global pseudostatic Bs_Array.reference to the global pseudostatic Bs_HtmlUtil.reference to the global pseudostatic Bs_TextUtil.reference to the global settings array $APP.if not set, it's omitted.the form name, as in <form name=$name>.if not set or an empty string, we submit to the user-requested page.note: we don't submit to $_SERVER['PHP_SELF'] but use Bs_Url::getUrlJunk('8') instead. rtfm.where to submit the form to, as in <form action=$action>.one of get or post. if not set to 'get' exactly, post is used.what submit method to use, as in <form method=$method>.$thisone ofapplication/x-www-form-urlencoded => defaultmultipart/form-data => required for INPUT TYPE=FILEtext/plain => for mailto: onlyif not set, it's omitted. it is the recommended way not to add theenctype=$enctype to the form tag if it's the default.if there is an <input type=file> used in the form, this var isautomatically set to 'multipart/form-data' no matter what you setit to.what encryption type to use, as in <form enctype=$enctype>.you can name a real target, or use one of the html values '_top', '_parent','_self', '_blank'.if not set, it's omitted, which means send to the current target.to which target should the form be submitted to? as in <form target=$target>- string class- string id- string style- (*1) mixed title[]a string or an associative array cause it's language dependant.appears as a tool tip over input fields if they don't have a title specified.(*1) = i have removed this from the feature list. no support until further notice.check your html documentation for details.hash with style information. these keys can be used:the facts if the fields need to be filled out and if the input was ok. that's whatthis var is for.hash with the following keys:captionMustcaptionMustOkaycaptionMustWrongcaptionMaycaptionMayOkaycaptionMayWrongfieldMustfieldMustOkayfieldMustWrongfieldMayfieldMayOkayfieldMayWrongcaption: the caption for a field.field : the field itself.must : the field is a must field.may : the field is not a must field.: the form is displayed for the first time. (not okay nor wrong, just nothing)okay : the form has been submitted and the input (if any) was accepted.wrong : the form has been submitted and the input (if any) was not accepted.the values for your keys are the class names (not style definitions themself, actually).if a key is not set or empty, it is not used at all.you may want to display the input fields and their captions differently based on$accessKeyTagshas no special setting for it. then the first letter will be used.if set to true, access keys will be used for the fields even if the field$useAccessKeysuser? the key usually has an underscore in the caption. so $accessKeyTagswould be array('<u>', '</u>') but it can be anything you like.example:$accessKeyTags = array('<u>', '</u>');$caption = "Firstname";$accessKey = "r";=> "Fi<u>r</u>stname"if it's not set [correctly], and there are accessKey's set, array('<u>', '</u>')will be used.if a form field uses the accessKey setting, how should it be visible to thethe direction in which the text is written.one of ltr (left to right) <= defaultrtl (right to left)ie5+dir="rtl"the currently (2001/04/27) available events are:- onSubmit - onDblClick - onMouseOver - onKeyPress- onRest - onMouseDown - onMouseMove - onKeyDown- onClick - onMouseUp - onMouseOut - onKeyUpset the keys exactly like written above (case). otherwise we get in troublewhen merging more events into one, and there may be bugs.(javascript) events like onSubmit, ...usually the form gets submitted immediatly. this behavior may notbe desired. details can be found here:http://ppewww.ph.gla.ac.uk/~flavell/www/formquestion.htmlhttp://www.cs.tut.fi/~jkorpela/forms/enter.htmlhttp://www.google.com :)possible values:'ignore' => ignores the hit of enter. does not submit the form.'tab' => enter acts like the tab key. the cursor/focus jumps into/to the next field.'submit' => submits the form.'nothing' => ignores this option. sends nothing to the browser.this all works by adding javascript events to the code. you need to havethe js file included (see var $useJsFile). if you don't set anything, nojavascript will be set, nothing will be done.browsers act differently when one hits enter in an input field.1 => (default) internet explorer style with the properties 'disabled' and 'readonly'depending on the tag.2 => javascript; javascript prevents the user from making changes.3 => html; type=text will be sent as plain text, for radio/checkboxes images are sent...how disabled fields should be sent to the client. one of:'starLeft'one of 'none', 'starLeft', 'starRight'. (i hope 'star' is the right word for a '*'.)if nothing is set, 'starLeft' is used (so it's the default).how must fields should be 'highlighted' in the browser.$templatePathset to TRUE.to see how templates are named see the phpdoc of Bs_FormTemplateParser->loadTemplate().note: containers can now have their own templates.if we should use a template when an appropriate one is available. false unless$useTemplategetAbsolutePath() . '../templates/'will be used which kinda sucks. so you better set that...the absolute path to the template(s). if not given then_getButtonString()we change the form mode, we need to be able to define differentbuttons for each mode.you can - for example for a contact form where you need no editmode - define a "submit" button and use that one. and ignore thisvar. but if you want to use debedoo, you certainly want this option.data structure:one ofbuttons[mode][button] = caption //all languages use the same captionbuttons[mode][button][lang] = caption //language dependant$buttons = array('view' => array('edit' => array('en'=>'edit', 'de'=>'bearbeiten'),'delete' => array('en'=>'delete', 'de'=>'löschen'),'cancel' => array('en'=>'overview', 'de'=>'übersicht')),'edit' => array('save' => array('en'=>'save', 'de'=>'speichern'),'cancel' => array('en'=>'cancel', 'de'=>'abbrechen'),'next' => array('en'=>'next', 'de'=>'weiter'),'back' => array('en'=>'back', 'de'=>'zurück')),'add' => array('save' => array('en'=>'add', 'de'=>'hinzufügen'),'cancel' => array('en'=>'cancel', 'de'=>'abbrechen'),'next' => array('en'=>'next', 'de'=>'weiter'),'back' => array('en'=>'back', 'de'=>'zurück')),'delete' => array('save' => array('en'=>'delete', 'de'=>'löschen'),'cancel' => array('en'=>'cancel', 'de'=>'abbrechen')),'search' => array('go' => array('en'=>'search', 'de'=>'suchen')));what you can do is set the caption of the buttons. define your language.if a button caption is not defined at all, the button won't be used.example: $buttons['view']['cancel'] = null;special case:maybe you're happy with default captions (although i bet most clientswant different captions 5 minutes before going live).if so, you can set $buttons to string 'default'. in that case the $buttonsvar will be used like what you see in the definiton above.if you don't want this at all set it to FALSE or don't set it at all.we always need buttons to submit a form. because they change whenbecause of javascripts that depend on a name.the name of this form in the database. may be different than $this->name$dbTableNamesave the values of this form to the db or not?then you can give the db information here. it's a dsn as always:KEYS:'host''port''syntax''type''user''pass'be aware of the fact that this data has to be stored along with theform settings, and that isn't very secure. although it's set tobe cryptified. a stackdump could be dangerous.if the form has to be saved to another database/server/whatever$saveToDb$dbTableNameif not given, the currently used db (global db) will be used.the db where the data should be stored automatically.$saveToDb$dbNameis allowed, no underscore, no 'minus' (_-). it has to start with thestring 'form'.if not given, the var $internalName is used with the prefix 'form'.the table where the data should be stored autmatically. only a-z A-Z 0-9you may need to store data into the db that does not come from the user input.it may be computed from some user input, for example.the key is the field name, the value needs to be a vector with exactly 3 elements.element[0] tells the type ('text' (default) or 'code'),element[1] is the mode (one of 'add', 'edit', 'both', 'none'), andelement[2] is the value.for 'code' the value is treated as php code and thus evaluated (in $this->_evalWrap()).it is only done if the mode matches, of course. invalid mode is treated as 'none'.hash holding additional data that needs to be persisted in the db.should we send the submitted data in an autogenerated email to somewhere?$sendMailRawemail to address$sendMailRawemail cc address$sendMailRawemail bcc address$sendMailRawemail subjectshould we send the submitted data using a template by email to somewhere?$sendMailNice1email to address$sendMailNice1email cc address$sendMailNice1email bcc address$sendMailNice1email subject$sendMailNice1email template_loadInterfaceLanguage()getInterfaceText()note: this var is static, so all instances of Bs_Form share the same!we need to specify that in the constructor.language strings loaded from files.$thisconstruct. normally the form wouldn't know directly which elements(and fields) are attached to it. it only knows about$elementContainer, which knows its elements including othercontainers, which again only knows about its elements.with this clearing house we have a reference to every element object.this is something between a hack, an optimization and a neededsetBsFormData()getUsedFields()information about which fields have been sent to the client. so weonly work with these fields. gets set in setBsFormData().when the form has been submitted, there is a hidden field with the'php'old comment:i have used php (serialize()) before, until unserialize() just did not work onone windows machine in php406. so i had to switch.new comment 2002/04/08:have switched back to default = 'php' cause wddx is not installed on all systemsby default (linux). --andrejone of 'wddx' or 'php' (default).by default $APP['forms']['md5Key'] is used. and if that is not available or empty,this var will be initialized with the string: "Von der Wiege bis zur Bahre: Formulare"(which is the same as the default value of the $APP['forms']['md5Key'] var).the md5 key to use to make sure the user did not cheat when submitting the form.this is a pseudo container to make things easier.an instance of Bs_FormContainer to keep track of all form elements.$thiscached information if the client browser has javascript support.usually it's just a hash holding another hash, where the key of the firsthash is the fieldname, the key/value of the 2nd hash is the field captionand error message. it may have vector elements with just a string as text.example:$errors['0'] = "some error text";$errors['username'] = array('Username' => 'too short');$errors['password'] = array('Password' => 'may not be equal to username');if not set, no errors occured and everything is fine.holds the errors that occured during the validating of the form fields.$thisif not set then an unknown mode is choosen. you may get strangefrom output in that case (fields not seen/not editable). an unknownmode may be desired for a search or login form or so.the form mode we're in. one of 'add', 'edit', 'delete' and 'view'.isMultiLevel()isFirstLevel()isLastLevel()$_prevLevel$_nextLevelmulti-step form. (the name 'step' was already reserved, thereis already such a var for another thing. don't mix them.)imo a multi-level form can do more than a multi-step form, sothe name is even more accurate. multi-level means that we don'thave to follow step 1-2-3-4-5, it can be different.lemme give you an example:a client wants to order something in your shop.+----------------------------------------------------------------------+| LEVEL | COMMENT | USER INPUT (SELECT OPTION OR FILL IN) |+----------------------------------------------------------------------+| 1) choose products 5x redbull, 2x wodka red :) || | || -----------------------------------------------|| | || 2) how to get it a) pickup b) send by mail || \ | || 3) \ fill in address || \ | || -----------------------------------------------|| 4) payment a) credit card b) bill c) cash || | | | || 5) give card info give bill address | || or select that it's | || the same as delivery. | || \ | / || -----------------------------------------------|| 6) done THANK YOU FOR YOUR ORDER. || |+----------------------------------------------------------------------+comments (about the example):- if you choose a) pickup in level 2) you will directly go to 4).- if you go back in 4) you may go directly to 2) if you came fromthere.- in level 4) the c) cash option is only there if the client picksup the goods (in step 2) the option a) was selected).- in level 5) the option to select "same as delivery" is onlyavailable if the goods are sent by mail.note that the vars $viewCount, $startTimestamp, $usedTime and maybe othersdon't care about the level. they are here once for all levels together.note also that only containers can be assigned to levels. so put everythingof each level into a separate pseudocontainer. that makes our live mucheasier. we have to deal with girlfriends, that's enough trouble.this form class is multi-level capable. think about it like a$levelhrm.$levelhrm.1if the form is displayed for the first time, the step is 1. if theform has been submitted by the user incorrectly (data missing or so)we're in step 2 (no matter how many times the user submits the form).if it's a multilevel form and for example the form level 3 is displayedfor the first time, step is 1.the form step we're in. default is 1, can be 2.'form''form', 'preview', 'done'.i don't think this one is in use/coded yet.the form state we're in. default is 'form', one of1filled out correctly.this is not the same as step, and they should not be mixed or put together.counts the number of times the form was displayed to the client until it was$usedTimedatatype: not sure if that's an int or double for php, but when it comesfrom a submitted form it's a string.the timestamp when the form was sent to the browser for the first time.$startTimestamponce the form is 'done' this is set to the used time. (actual time - $startTimestamp)the language we use for that form.usually the form is here to edit data from a database. which record? this one.$accessRightssomething like 'guest', 'member', 'admin', ...i think that you prolly want to store a group name in here, rather than a user.if this var is not set or empty, everyone can do everything.the user/group (based on a session?) that is using the form.$userKEY DATA TYPE EXAMPLE DESCRIPTION'group' string 'admin' user or group, whatever. just a name to identify the ppl.'view' bool TRUE|FALSE if the user may view the form in view mode.'add' bool TRUE|FALSE if the user may view the form in add mode (and add records).'edit' bool TRUE|FALSE if the user may view the form in edit mode (and edit records).'delete' bool TRUE|FALSE if the user may view the form in delete mode (and delete records).'alter' bool TRUE|FALSE if the user may view the form in alter mode (and alter the structure).the vector holds hashes with these keys:FALSEit's a problem if it's not linked in the <head></head> for ns 4.x. :/now because of those browser problems we don't include the js filebefore the body tag anymore. that js call goes into the $_includeOncearray. some user code may have to be updated. sorry. 2002/04/29 --andrejuse the externally linked js file? (Bs_FormUtil.lib.js)$_onLoadaddIncludeOnce()getIncludeOnce()it's a good practise to write them the same way all the time (relative/absolute,upper/lowercase) to avoid problems.javascript source files that need to be included - but only once for that page.$_includeOnceaddOnLoadCode()getOnLoadCode()javascript code that needs to be executed in the onLoad event of the page.$_includeOnce$_onLoadaddIntoHead()getInHeadCode()stuff (html/javascript/...) to put into the document head.FALSE$useJsFilefield that was filled in incorrectly/left out (must field).the javascript function jumpToFirstError() is needed, it is locatedin the js file. see var $useJsFile.if we should insert the javascript trigger to jump into the firstarray('internalName' => array('mode'=>'lonely', 'metaType'=>'string', 'index'=>TRUE), 'name' => array('mode'=>'stream'), 'action' => array('mode'=>'stream'), 'method' => array('mode'=>'stream'), 'encType' => array('mode'=>'stream'), 'target' => array('mode'=>'stream'), 'styles' => array('mode'=>'stream'), 'advancedStyles' => array('mode'=>'stream'), 'useAccessKeys' => array('mode'=>'stream'), 'accessKeyTags' => array('mode'=>'stream'), 'direction' => array('mode'=>'stream'), 'events' => array('mode'=>'stream'), 'onEnter' => array('mode'=>'stream'), 'disabledMode' => array('mode'=>'stream'), 'mustFieldsVisualMode' => array('mode'=>'stream'), 'useTemplate' => array('mode'=>'stream'), 'templatePath' => array('mode'=>'stream'), 'buttons' => array('mode'=>'stream'), 'useJsFile' => array('mode'=>'stream'), 'jumpToFirstError' => array('mode'=>'stream'), 'saveToDb' => array('mode'=>'stream'), 'dbDsn' => array('mode'=>'stream', 'crypt'=>TRUE), 'dbName' => array('mode'=>'stream'), 'dbTableName' => array('mode'=>'stream'), 'additionalParams' => array('mode'=>'stream'), 'sendMailRaw' => array('mode'=>'stream'), 'mailRawTo' => array('mode'=>'stream'), 'mailRawCc' => array('mode'=>'stream'), 'mailRawBcc' => array('mode'=>'stream'), 'mailRawSubject' => array('mode'=>'stream'), 'sendMailNice1' => array('mode'=>'stream'), 'mailNice1To' => array('mode'=>'stream'), 'mailNice1Cc' => array('mode'=>'stream'), 'mailNice1Bcc' => array('mode'=>'stream'), 'mailNice1Subject' => array('mode'=>'stream'), 'mailNice1Template' => array('mode'=>'stream') )4.0.$x$isexisexceptiontostringtohtmlbs_objectbbsetoutputbbawakebbisawakebbxmsgbbxfunctionstartbbxfunctionendbbxechobbxvarbbxvardumpbbforcetracebbbufferstartbbbuffergetbbbufferendflushbbbufferendcleanbs_object_versionBs_ObjectBs_Object