Docs For Class CMS_object

CMS_object_date

Description

Class CMS_object_date

represent a date object

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

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

CMS_grandFather
   |
   --CMS_object_common
      |
      --CMS_object_date

Class Constant Summary

MESSAGE_OBJECT_DATE_DATE_COMMENT = 148

MESSAGE_OBJECT_DATE_DESCRIPTION = 171

MESSAGE_OBJECT_DATE_FORMATEDVALUE_DESCRIPTION = 150

MESSAGE_OBJECT_DATE_HASVALUE_DESCRIPTION = 411

MESSAGE_OBJECT_DATE_HMS_FORMAT = 174

MESSAGE_OBJECT_DATE_HOURS = 515

MESSAGE_OBJECT_DATE_LABEL = 170

MESSAGE_OBJECT_DATE_OPERATOR_DESCRIPTION = 380

MESSAGE_OBJECT_DATE_OPERATOR_TITLE = 390

MESSAGE_OBJECT_DATE_PARAMETER_CREATION_DATE = 368

MESSAGE_OBJECT_DATE_PARAMETER_MOVE_DATE = 369

MESSAGE_OBJECT_DATE_PARAMETER_MOVE_DATE_DESCRIPTION = 370

MESSAGE_OBJECT_DATE_PARAMETER_SETNOW = 172

MESSAGE_OBJECT_DATE_PARAMETER_UPDATE_DATE = 371

MESSAGE_OBJECT_DATE_PARAMETER_WITH_HMS = 173

MESSAGE_OBJECT_DATE_TIMESTAMP_DESCRIPTION = 605

Method Summary

boolean checkMandatory (array $values, string $prefixName)

string getFieldOrderSQL (integer $fieldID, mixed $direction, string $operator, string $where, [boolean $public = 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)

string getLabel ()

array getLabelsStructure ( &$language, $objectName)

multidimentionnal getStructure ()

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

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

string selectOptions (array $values, multidimentionnal $tags)

boolean setValues (array $values, $prefixName, string $prefixname)

boolean writeToPersistence (array $values, string $prefixname)

Methods

checkMandatory (line 181)

check object Mandatories Values

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

boolean checkMandatory (array $values, string $prefixName)

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

Redefinition of:

CMS_object_common::checkMandatory(): check object Mandatories Values

getFieldOrderSQL (line 615)

Get field order SQL request (used by class CMS_object_search)

return: : the SQL request
access: public

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

integer $fieldID: : this field id in object (aka $this->_field->getID())
mixed $direction: : the direction to search (asc/desc)
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::getFieldOrderSQL(): Get field order SQL request (used by class CMS_object_search)

getFieldSearchSQL (line 544)

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 213)

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)

getInput (line 313)

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

getLabel (line 151)

get object label

return: : the label
access: public

string getLabel ()

Redefinition of:

CMS_object_common::getLabel(): get object label : by default, the first subField value (used to designate this object in lists)

getLabelsStructure (line 524)

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

getStructure (line 424)

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

getValue (line 440)

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

Constructor __construct (line 140)

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.

selectOptions (line 670)

Return options tag list (for a select tag) of all float values for this field

return: : options tag list
access: public

string selectOptions (array $values, multidimentionnal $tags)

array $values: : parameters values array(parameterName => parameterValue) in : selected : the float value which is selected (optional)
multidimentionnal $tags: array $tags : xml2Array content of atm-function tag (nothing for this one)

setValues (line 378)

set object Values

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

boolean setValues (array $values, $prefixName, string $prefixname)

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

Redefinition of:

CMS_object_common::setValues(): set object Values

writeToPersistence (line 643)

set object Values

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

boolean writeToPersistence (array $values, string $prefixname)

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

Redefinition of:

CMS_object_common::writeToPersistence(): Writes all subobjects into persistence (MySQL for now), along with base data.

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_DATE_DATE_COMMENT = 148 (line 51)

Standard Messages

MESSAGE_OBJECT_DATE_DESCRIPTION = 171 (line 34)

MESSAGE_OBJECT_DATE_FORMATEDVALUE_DESCRIPTION = 150 (line 32)

Polymod Messages

MESSAGE_OBJECT_DATE_HASVALUE_DESCRIPTION = 411 (line 45)

MESSAGE_OBJECT_DATE_HMS_FORMAT = 174 (line 37)

MESSAGE_OBJECT_DATE_HOURS = 515 (line 44)

MESSAGE_OBJECT_DATE_LABEL = 170 (line 33)

MESSAGE_OBJECT_DATE_OPERATOR_DESCRIPTION = 380 (line 42)

MESSAGE_OBJECT_DATE_OPERATOR_TITLE = 390 (line 43)

MESSAGE_OBJECT_DATE_PARAMETER_CREATION_DATE = 368 (line 38)

MESSAGE_OBJECT_DATE_PARAMETER_MOVE_DATE = 369 (line 39)

MESSAGE_OBJECT_DATE_PARAMETER_MOVE_DATE_DESCRIPTION = 370 (line 40)

MESSAGE_OBJECT_DATE_PARAMETER_SETNOW = 172 (line 35)

MESSAGE_OBJECT_DATE_PARAMETER_UPDATE_DATE = 371 (line 41)

MESSAGE_OBJECT_DATE_PARAMETER_WITH_HMS = 173 (line 36)

MESSAGE_OBJECT_DATE_TIMESTAMP_DESCRIPTION = 605 (line 46)

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

Documentation generated on Wed, 15 Feb 2012 15:33:36 +0100 by phpDocumentor 1.4.3