<?xml version="1.0"?><phpdoc><class name="Bs_FormFieldCheckbox" extends="Bs_FormField" undoc="false" access="public" package="Form"><file>C:/usr/local/lib/php/blueshoes-4.2/core/html/form/Bs_FormFieldCheckbox.class.php</file><doc><author email="andrej@arn.li">andrej arn</author><inherited src="Array"/><overriden src="Array"/><description>example tag:&amp;lt;input type=&amp;quot;checkbox&amp;quot; name=&amp;quot;fieldname&amp;quot; value=&amp;quot;value&amp;quot; checked&amp;gt; do you want to click here?what&amp;apos;s special about this tag?- checked   =&amp;gt; if we have a value = 1, this means checked. 0 means not checked.- text      =&amp;gt; usually there is some additional text, like &amp;quot;do you want to receive the freenewsletter?&amp;quot;no dependencies here.</description><shortdescription>CHECKBOX Form Field Class</shortdescription><version>4.0.$id$</version><copyright>blueshoes.org</copyright></doc><function name="&amp;getField" undoc="false" access="public"><doc><see type="var">$this</see><see type="var">$this</see><parameter name="$explodeKey" default="NULL," type="mixed">(int or string)</parameter><parameter name="$withText" default="TRUE," type="string">if the description should be returned also. default is TRUE.</parameter><parameter name="$addEnforceCheckbox" default="TRUE" type="string">default is TRUE. adds the enforce checkbox automatically, if needed. see (parent::)addEnforceCheckbox().</parameter><return name="" type="string">some html code</return><description>overwrites parent method.</description><shortdescription>Return some html code to display the field on a website in a form.</shortdescription></doc></function><function name="getFieldText" undoc="false" access="public"><doc><parameter name="$clickable" default="FALSE" type="string">if a click on this text should toggle the checkbox. default is FALSE.</parameter><return name="" type="string">the text, maybe with html if $clickable.</return><description/><shortdescription>returns the description text for the checkbox.</shortdescription></doc></function><function name="getCaption" undoc="true" access="private"><doc><see type="var">$this</see><see type="var">$this</see><parameter name="$useAccessKey" default="TRUE," type="string">if we should &amp;apos;highlight&amp;apos; the access key in the returned caption. default = TRUE.</parameter><parameter name="$lang" default="null," type="string">(default is null. if not given then the lang setting of the form is used.)</parameter><parameter name="$clickable" default="FALSE" type="string">if the caption should be clickable to toggle the checkbox value. default is FALSE.</parameter><return name="" type="string">the caption for this field.</return><overriden src="Bs_FormElement"/><description>overwrites/uses parent method.</description><shortdescription>Return the caption string (for the current language).</shortdescription></doc></function><function name="getReadableValue" undoc="false" access="public"><doc><parameter name="$value" default="null," type="string">(not given = use the $valueDisplay of this field.)</parameter><parameter name="$lang" default="null" type="string">(not given = use the lang of this form.)</parameter><return name="" type="string"/><description>in the default or given language.</description><shortdescription>returns a human-readable representation of [a|the] value of this field</shortdescription></doc></function><function name="inputValidate" undoc="true" access="public"><doc><parameter name="$paramValue" default="NULL" type="mixed">(only used internally!!!)</parameter><return name="" type="mixed"/><overriden src="Bs_FormField"/><description>overwrites parent method. read manual there. additional information:the order for data validation is: (-- means check omitted here)1) must           5) --mustStartWith     9) --mustContain    13) --bsDataType/bsDataInfo2) --onlyOneOf    6) --notStartWith     10) --notContain     14) --regularExpression3) --minLength    7) --mustEndWith      11) --equalTo        15) --mustBeUnique4) --maxLength    8) --notEndWith       12) --notEqualToso &amp;apos;must&amp;apos; is the only thing we really use here. you may say it&amp;apos;s not of any use also,but think of the checkbox &amp;quot;do you agree to the terms and conditions&amp;quot; which is just thereto be clicked.</description><shortdescription>validate the user inputs according to the object vars.</shortdescription></doc></function><function name="Bs_FormFieldCheckbox" undoc="true" access="public"><doc><return type="void"/></doc></function><variable name="$text" access="private" type="mixed"><doc><description>&amp;lt;input type=&amp;quot;checkbox&amp;quot; name=&amp;quot;fieldname&amp;quot; value=&amp;quot;value&amp;quot; checked&amp;gt; do you want to click here?usually a string, can be a hash because it&amp;apos;s language dependant.</description><shortdescription>additional text as in</shortdescription></doc></variable><variable name="$this" access="private" type="unknown"><doc><overriden src="Bs_FormElement"/></doc></variable><constant name="BS_FORMFIELDCHECKBOX_VERSION" undoc="true" access="private" case="default: case sensitive">4.0.$x$<doc></doc></constant><inherited src="Bs_FormField" type="functions"><element>bs_formfield</element><element>&amp;getelement</element><element>getfield</element><element>addenforcecheckbox</element><element>isexplodable</element><element>getadvancedstyle</element><element>getadvancedstylehelper</element><element>setexplode</element><element>getlabel</element><element>inputmanipulate</element><element>validatemust</element><element>validateonlyoneof</element><element>validateonlyif</element><element>validateminlength</element><element>validatemaxlength</element><element>validatemuststartwith</element><element>validatenotstartwith</element><element>validatemustendwith</element><element>validatenotendwith</element><element>validatemustcontain</element><element>validatenotcontain</element><element>validateequalto</element><element>validatenotequalto</element><element>validatedatatype</element><element>validateregularexpression</element><element>validateadditionalcheck</element><element>validatemustbeunique</element><element>getvisibility</element><element>getonenterbehavior</element><element>getonentercode</element><element>applyonenterbehavior</element><element>shouldpersist</element><element>getdbdatatype</element><element>getdbfieldname</element><element>_getmaxlength</element><element>_gettagstringevents</element><element>getvalue</element><element>_gettagstringvalue</element><element>_gettagstringstyles</element><element>_gettagstringadditionaltags</element><element>getcaptionforformoutput</element><element>geterror</element><element>gethelp</element><element>_highlightaccesskey</element><element>_getaccesskey</element><element>getfieldashidden</element><element>_getfieldnameforhtml</element><element>hasjavascript</element><element>ismust</element><element>_anyifcase</element><element>_markasused</element><element>_getbsdatainfonumber</element><element>isfilledin</element><element>_evalwrap</element><element>unpersisttrigger</element><element>geterrormessage</element><element>&amp;serialize</element><element>unserialize</element><element>&amp;encrypt</element><element>&amp;decrypt</element><element>initfrompost</element></inherited><inherited src="Bs_FormElement" type="functions"><element>bs_formelement</element><element>hasformobject</element><element>setformobject</element><element>getelement</element><element>getlevel</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>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_FormField" type="variables"><element>$_bs_string</element><element>$_bs_array</element><element>$_bs_htmlutil</element><element>$_bs_date</element><element>$fieldtype</element><element>$caption</element><element>$defaulterrormessage</element><element>$errormessage</element><element>$errortype</element><element>$level</element><element>$editability</element><element>$accessrights</element><element>$visibility</element><element>$isused</element><element>$valuedefault</element><element>$valuedefaulttype</element><element>$valuereceived</element><element>$valuedisplay</element><element>$valueinternal</element><element>$savetodb</element><element>$dbfieldname</element><element>$dbdatatype</element><element>$dbnotnull</element><element>$dbprimarykey</element><element>$dbkey</element><element>$dbindexfulltext</element><element>$dbautoincrement</element><element>$dbunique</element><element>$dbforeignkey</element><element>$dbattributes</element><element>$explodeeval</element><element>$_explodearray</element><element>$direction</element><element>$styles</element><element>$advancedstyles</element><element>$events</element><element>$onenter</element><element>$additionaltags</element><element>$bsdatatype</element><element>$bsdatainfo</element><element>$bsdatamanipulation</element><element>$bsdatamanipvar</element><element>$enforce</element><element>$_must</element><element>$must</element><element>$mustif</element><element>$mustoneof</element><element>$mustoneofif</element><element>$onlyoneof</element><element>$onlyif</element><element>$onlyoneofif</element><element>$minlength</element><element>$maxlength</element><element>$muststartwith</element><element>$notstartwith</element><element>$mustendwith</element><element>$notendwith</element><element>$mustcontain</element><element>$notcontain</element><element>$equalto</element><element>$notequalto</element><element>$mustbeunique</element><element>$regularexpression</element><element>$additionalcheck</element><element>$trim</element><element>$remove</element><element>$removei</element><element>$replace</element><element>$replacei</element><element>$case</element><element>$codepostreceive</element><element>$codepostload</element><element>$charsrule</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></inherited><inherited src="Bs_FormField" type="consts"><element>bs_formfield_version</element><element>bs_ff_error</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_FormField</parent><parent>Bs_FormElement</parent><parent>Bs_Object</parent></path><baseclass>Bs_Object</baseclass></class></phpdoc>