Class CMS_object_page

Description

Class CMS_object_page

represent a simple page object

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

CMS_grandFather
   |
   --CMS_object_common
      |
      --CMS_object_integer
         |
         --CMS_object_page
Class Constant Summary
Variable Summary
 integer $_objectLabel
 array(integer $_parameters
 array(integer $_parameterValues
 array(integer $_subfields
 array(integer $_subfieldValues
Method Summary
 void CMS_object_page ([array $datas = array()], CMS_object_field &$field, [boolean $public = false])
 string getHTMLAdmin ( $fieldID,  $language, string $prefixName, integer $fieldID,, CMS_language $language,)
 string getHTMLDescription ()
 string getInput ( $fieldID, multidimentionnal $language,  $inputParams, array $values)
 array getLabelsStructure ( &$language,  $objectName)
 multidimentionnal getStructure ()
 multidimentionnal getValue (string $name, [string $parameters = ''])
 boolean setValues (array $values, string $prefixName)
Variables
integer $_objectDescription = self::MESSAGE_OBJECT_PAGE_DESCRIPTION (line 51)

object description

  • access: private
integer $_objectLabel = self::MESSAGE_OBJECT_PAGE_LABEL (line 44)

object label

  • access: private
array(integer $_parameters = array() (line 77)

all parameters definition

  • var: "subFieldID" => array("type" => string "(string|boolean|integer|date)", "required" => boolean, 'internalName' => string [, 'externalName' => i18nm ID]))
  • access: private
array(integer $_parameterValues = array() (line 84)

all subFields values for object

  • var: "subFieldID" => mixed)
  • access: private
array(integer $_subfields = array(0 => array(
'type' => 'integer',
'required' => false,
'internalName' => 'page',
),)
(line 58)

all subFields definition

  • var: "subFieldID" => array("type" => string "(string|boolean|integer|date)", "required" => boolean, 'internalName' => string [, 'externalName' => i18nm ID]))
  • access: private
array(integer $_subfieldValues = array(0 => '') (line 70)

all subFields values for object

  • var: "subFieldID" => mixed)
  • access: private
Methods
Constructor CMS_object_page (line 96)

Constructor.

initialize object.

  • access: public
void CMS_object_page ([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
getHTMLAdmin (line 110)

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

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

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

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_integer::getLabelsStructure()
get labels for object structure and functions
getStructure (line 207)

get object values structure available with getValue method

  • return: array : the object values structure
  • access: public
multidimentionnal getStructure ()

Redefinition of:
CMS_object_integer::getStructure()
get object values structure available with getValue method
getValue (line 223)

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_integer::getValue()
get an object value
setValues (line 185)

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

Inherited Methods

Inherited From CMS_object_integer

 CMS_object_integer::__construct()
 CMS_object_integer::checkMandatory()
 CMS_object_integer::getFieldSearchSQL()
 CMS_object_integer::getHTMLAdmin()
 CMS_object_integer::getInput()
 CMS_object_integer::getLabelsStructure()
 CMS_object_integer::getStructure()
 CMS_object_integer::getValue()
 CMS_object_integer::setValues()

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_PAGE_DESCRIPTION = 407 (line 33)
MESSAGE_OBJECT_PAGE_LABEL = 406 (line 32)

Polymod Messages

MESSAGE_OBJECT_PAGE_PAGE_ID_DESCRIPTION = 534 (line 37)
MESSAGE_OBJECT_PAGE_PAGE_TITLE_DESCRIPTION = 532 (line 35)
MESSAGE_OBJECT_PAGE_PAGE_URL_DESCRIPTION = 533 (line 36)
MESSAGE_PAGE_TREEH1 = 1049 (line 34)

Inherited Constants

Inherited from CMS_object_integer

CMS_object_integer::MESSAGE_OBJECT_INTEGER_DESCRIPTION
CMS_object_integer::MESSAGE_OBJECT_INTEGER_LABEL
CMS_object_integer::MESSAGE_OBJECT_INTEGER_OPERATOR_OTHERS_DESCRIPTION
CMS_object_integer::MESSAGE_OBJECT_INTEGER_PARAMETER_CANBENEGATIVE
CMS_object_integer::MESSAGE_OBJECT_INTEGER_PARAMETER_CANBENULL
CMS_object_integer::MESSAGE_OBJECT_INTEGER_PARAMETER_UNIT
CMS_object_integer::MESSAGE_OBJECT_INTEGER_PARAMETER_UNIT_DESC
CMS_object_integer::MESSAGE_OBJECT_INTEGER_PARAMETER_UNIT_DESCRIPTION

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:34:38 +0100 by phpDocumentor 1.4.3