<?xml version="1.0"?><phpdoc><class name="Bs_FormElement" extends="Bs_Object" undoc="false" access="public" package="Form"><file>C:/usr/local/lib/php/blueshoes-4.2/core/html/form/Bs_FormElement.class.php</file><doc><author email="andrej@arn.li">andrej arn</author><inherited src="Array"/><description>basic implementation of an html form element. is never instanced alone,only extended by one of the following classes:- FormField       - FormText- FormContainer   - FormHtml- FormImage       - FormPhp- FormLinedependencies: Bs_ObjPersisterForMySql</description><shortdescription>Form Element Class</shortdescription><version>4.0.$id$</version><copyright>blueshoes.org</copyright></doc><function name="Bs_FormElement" undoc="false" access="public"><doc><return type="void"/><description/><shortdescription>Constructor.</shortdescription></doc></function><function name="hasFormObject" undoc="false" access="public"><doc><return name="" type="bool"/><description>some information.</description><shortdescription>tells if we have a reference to a form object where we can grab</shortdescription></doc></function><function name="setFormObject" undoc="false" access="public"><doc><parameter name="&amp;$form" type="object [unknown]"/><return name="" type="bool">true on success, false on failure.</return><description/><shortdescription>set a reference to a form object.</shortdescription></doc></function><function name="getCaption" undoc="false" access="private"><doc><see type="var">$this</see><see type="var">$this</see><return name="" type="string">the caption for this field.</return><description/><shortdescription>Return the caption string (for the current language).</shortdescription></doc></function><function name="getElement" undoc="false" access="private"><doc><return type="void"/><description>better overwrite this method.</description><shortdescription>Return some html code to display the element on a website in a form.</shortdescription></doc></function><function name="getLevel" undoc="false" access="public"><doc><return name="" type="int"/><throws>null</throws><description>throws null for unknown or not set.</description><shortdescription>returns the level this element belongs to.</shortdescription></doc></function><function name="_doElementStringFormat" undoc="false" access="private"><doc><parameter name="$elementString" type="string">the html element</parameter><return name="" type="string"/><description>won&amp;apos;t be used if the element is not sent to the browser, or sent in a hidden way.but is sent if for example an input field is disabled.</description><shortdescription>does the sprintf() with the element if $this-&amp;gt;elementStringFormat is used.</shortdescription></doc></function><function name="_getParamValue" undoc="false" access="private"><doc><parameter name="$var" type="mixed"/><return name="" type="array"> @throw an empty array if var is not set [correctly].</return><description>&amp;apos;howdy&amp;apos;array(&amp;apos;hi&amp;apos;, &amp;apos;hello&amp;apos;)array(&amp;apos;en&amp;apos;=&amp;gt;array(&amp;apos;hi&amp;apos;,&amp;apos;hello&amp;apos;), &amp;apos;de&amp;apos;=&amp;gt;array(&amp;apos;hallo&amp;apos;), &amp;apos;fr&amp;apos;=&amp;gt;array(&amp;apos;salut&amp;apos;,&amp;apos;bonjour&amp;apos;));and you only want the values that apply for this form (language), then use this function.uses getLanguageDependentValue()</description><shortdescription>if you have a value that can look like</shortdescription></doc></function><function name="getLanguageDependentValue" undoc="false" access="public"><doc><parameter name="$var" type="mixed">(the var where the values are in. string or array (hash).)</parameter><parameter name="$lang" default="null" type="string">(default is null. if not given then the lang setting of the form is used.)</parameter><return name="" type="string"/><throws>NULL if var is not set [correctly].</throws><description>or given language.</description><shortdescription>returns the value of a [language dependant] [object] var for the current</shortdescription></doc></function><variable name="$persister" access="private" type="string">NULL<doc><description/><shortdescription>instance of Bs_ObjPersisterForMySql to persist the settings.</shortdescription></doc></variable><variable name="$persisterID" access="private" type="int"><doc><description/><shortdescription>reserved var for the persister. don&amp;apos;t fuck with this.</shortdescription></doc></variable><variable name="$_form" access="private" type="object [unknown]"><doc><description>this is needed for various information, like the language we&amp;apos;re in.</description><shortdescription>a reference to the form object holding this form field.</shortdescription></doc></variable><variable name="$name" access="private" type="string"><doc><description>note: for form fields the name can be like an array:foo[&amp;apos;bar&amp;apos;]  (not foo[bar])with that feature you can &amp;apos;explode&amp;apos; fields too.a good example is the dsn db information. you wantto have the values in one var called dbDsn. but in the form youdon&amp;apos;t want the explode-feature because every value (host, port ...)needs to be validated differently.</description><shortdescription>the name of the element. must be unique for this form.</shortdescription></doc></variable><variable name="$elementType" access="private" type="unknown"><doc><description>- field- container- image- line- text- html- php</description><shortdescription>one of</shortdescription></doc></variable><variable name="$FormID" access="private" type="int"><doc><description/><shortdescription>form id, means to which form this element belongs.</shortdescription></doc></variable><variable name="$container" access="private" type="string"><doc><description>note: container may be of type Bs_FormContainer or Bs_DaFormPageControl.</description><shortdescription>the container to which this element belongs.</shortdescription></doc></variable><variable name="$orderId" access="private" type="int"><doc><description>spitted out to the browser. the higher the number, the higher the priority.</description><shortdescription>the order number (in the container, if set) in that the element should be</shortdescription></doc></variable><variable name="$elementStringFormat" access="private" type="mixed"><doc><description>some html code on both sides. so if used, this is the format argument of the sprintffunction.example:here we add an image that&amp;apos;ll be displayed after the element.$elementStringFormat = &amp;quot;%s &amp;lt;img src=&amp;apos;someImage.gif&amp;apos;&amp;gt;&amp;quot;;usually a string, can be a hash because it&amp;apos;s language dependant.</description><shortdescription>you may want to not only spit out the element but spit it out with other things, like</shortdescription></doc></variable><variable name="$persisterVarSettings" access="private" type="array">array(&amp;apos;name&amp;apos;                =&amp;gt; array(&amp;apos;mode&amp;apos;=&amp;gt;&amp;apos;lonely&amp;apos;,        &amp;apos;metaType&amp;apos;=&amp;gt;&amp;apos;string&amp;apos;,      &amp;apos;index&amp;apos;=&amp;gt;TRUE), &#x0a;                                    &amp;apos;elementType&amp;apos;         =&amp;gt; array(&amp;apos;mode&amp;apos;=&amp;gt;&amp;apos;lonely&amp;apos;,        &amp;apos;metaType&amp;apos;=&amp;gt;&amp;apos;string&amp;apos;,      &amp;apos;index&amp;apos;=&amp;gt;TRUE), &#x0a;                                    &amp;apos;FormID&amp;apos;              =&amp;gt; array(&amp;apos;mode&amp;apos;=&amp;gt;&amp;apos;lonely&amp;apos;,        &amp;apos;metaType&amp;apos;=&amp;gt;&amp;apos;integer&amp;apos;,     &amp;apos;index&amp;apos;=&amp;gt;TRUE), &#x0a;                                    &amp;apos;container&amp;apos;           =&amp;gt; array(&amp;apos;mode&amp;apos;=&amp;gt;&amp;apos;stream&amp;apos;), &#x0a;                                    &amp;apos;orderId&amp;apos;             =&amp;gt; array(&amp;apos;mode&amp;apos;=&amp;gt;&amp;apos;stream&amp;apos;), &#x0a;                                    &amp;apos;elementStringFormat&amp;apos; =&amp;gt; array(&amp;apos;mode&amp;apos;=&amp;gt;&amp;apos;stream&amp;apos;)&#x0a;                                    )<doc></doc></variable><variable name="$this" access="private" type="unknown"><doc></doc></variable><constant name="BS_FORMELEMENT_VERSION" undoc="true" access="private" case="default: case sensitive">4.0.$x$<doc></doc></constant><inherited src="Bs_Object" type="functions"><element>isex</element><element>isexception</element><element>tostring</element><element>tohtml</element><element>persist</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_Object" type="consts"><element>bs_object_version</element></inherited><path><parent>Bs_Object</parent></path><baseclass>Bs_Object</baseclass><subclasses><subclass>Bs_FormCode</subclass><subclass>Bs_FormContainer</subclass><subclass>Bs_FormField</subclass><subclass>Bs_FormHtml</subclass><subclass>Bs_FormImage</subclass><subclass>Bs_FormLine</subclass><subclass>Bs_FormText</subclass><subclass>Bs_DaFormPageControl</subclass></subclasses></class></phpdoc>