Docs For Class CMS_object

Description

Class CMS_object_integer

represent a simple integer object

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

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

CMS_grandFather
   |
   --CMS_object_common
      |
      --CMS_object_integer

Direct descendents

Class	Description
CMS_object_page	Class CMS_object_page

Class Constant Summary

MESSAGE_OBJECT_INTEGER_DESCRIPTION = 178

MESSAGE_OBJECT_INTEGER_LABEL = 177

MESSAGE_OBJECT_INTEGER_OPERATOR_OTHERS_DESCRIPTION = 539

MESSAGE_OBJECT_INTEGER_PARAMETER_CANBENEGATIVE = 180

MESSAGE_OBJECT_INTEGER_PARAMETER_CANBENULL = 179

MESSAGE_OBJECT_INTEGER_PARAMETER_UNIT = 417

MESSAGE_OBJECT_INTEGER_PARAMETER_UNIT_DESC = 418

MESSAGE_OBJECT_INTEGER_PARAMETER_UNIT_DESCRIPTION = 419

Method Summary

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

boolean checkMandatory (array $values, string $prefixName, [boolean $newFormat = false])

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)

multidimentionnal getStructure ()

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

boolean setValues (array $values, string $prefixName)

Methods

Constructor __construct (line 117)

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.

checkMandatory (line 131)

check object Mandatories Values

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

boolean checkMandatory (array $values, string $prefixName, [boolean $newFormat = false])

array $values: : the POST result values
string $prefixName: prefixname : the prefix used for post names
boolean $newFormat: newFormat : new automne v4 format (default false for compatibility)

Redefinition of:

CMS_object_common::checkMandatory(): check object Mandatories Values

getFieldSearchSQL (line 332)

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)

getHTMLAdmin (line 200)

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_page::getHTMLAdmin() : get HTML admin (used to enter object values in admin)

getInput (line 265)

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_page::getInput() : Return the needed form field tag for current object field

getLabelsStructure (line 310)

get labels for object structure and functions

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

array getLabelsStructure ( &$language)

&$language

Redefinition of:

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

Redefined in descendants as:

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

getStructure (line 228)

get object values structure available with getValue method

return: array : the object values structure
access: public

multidimentionnal getStructure ()

Redefinition of:

CMS_object_common::getStructure(): get object values structure available with getValue method

Redefined in descendants as:

CMS_object_page::getStructure() : get object values structure available with getValue method

getValue (line 243)

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_page::getValue() : get an object value

setValues (line 161)

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_page::setValues() : set object Values

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_INTEGER_DESCRIPTION = 178 (line 33)

MESSAGE_OBJECT_INTEGER_LABEL = 177 (line 32)

Polymod Messages

MESSAGE_OBJECT_INTEGER_OPERATOR_OTHERS_DESCRIPTION = 539 (line 39)

MESSAGE_OBJECT_INTEGER_PARAMETER_CANBENEGATIVE = 180 (line 35)

MESSAGE_OBJECT_INTEGER_PARAMETER_CANBENULL = 179 (line 34)

MESSAGE_OBJECT_INTEGER_PARAMETER_UNIT = 417 (line 36)

MESSAGE_OBJECT_INTEGER_PARAMETER_UNIT_DESC = 418 (line 37)

MESSAGE_OBJECT_INTEGER_PARAMETER_UNIT_DESCRIPTION = 419 (line 38)

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