Docs For Class CMS_object

Description

Class CMS_object_i18nm

represent a i18nm message

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

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

CMS_grandFather
   |
   --CMS_object_i18nm

Method Summary

static array, getAvailableLanguages ()

void __construct ([integer $id = 0], [array $dbValues = array()])

boolean destroy ()

string getHTMLAdmin ( $prefixName, [ $textareaInput = false])

integer, getID ()

string, getValue ([string $languageCode = ''], [boolean $usePriority = true])

array getValues ( $id)

boolean setValue (string $languageCode, mixed $value)

boolean setValues (array $values)

boolean writeToPersistence ()

Methods

static getAvailableLanguages (line 139)

Get available languages codes

return: the available languages codes
access: public

static array, getAvailableLanguages ()

Constructor __construct (line 73)

Constructor.

initialize object.

access: public

void __construct ([integer $id = 0], [array $dbValues = array()])

integer $id: DB id
array $dbValues: DB values

destroy (line 344)

Destroy this object, in DB

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

boolean destroy ()

getHTMLAdmin (line 248)

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

return: : the html admin
access: public

string getHTMLAdmin ( $prefixName, [ $textareaInput = false])

$prefixName
$textareaInput

getID (line 127)

Get object ID

return: the DB object ID
access: public

integer, getID ()

getValue (line 190)

get a value for a given language code if exist, else, return value by priority

return: the value
access: public

string, getValue ([string $languageCode = ''], [boolean $usePriority = true])

string $languageCode: the language code of the value to get
boolean $usePriority: : use priority system if value is not found for given code

getValues (line 211)

get all the values

return: the values
access: public

array getValues ( $id)

$id

setValue (line 172)

Sets a value for a given language code.

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

boolean setValue (string $languageCode, mixed $value)

string $languageCode: the language code of the value to set
mixed $value: the value to set

setValues (line 234)

set all the values

access: public

boolean setValues (array $values)

array $values: the values to set : array(language code => value)

writeToPersistence (line 273)

Writes object into persistence (MySQL for now), along with base data.

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

boolean writeToPersistence ()

Inherited Methods

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

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL