Docs For Class CMS_object

Description

Class CMS_object_language

represent a simple language object

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

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

CMS_grandFather
   |
   --CMS_object_common
      |
      --CMS_object_language

Class Constant Summary

MESSAGE_OBJECT_LANGUAGE_CHOOSE_OBJECT = 1132

MESSAGE_OBJECT_LANGUAGE_DESCRIPTION = 324

MESSAGE_OBJECT_LANGUAGE_EMPTY_OBJECTS_SET = 265

MESSAGE_OBJECT_LANGUAGE_FUNCTION_SELECTEDOPTIONS_DESCRIPTION = 557

MESSAGE_OBJECT_LANGUAGE_LABEL = 323

Method Summary

static array(integer getListOfNamesForObject ([boolean $public = false], [ $searchConditions = array()], array $searchConditions,)

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 getHTMLDescription ()

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

string getLabel ()

array getLabelsStructure ( &$language, $objectName)

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

string selectOptions (array $values, multidimentionnal $tags)

Methods

static getListOfNamesForObject (line 248)

Return a list of all objects names of given type

return: objectID => string objectName)
access: public

static array(integer getListOfNamesForObject ([boolean $public = false], [ $searchConditions = array()], array $searchConditions,)

boolean $public: are the needed datas public ? /!\ Does not apply for this type of object
array $searchConditions,: search conditions to add. /!\ Does not apply for this type of object
$searchConditions

getFieldSearchSQL (line 292)

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

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)

getHTMLDescription (line 184)

get object HTML description for admin search detail. Usually, the label.

return: : object HTML description
access: public

string getHTMLDescription ()

Redefinition of:

CMS_object_common::getHTMLDescription(): get object HTML description for admin search detail. Usually, the label.

getInput (line 128)

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

get object label : for this object, same as getHTMLDescription

return: : the language 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 233)

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

getValue (line 213)

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

selectOptions (line 269)

Return options tag list (for a select tag) of all languages

return: : options tag list
access: public

string selectOptions (array $values, multidimentionnal $tags)

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

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_LANGUAGE_CHOOSE_OBJECT = 1132 (line 33)

MESSAGE_OBJECT_LANGUAGE_DESCRIPTION = 324 (line 39)

MESSAGE_OBJECT_LANGUAGE_EMPTY_OBJECTS_SET = 265 (line 32)

Standard Messages

MESSAGE_OBJECT_LANGUAGE_FUNCTION_SELECTEDOPTIONS_DESCRIPTION = 557 (line 40)

MESSAGE_OBJECT_LANGUAGE_LABEL = 323 (line 38)

Polymod Messages

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