Class CMS_object_href

Description
Description | Methods (details) Constants (details)

Class CMS_object_href

represent an href object

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

CMS_grandFather
   |
   --CMS_object_common
      |
      --CMS_object_href
Class Constant Summary
Description | Constants (details) | Methods (details)
MESSAGE_OBJECT_HREF_ALL_FILES = 530
MESSAGE_OBJECT_HREF_DESCRIPTION = 176
MESSAGE_OBJECT_HREF_EXISTING_LINK = 6
MESSAGE_OBJECT_HREF_FIELD_NONE = 10
MESSAGE_OBJECT_HREF_HREFHTML_DESCRIPTION = 155
MESSAGE_OBJECT_HREF_HREFLABEL_DESCRIPTION = 152
MESSAGE_OBJECT_HREF_HREFTARGET_DESCRIPTION = 153
MESSAGE_OBJECT_HREF_HREFTYPE_DESCRIPTION = 154
MESSAGE_OBJECT_HREF_HREFVALUE_DESCRIPTION = 151
MESSAGE_OBJECT_HREF_LABEL = 175
MESSAGE_OBJECT_HREF_POPUPHEIGHT_DESCRIPTION = 426
MESSAGE_OBJECT_HREF_POPUPWIDTH_DESCRIPTION = 425
MESSAGE_OBJECT_HREF_VALIDHREF_DESCRIPTION = 252
Method Summary
Description | Constants (details) Methods (details)
boolean checkMandatory (array $values, string $prefixName, [boolean $newFormat = 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)
multidimentionnal getStructure ()
multidimentionnal getValue (string $name, [string $parameters = ''])
void __construct ([array $datas = array()], CMS_object_field &$field, [boolean $public = false])
void needIDToSetValues ()
boolean setValues (array $values,  $prefixName, [boolean $newFormat = false], [integer $objectID = ''], string $prefixname)
Methods
Description | Constants (details) Methods (details)
checkMandatory (line 121)

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
getHTMLAdmin (line 150)

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

get object HTML description for admin search detail.

  • 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 183)

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

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

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
getStructure (line 322)

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

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

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.
needIDToSetValues (line 244)

blank method, only needed to inform the need of an object id when set object values (method setValues)

  • access: public
void needIDToSetValues ()
setValues (line 258)

set object Values

  • return: true on success, false on failure
  • access: public
boolean setValues (array $values,  $prefixName, [boolean $newFormat = false], [integer $objectID = ''], string $prefixname)
  • array $values: : the POST result values
  • string $prefixname: : the prefix used for post names
  • integer $objectID: : the current object id. Must be set, but default is blank for compatibility with other objects
  • boolean $newFormat: newFormat : new automne v4 format (default false for compatibility)
  • $prefixName
Redefinition of:
CMS_object_common::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
Description | Constants (details) | Methods (details)
MESSAGE_OBJECT_HREF_ALL_FILES = 530 (line 47)
MESSAGE_OBJECT_HREF_DESCRIPTION = 176 (line 40)
MESSAGE_OBJECT_HREF_EXISTING_LINK = 6 (line 42)
MESSAGE_OBJECT_HREF_FIELD_NONE = 10 (line 46)

Standard Messages

MESSAGE_OBJECT_HREF_HREFHTML_DESCRIPTION = 155 (line 36)
MESSAGE_OBJECT_HREF_HREFLABEL_DESCRIPTION = 152 (line 33)
MESSAGE_OBJECT_HREF_HREFTARGET_DESCRIPTION = 153 (line 34)
MESSAGE_OBJECT_HREF_HREFTYPE_DESCRIPTION = 154 (line 35)
MESSAGE_OBJECT_HREF_HREFVALUE_DESCRIPTION = 151 (line 32)

Polymod Messages

MESSAGE_OBJECT_HREF_LABEL = 175 (line 39)
MESSAGE_OBJECT_HREF_POPUPHEIGHT_DESCRIPTION = 426 (line 38)
MESSAGE_OBJECT_HREF_POPUPWIDTH_DESCRIPTION = 425 (line 37)
MESSAGE_OBJECT_HREF_VALIDHREF_DESCRIPTION = 252 (line 41)

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