| core_html

# Class: Bs_FormFieldCheckbox Source Location: /core/html/form/Bs_FormFieldCheckbox.class.php
### Class Overview
    Bs_Object
       |
       --Bs_FormElement
          |
          --Bs_FormField
             |
             --Bs_FormFieldCheckbox
CHECKBOX Form Field Class #### Author(s): andrej arn <at blueshoes dot org> #### Version: 4.3.$Revision: 1.3 $ $Date: 2003/10/29 17:48:39 $ #### Copyright: blueshoes.org | ### Variables $text $textStyles | ### Methods Bs_FormFieldCheckbox getCaption getField getFieldText getReadableValue inputValidate
### Child classes: Bs_FormFieldCheckboxJs CHECKBOX Form Field Class using the JavaScript checkbox component. | ### Inherited Variables #### Class: Bs_FormField Bs_FormField::$additionalCheck Bs_FormField::$additionalTags Bs_FormField::$advancedStyles Bs_FormField::$bsDataInfo Bs_FormField::$bsDataManipulation Bs_FormField::$bsDataManipVar Bs_FormField::$bsDataType Bs_FormField::$case Bs_FormField::$codePostLoad Bs_FormField::$codePostManipulate Bs_FormField::$codePostReceive Bs_FormField::$dbAttributes Bs_FormField::$dbAutoIncrement Bs_FormField::$dbDataType Bs_FormField::$dbFieldName Bs_FormField::$dbForeignKey Bs_FormField::$dbIndexFulltext Bs_FormField::$dbKey Bs_FormField::$dbNotNull Bs_FormField::$dbPrimaryKey Bs_FormField::$dbUnique Bs_FormField::$defaultErrorMessage Bs_FormField::$direction Bs_FormField::$editability Bs_FormField::$enforce Bs_FormField::$equalTo Bs_FormField::$errorMessage Bs_FormField::$errorType Bs_FormField::$events Bs_FormField::$explodeEval Bs_FormField::$fieldType Bs_FormField::$isUsed Bs_FormField::$level Bs_FormField::$maxLength Bs_FormField::$minLength Bs_FormField::$must Bs_FormField::$mustBeUnique Bs_FormField::$mustContain Bs_FormField::$mustEndWith Bs_FormField::$mustIf Bs_FormField::$mustOneOf Bs_FormField::$mustOneOfIf Bs_FormField::$mustStartWith Bs_FormField::$notContain Bs_FormField::$notEndWith Bs_FormField::$notEqualTo Bs_FormField::$notStartWith Bs_FormField::$onEnter Bs_FormField::$onlyIf Bs_FormField::$onlyOneOf Bs_FormField::$onlyOneOfIf Bs_FormField::$regularExpression Bs_FormField::$remove Bs_FormField::$removeI Bs_FormField::$replace Bs_FormField::$replaceI Bs_FormField::$saveToDb Bs_FormField::$styles Bs_FormField::$trim Bs_FormField::$valueDefault Bs_FormField::$valueDefaultType Bs_FormField::$valueDisplay Bs_FormField::$valueInternal Bs_FormField::$valueReceived Bs_FormField::$_Bs_String Bs_FormField::$_explodeArray Bs_FormField::$_must #### Class: Bs_FormElement Bs_FormElement::$accessRights Bs_FormElement::$caption Bs_FormElement::$container Bs_FormElement::$elementLayout Bs_FormElement::$elementStringFormat Bs_FormElement::$elementType Bs_FormElement::$FormID Bs_FormElement::$hideCaption Bs_FormElement::$name Bs_FormElement::$orderId Bs_FormElement::$persister Bs_FormElement::$persisterID Bs_FormElement::$persisterVarSettings Bs_FormElement::$visibility Bs_FormElement::$_form | ### Inherited Methods #### Class: Bs_FormField Bs_FormField::Bs_FormField() Constructor. Bs_FormField::addEnforceCheckbox() add enforce checkbox if needed. Bs_FormField::applyOnEnterBehavior() merges the onEnter javascript call into the events array if needed. Bs_FormField::getAdvancedStyle() returns the advanced style for the given key. Bs_FormField::getAdvancedStyleHelper() returns the advanced style for the field itself or the caption, taking the current mode into account. Bs_FormField::getCaption() Return the caption string (for the current language). Bs_FormField::getCaptionForFormOutput() returns the caption string to use in the form output. so expect html here and not plaintext. Bs_FormField::getDbDataType() returns the db datatype to use for this field. Bs_FormField::getDbFieldName() returns the db field name you should use for this field. Bs_FormField::getElement() Return some html code to display all the exploded fields on a website in a form. Bs_FormField::getError() returns the error message for the current field, or an empty string if no error. Bs_FormField::getErrorMessage() returns a textual error message for the given error type. Bs_FormField::getField() overwrite this method in your subclass. Bs_FormField::getFieldAsHidden() Return some html code to send to the client. same as getField() but returns the field like a hidden field, no matter what field type it is. Bs_FormField::getHelp() returns the help text Bs_FormField::getLabel() Return the label tag (for the current language). Bs_FormField::getOnEnterBehavior() tells how this form field should behave when the user hits enter. Bs_FormField::getOnEnterCode() returns some javascript code (the call) to behave the way the coder wants. Bs_FormField::getValue() returns the value. Bs_FormField::hasJavascript() tells whether the client browser has javascript support or not. Bs_FormField::inputManipulate() manipulate the user inputs according to the object vars. Bs_FormField::inputValidate() validate the user inputs according to the object vars. Bs_FormField::isExplodable() tells if this is an explodable field. Bs_FormField::isFilledIn() tells if the user filled in this field *somehow*. does not tell if the input was ok/accepted. Bs_FormField::isMust() tells if the field has to be filled in according to the current settings. Bs_FormField::postManipulateTrigger() gets called after the user input has been set to the form fields, and the needed automatic manipulations have been done. Bs_FormField::postReceiveTrigger() gets called right after the user input has been set to the form fields. Bs_FormField::setExplode() explode this field into multiple ones? Bs_FormField::shouldPersist() tells if the received value should be persisted (used) this time. Bs_FormField::unpersistTrigger() gets executed automatically in some circumstances: by the ObjPersister. read there for more info. Bs_FormField::validateAdditionalCheck() additionalCheck Bs_FormField::validateDataType() bsDataType/bsDataInfo Bs_FormField::validateEqualTo() equalTo Bs_FormField::validateMaxLength() checks the maxLength case. Bs_FormField::validateMinLength() checks the minLength case. Bs_FormField::validateMust() must Bs_FormField::validateMustBeUnique() checks the mustBeUnique case. the check is made non-case-sensitive. Bs_FormField::validateMustContain() mustContain Bs_FormField::validateMustEndWith() mustEndWith Bs_FormField::validateMustStartWith() mustStartWith Bs_FormField::validateNotContain() notContain Bs_FormField::validateNotEndWith() notEndWith Bs_FormField::validateNotEqualTo() notEqualTo Bs_FormField::validateNotStartWith() notStartWith Bs_FormField::validateOnlyIf() onlyIf Bs_FormField::validateOnlyOneOf() onlyOneOf Bs_FormField::validateRegularExpression() regularExpression #### Class: Bs_FormElement Bs_FormElement::Bs_FormElement() Constructor. Bs_FormElement::getCaption() Return the caption string (for the current language). Bs_FormElement::getCaptionForFormOutput() returns the caption. here in Bs_FormElement it's the same getCaption() but in Bs_FormField which overwrites these methods it makes a difference. Bs_FormElement::getElement() Return some html code to display the element on a website in a form. Bs_FormElement::getElementLayout() returns the layout string for this element. Bs_FormElement::getLanguageDependentValue() returns the value of a [language dependant] [object] var for the current or given language. Bs_FormElement::getLevel() returns the level this element belongs to. Bs_FormElement::getVisibility() returns how this field/element should be visible and editable to the user. Bs_FormElement::hasFormObject() tells if we have a reference to a form object where we can grab some information. Bs_FormElement::setFormObject() set a reference to a form object. #### Class: Bs_Object Bs_Object::Bs_Object() Bs_Object::getErrors() Basic error handling: Get *all* errors as string array from the global Bs_Error-error stack. Bs_Object::getLastError() Basic error handling: Get last error string from the global Bs_Error-error stack. Bs_Object::getLastErrors() Basic error handling: Get last errors string array from the global Bs_Error-error stack sinc last call of getLastErrors(). Bs_Object::persist() Persists this object by serializing it and saving it to a file with unique name. Bs_Object::setError() Basic error handling: Push an error string on the global Bs_Error-error stack. Bs_Object::toHtml() Dumps the content of this object to a string using PHP's var_dump(). Bs_Object::toString() Dumps the content of this object to a string using PHP's var_dump(). Bs_Object::unpersist() Fetches an object that was persisted with persist()
### Class Details [line 26] CHECKBOX Form Field Class example tag: <input type="checkbox" name="fieldname" value="value" checked> do you want to click here? what's special about this tag? checked => if we have a value = 1, this means checked. 0 means not checked. text => usually there is some additional text, like "do you want to receive the free newsletter?" no dependencies here. #### Tags:
copyright: | blueshoes.org
pattern: | singleton: (pseudostatic)
access: | public
version: | 4.3.$Revision: 1.3 $ $Date: 2003/10/29 17:48:39 $
author: | andrej arn <at blueshoes dot org>
[ Top ] ### Class Variables #### $text = NULL [line 35] additional text as in <input type="checkbox" name="fieldname" value="value" checked> do you want to click here? usually a string, can be a hash because it's language dependant.
Type: | mixed
[ Top ] #### $textStyles = NULL [line 57] associative array with style information for the $text. these keys can be used:
       - string class
       - string id
       - string style (**)
       - (*) mixed title[]
         a string or an associative array cause it's language dependant.
         appears as a tool tip over the field.

       (*)  these options are not available in the gui. problem with explodable holding explodable.
       (**) if the "toggleCheckbox" javascript functionality is used, and it is used by default,
            then this setting will be ignored.
check your html documentation for details. #### Tags:
since: | bs4.3
see: | $this->_getTagStringStylesForText()
Type: | array
[ Top ] ### Class Methods ### constructor Bs_FormFieldCheckbox [line 63]
`Bs_FormFieldCheckbox Bs_FormFieldCheckbox( )`
constructor [ Top ] ### method getCaption [line 182]
`string getCaption( [bool $useAccessKey = TRUE], [string $lang = null], [bool $clickable = FALSE])`
Return the caption string (for the current language). overwrites/uses parent method. #### Tags:
return: | the caption for this field.
see: | var $this->caption, $this->getLabel().
Overrides Bs_FormField::getCaption() (Return the caption string (for the current language).) #### Parameters:
bool | $useAccessKey | if we should 'highlight' the access key in the returned caption. default = TRUE.
string | $lang | (default is null. if not given then the lang setting of the form is used.)
bool | $clickable | if the caption should be clickable to toggle the checkbox value. default is FALSE.
[ Top ] ### method getField [line 83]
`string &getField( [mixed $explodeKey = NULL], [bool $withText = TRUE], [bool $addEnforceCheckbox = TRUE])`
Return some html code to display the field on a website in a form. overwrites parent method. #### Tags:
return: | some html code
see: | $this->getFieldAsHidden(), $this->addEnforceCheckbox()
access: | public
Overridden in child classes as: Bs_FormFieldCheckboxJs::getField() Return some html code to display the field on a website in a form. Overrides Bs_FormField::getField() (overwrite this method in your subclass.) #### Parameters:
mixed | $explodeKey | (int or string)
bool | $withText | if the description should be returned also. default is TRUE.
bool | $addEnforceCheckbox | default is TRUE. adds the enforce checkbox automatically, if needed. see (parent::)addEnforceCheckbox().
[ Top ] ### method getFieldText [line 154]
`string getFieldText( [bool $clickable = FALSE])`
returns the description text for the checkbox. returns an empty string if $this->text is empty. #### Tags:
return: | the text, maybe with html if $clickable.
access: | public
#### Parameters:
bool | $clickable | if a click on this text should toggle the checkbox. default is FALSE.
[ Top ] ### method getReadableValue [line 223]
`string getReadableValue( [string $value = null], [string $lang = null])`
returns a human-readable representation of [a|the] value of this field in the default or given language. #### Tags:
access: | public
#### Parameters:
string | $value | (not given = use the $valueDisplay of this field.)
string | $lang | (not given = use the lang of this form.)
[ Top ] ### method inputValidate [line 252]
`mixed inputValidate( [mixed $paramValue = NULL])`
validate the user inputs according to the object vars. 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/bsDataInfo
       2) --onlyOneOf    6) --notStartWith     10) --notContain     14) --regularExpression
       3) --minLength    7) --mustEndWith      11) --equalTo        15) --mustBeUnique
       4) --maxLength    8) --notEndWith       12) --notEqualTo
so 'must' is the only thing we really use here. you may say it's not of any use also, but think of the checkbox "do you agree to the terms and conditions" which is just there to be clicked. #### Tags:
access: | public
Overrides Bs_FormField::inputValidate() (validate the user inputs according to the object vars.) #### Parameters:
mixed | $paramValue | (only used internally!!!)
[ Top ] Documentation generated on Mon, 29 Dec 2003 21:09:38 +0100 by phpDocumentor 1.2.3