Docs For Class CMS_object

Description

Class CMS_object_string

represent a simple string object

author: Sébastien Pauchet <sebastien.pauchet@ws-interactive.fr>

Located in /automne/classes/modules/polymod/objects/object_string.php (line 27)

CMS_grandFather
   |
   --CMS_object_common
      |
      --CMS_object_string

Direct descendents

Class	Description
CMS_object_float	Class CMS_object_float

Class Constant Summary

MESSAGE_OBJECT_STRING_DESCRIPTION = 186

MESSAGE_OBJECT_STRING_LABEL = 185

MESSAGE_OBJECT_STRING_OPERATOR_ARRAY_DESCRIPTION = 600

MESSAGE_OBJECT_STRING_OPERATOR_COMPARAISON_DESCRIPTION = 599

MESSAGE_OBJECT_STRING_OPERATOR_DESCRIPTION = 389

MESSAGE_OBJECT_STRING_PARAMETER_ISEMAIL = 226

MESSAGE_OBJECT_STRING_PARAMETER_MATCH_EXPRESSION = 372

MESSAGE_OBJECT_STRING_PARAMETER_MATCH_EXPRESSION_DESCRIPTION = 373

MESSAGE_OBJECT_STRING_PARAMETER_MAXLENGHT_DESC = 536

MESSAGE_OBJECT_STRING_PARAMETER_MAXLENGTH = 187

MESSAGE_OBJECT_TEXT_OPERATOR_ALL_DESCRIPTION = 636

MESSAGE_OBJECT_TEXT_OPERATOR_ANY_DESCRIPTION = 635

MESSAGE_OBJECT_TEXT_OPERATOR_BEGINSWITH_DESCRIPTION = 638

MESSAGE_OBJECT_TEXT_OPERATOR_PHRASE_DESCRIPTION = 637

Method Summary

string getFieldSearchSQL (integer $fieldID, mixed $value, string $operator, string $where, [boolean $public = false])

string getHTMLAdmin ( $fieldID, $language, string $prefixName, integer $fieldID,, CMS_language $language,)

string getInput ( $fieldID, multidimentionnal $language, $inputParams, array $values)

array getLabelsStructure ( &$language, $objectName)

multidimentionnal getValue (string $name, [string $parameters = ''])

void __construct ([array $datas = array()], CMS_object_field &$field, [boolean $public = false])

boolean setValues (array $values, string $prefixName)

array, treatParams (array $post, string $prefix)

Methods

getFieldSearchSQL (line 299)

Get field search SQL request (used by class CMS_object_search)

return: : the SQL request
access: public

string getFieldSearchSQL (integer $fieldID, mixed $value, string $operator, string $where, [boolean $public = false])

integer $fieldID: : this field id in object (aka $this->_field->getID())
mixed $value: : the value to search
string $operator: : additionnal search operator
string $where: : where clauses to add to SQL
boolean $public: : values are public or edited ? (default is edited)

Redefinition of:

CMS_object_common::getFieldSearchSQL(): Get field search SQL request (used by class CMS_object_search)

Redefined in descendants as:

CMS_object_float::getFieldSearchSQL() : Get field search SQL request (used by class CMS_object_search)

getHTMLAdmin (line 157)

get HTML admin (used to enter object values in admin)

return: : the html admin
access: public

string getHTMLAdmin ( $fieldID, $language, string $prefixName, integer $fieldID,, CMS_language $language,)

integer $fieldID,: the current field id (only for poly object compatibility)
CMS_language $language,: the current admin language
string $prefixName: prefixname : the prefix to use for post names
$fieldID
$language

Redefinition of:

CMS_object_common::getHTMLAdmin(): get HTML admin (used to enter object values in admin)

Redefined in descendants as:

CMS_object_float::getHTMLAdmin() : get HTML admin (used to enter object values in admin)

getInput (line 179)

Return the needed form field tag for current object field

return: : the form field HTML tag
access: public

string getInput ( $fieldID, multidimentionnal $language, $inputParams, array $values)

array $values: : parameters values array(parameterName => parameterValue) in : id : the form field id to set
multidimentionnal $language: array $tags : xml2Array content of atm-function tag
$fieldID
$inputParams

Redefinition of:

CMS_object_common::getInput(): Return the needed form field tag for current object field

Redefined in descendants as:

CMS_object_float::getInput() : Return the needed form field tag for current object field

getLabelsStructure (line 276)

get labels for object structure and functions

return: : the labels of object structure and functions
access: public

array getLabelsStructure ( &$language, $objectName)

&$language
$objectName

Redefinition of:

CMS_object_common::getLabelsStructure(): get labels for object structure and functions

Redefined in descendants as:

CMS_object_float::getLabelsStructure() : get labels for object structure and functions

getValue (line 256)

get an object value

return: array : the object values structure
access: public

multidimentionnal getValue (string $name, [string $parameters = ''])

string $name: : the name of the value to get
string $parameters: (optional) : parameters for the value to get

Redefinition of:

CMS_object_common::getValue(): get an object value

Redefined in descendants as:

CMS_object_float::getValue() : get an object value

Constructor __construct (line 123)

Constructor.

initialize object.

access: public

void __construct ([array $datas = array()], CMS_object_field &$field, [boolean $public = false])

array $datas: DB object values : array(integer "subFieldID" => mixed)
boolean $public: values are public or edited ? (default is edited)
CMS_object_field &$field: reference

Redefinition of:

CMS_object_common::__construct(): Constructor.

setValues (line 222)

set object Values

return: true on success, false on failure
access: public

boolean setValues (array $values, string $prefixName)

array $values: : the POST result values
string $prefixName: prefixname : the prefix used for post names

Redefinition of:

CMS_object_common::setValues(): set object Values

Redefined in descendants as:

CMS_object_float::setValues() : set object Values

treatParams (line 136)

treat all params then return array of values treated or false if error

return: the treated datas
access: public

array, treatParams (array $post, string $prefix)

array $post: the posted datas
string $prefix: the prefix for datas name

Redefinition of:

CMS_object_common::treatParams(): treat all params then return array of values treated or false if error

Inherited Methods

Inherited From CMS_object_common

CMS_object_common::__construct()
CMS_object_common::asArray()
CMS_object_common::checkMandatory()
CMS_object_common::getDescription()
CMS_object_common::getFieldDescription()
CMS_object_common::getFieldLabel()
CMS_object_common::getFieldOrderSQL()
CMS_object_common::getFieldSearchSQL()
CMS_object_common::getHTMLAdmin()
CMS_object_common::getHTMLDescription()
CMS_object_common::getHTMLSubFieldsParameters()
CMS_object_common::getInput()
CMS_object_common::getLabel()
CMS_object_common::getLabelsStructure()
CMS_object_common::getObjectLabel()
CMS_object_common::getParamsValues()
CMS_object_common::getParamValue()
CMS_object_common::getSoapValues()
CMS_object_common::getStructure()
CMS_object_common::getSubFieldParameters()
CMS_object_common::getSubFieldsDefinition()
CMS_object_common::getValue()
CMS_object_common::hasParameters()
CMS_object_common::serializeHTMLParameters()
CMS_object_common::setParamValue()
CMS_object_common::setSoapValues()
CMS_object_common::setSubFieldsDefinition()
CMS_object_common::setValues()
CMS_object_common::treatParams()
CMS_object_common::writeToPersistence()

Inherited From CMS_grandFather

CMS_grandFather::autoload()
CMS_grandFather::hasError()
CMS_grandFather::log()
CMS_grandFather::PHPErrorHandler()
CMS_grandFather::raiseError()
CMS_grandFather::setDebug()
CMS_grandFather::setLog()
CMS_grandFather::_raiseError()
CMS_grandFather::__call()

Class Constants

MESSAGE_OBJECT_STRING_DESCRIPTION = 186 (line 33)

MESSAGE_OBJECT_STRING_LABEL = 185 (line 32)

Polymod Messages

MESSAGE_OBJECT_STRING_OPERATOR_ARRAY_DESCRIPTION = 600 (line 41)

MESSAGE_OBJECT_STRING_OPERATOR_COMPARAISON_DESCRIPTION = 599 (line 40)

MESSAGE_OBJECT_STRING_OPERATOR_DESCRIPTION = 389 (line 38)

MESSAGE_OBJECT_STRING_PARAMETER_ISEMAIL = 226 (line 35)

MESSAGE_OBJECT_STRING_PARAMETER_MATCH_EXPRESSION = 372 (line 36)

MESSAGE_OBJECT_STRING_PARAMETER_MATCH_EXPRESSION_DESCRIPTION = 373 (line 37)

MESSAGE_OBJECT_STRING_PARAMETER_MAXLENGHT_DESC = 536 (line 39)

MESSAGE_OBJECT_STRING_PARAMETER_MAXLENGTH = 187 (line 34)

MESSAGE_OBJECT_TEXT_OPERATOR_ALL_DESCRIPTION = 636 (line 43)

MESSAGE_OBJECT_TEXT_OPERATOR_ANY_DESCRIPTION = 635 (line 42)

MESSAGE_OBJECT_TEXT_OPERATOR_BEGINSWITH_DESCRIPTION = 638 (line 45)

MESSAGE_OBJECT_TEXT_OPERATOR_PHRASE_DESCRIPTION = 637 (line 44)

Inherited Constants

Inherited from CMS_object_common

CMS_object_common::MESSAGE_FIELD_NO
CMS_object_common::MESSAGE_FIELD_YES
CMS_object_common::MESSAGE_OBJECT_COMMON_FIELDID_DESCRIPTION
CMS_object_common::MESSAGE_OBJECT_COMMON_FIELDNAME_DESCRIPTION
CMS_object_common::MESSAGE_OBJECT_COMMON_FIELD_DESC_DESCRIPTION
CMS_object_common::MESSAGE_OBJECT_COMMON_LABEL_DESCRIPTION
CMS_object_common::MESSAGE_OBJECT_COMMON_REQUIRED_DESCRIPTION
CMS_object_common::MESSAGE_OBJECT_COMMON_VALUE_DESCRIPTION
CMS_object_common::MESSAGE_UNKNOWN_OBJECT_DESCRIPTION
CMS_object_common::MESSAGE_UNKNOWN_OBJECT_LABEL

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL