<?xml version="1.0"?><phpdoc><class name="Bs_FormContainer" extends="Bs_FormElement" undoc="false" access="public" package="Form"><file>C:/usr/local/lib/php/blueshoes-4.2/core/html/form/Bs_FormContainer.class.php</file><doc><author email="andrej@arn.li">andrej arn</author><inherited src="Array"/><overriden src="Array"/><description>dependencies: Bs_FormElement, Bs_Array, Bs_FormTemplateParser</description><shortdescription>Form Container Class</shortdescription><version>4.0.$id$</version><copyright>blueshoes.org</copyright></doc><function name="Bs_FormContainer" undoc="false" access="public"><doc><return type="void"/><description/><shortdescription>Constructor.</shortdescription></doc></function><function name="&amp;getElement" undoc="false" access="public"><doc><parameter name="$level" default="null" type="string">(if set then only container of that level (or undefined level) will be used.)</parameter><return name="" type="string"> (some html code.)</return><description>calls itself recursively.</description><shortdescription>Return some html code to display the element on a website in a form.</shortdescription></doc></function><function name="addElement" undoc="false" access="public"><doc><parameter name="&amp;$element" type="object [unknown]">an instance of a form element.</parameter><return name="" type="bool">true on success, false on failure.</return><description>it cannot be added to the clearing house here cause the container may notbe attached to the form yet.</description><shortdescription>add an instance of a form element object to this container.</shortdescription></doc></function><function name="orderElements" undoc="false" access="public"><doc><see type="var">$formElements</see><return type="void"/><description/><shortdescription>orders the elements based on the orderId var.</shortdescription></doc></function><function name="hasFileFieldElement" undoc="false" access="public"><doc><return name="" type="bool"/><description>called recursively.</description><shortdescription>tells if this container holds a file field element.</shortdescription></doc></function><function name="getLevel" undoc="true" access="public"><doc><return name="" type="int"/><throws>null</throws><overriden src="Bs_FormElement"/><description>throws null for unknown or not set.overwrites and uses parent method.</description><shortdescription>returns the level this container belongs to.</shortdescription></doc></function><function name="getSaveToDbArray" undoc="false" access="public"><doc><parameter name="$hash" default="array()" type="array">default is array(). used internally for the recursive loop.</parameter><return name="" type="array"/><description>calls itself recursively.</description><shortdescription>called by Bs_Form-&amp;gt;getSaveToDbArray(), look there for further information.</shortdescription></doc></function><function name="persist" undoc="true" access="private"><doc><see type="function">unpersist()</see><return name="" type="bool">true on success&#x0a;@throw bs_exception on error (db exception)</return><overriden src="Bs_Object"/><description/><shortdescription>persist the element settings.</shortdescription></doc></function><function name="getStartTag" undoc="true" access="private"><doc><return type="void"/></doc></function><function name="getEndTag" undoc="true" access="private"><doc><return type="void"/></doc></function><function name="seedClearingHousefuck" undoc="true" access="private"><doc><parameter name="$ret" type="array" undoc="true"/><parameter name="$firstCall" type="string" undoc="true"/><return type="void"/></doc></function><function name="seedClearingHouse" undoc="true" access="private"><doc><parameter name="$ret" type="array" undoc="true"/><parameter name="$root" type="string" undoc="true"/><parameter name="$firstCall" type="string" undoc="true"/><return type="void"/></doc></function><variable name="$_Bs_Array" access="private" type="object [unknown]"><doc><description/><shortdescription>reference to the global pseudostatic Bs_Array.</shortdescription></doc></variable><variable name="$formElements" access="private" type="array"><doc><description/><shortdescription>holding references to instances of Bs_FormElement.</shortdescription></doc></variable><variable name="$caption" access="private" type="mixed"><doc><description>usually a string, can be a hash because it&amp;apos;s language dependant.</description><shortdescription>the title for this group.</shortdescription></doc></variable><variable name="$useCheckboxAsCaption" access="private" type="string"><doc><description>the checkbox plus it&amp;apos;s caption is used instead, and the $text of the checkbox isprintes as text in the first paragraph of this container. nice feature. should bedocumented in a howto.</description><shortdescription>if set and *this container* has such a checkbox field, the var $caption is ignored,</shortdescription></doc></variable><variable name="$pseudoContainer" access="private" type="string">FALSE<doc><description/><shortdescription>should it be displayed as real container with caption and borders?</shortdescription></doc></variable><variable name="$level" access="public" type="int"><doc><description>multi-level form feature.all elements (including form fields and sub-containers) of thiscontainer automatically inherit the level information of thiscontainer. they cannot be in a different level.note   I: if not set then it will be used in all levels.note  II: the first level is level 1, not 0.note III: if you want to be able to assign a container to more than onelevel, code that feature, please. :)</description><shortdescription>a container can be assigned to another level. this is used for the</shortdescription></doc></variable><variable name="$mayToggle" access="public" type="bool"><doc><see type="var">$defaultOff</see><description>default and not set = false.</description><shortdescription>tells if the container content may be toggled (display/hide).</shortdescription></doc></variable><variable name="$defaultOff" access="public" type="bool"><doc><see type="var">$mayToggle</see><description>default and not set = false.</description><shortdescription>tells if the container content is hidden when the form loads.</shortdescription></doc></variable><variable name="$useTemplate" access="public" type="bool"><doc><see type="var">$templatePath</see><description>set to TRUE.to see how templates are named see the phpdoc of Bs_FormTemplateParser-&amp;gt;loadTemplate().note: you can code endless loops if your template uses the container element itself.it crashed my apache 1.3x on windows 2k workstation.</description><shortdescription>if we should use a template when an appropriate one is available. false unless</shortdescription></doc></variable><variable name="$templatePath" access="public" type="string"><doc><see type="var">$useTemplate</see><description>getAbsolutePath() . &amp;apos;../templates/&amp;apos;will be used which kinda sucks. so you better set that...</description><shortdescription>the absolute path to the template(s). if not given then</shortdescription></doc></variable><constant name="BS_FORMCONTAINER_VERSION" undoc="true" access="private" case="default: case sensitive">4.0.$x$<doc></doc></constant><inherited src="Bs_FormElement" type="functions"><element>bs_formelement</element><element>hasformobject</element><element>setformobject</element><element>getcaption</element><element>getelement</element><element>_doelementstringformat</element><element>_getparamvalue</element><element>getlanguagedependentvalue</element></inherited><inherited src="Bs_Object" type="functions"><element>isex</element><element>isexception</element><element>tostring</element><element>tohtml</element><element>unpersist</element><element>bs_object</element><element>bbsetoutput</element><element>bbawake</element><element>bbisawake</element><element>bbxmsg</element><element>bbxfunctionstart</element><element>bbxfunctionend</element><element>bbxecho</element><element>bbxvar</element><element>bbxvardump</element><element>bbforcetrace</element><element>bbbufferstart</element><element>bbbufferget</element><element>bbbufferendflush</element><element>bbbufferendclean</element></inherited><inherited src="Bs_FormElement" type="variables"><element>$persister</element><element>$persisterid</element><element>$_form</element><element>$name</element><element>$elementtype</element><element>$formid</element><element>$container</element><element>$orderid</element><element>$elementstringformat</element><element>$persistervarsettings</element><element>$this</element></inherited><inherited src="Bs_FormElement" type="consts"><element>bs_formelement_version</element></inherited><inherited src="Bs_Object" type="consts"><element>bs_object_version</element></inherited><path><parent>Bs_FormElement</parent><parent>Bs_Object</parent></path><baseclass>Bs_Object</baseclass></class></phpdoc>