Class CMS_poly_object_field

Description
Description | Methods (details) Constants

Class CMS_poly_object_field

represent a poly object field

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

CMS_grandFather
   |
   --CMS_poly_object_definition
      |
      --CMS_poly_object_field
Method Summary
Description | Constants Methods (details)
static array getFieldsNextOrder ()
void __construct ([integer $id = 0], [array $dbValues = array()])
array asArray ([array $params = array()],  &$files, array $files)
boolean convertDefinitions (CMS_module $module)
boolean destroy ()
boolean fromArray (array $data, array $params, CMS_language $cms_language,  &$idsRelation,  &$infos, array $idsRelation, string $infos)
string, getFieldDescription (mixed $language)
integer, getID ()
integer, getObjectID ()
mixed, getParameter (string $internalName)
mixed, getTypeObject ([ $returnDefinition = false], [ $public = false], boolean $returnDefinition,)
mixed, getValue (string $valueName)
boolean setValue (string $valueName, mixed $value)
boolean writeToPersistence ()
Methods
Description | Constants Methods (details)
static getFieldsNextOrder (line 244)

Return the next field order for current object ID

  • return: of CMS_object_fields
  • access: public
static array getFieldsNextOrder ()
Constructor __construct (line 74)

Constructor.

initialize object.

  • access: public
void __construct ([integer $id = 0], [array $dbValues = array()])
  • integer $id: DB id
  • array $dbValues: DB values
Redefinition of:
CMS_poly_object_definition::__construct()
Constructor.
asArray (line 416)

Get object field as an array structure used for export

  • return: : the object array structure
  • access: public
array asArray ([array $params = array()],  &$files, array $files)
  • array $params: The export parameters. Not used here
  • array $files: The reference to the founded files used by object
  • &$files
Redefinition of:
CMS_poly_object_definition::asArray()
Get object as an array structure used for export
convertDefinitions (line 572)

Convert all definitions used by this object from human format to Automne format.

This method is usually used at end of module import process, when all objects are imported

  • return: : true on success, false on failure
  • access: public
boolean convertDefinitions (CMS_module $module)
Redefinition of:
CMS_poly_object_definition::convertDefinitions()
Convert all definitions used by this object from human format to Automne format.
destroy (line 330)

Destroy this object, in DB and filesystem if needed Destroy title label also

  • return: true on success, false on failure
  • access: public
boolean destroy ()
Redefinition of:
CMS_poly_object_definition::destroy()
Destroy this object in DB
fromArray (line 466)

Import field from given array datas

  • return: : true on success, false on failure
  • access: public
boolean fromArray (array $data, array $params, CMS_language $cms_language,  &$idsRelation,  &$infos, array $idsRelation, string $infos)
  • array $data: The module datas to import
  • array $params: The import parameters. array( create => false|true : create missing objects (default : true) update => false|true : update existing objects (default : true) files => false|true : use files from PATH_TMP_FS (default : true) )
  • CMS_language $cms_language: The CMS_langage to use
  • array $idsRelation: : Reference : The relations between import datas ids and real imported ids
  • string $infos: : Reference : The import infos returned
  • &$idsRelation
  • &$infos
Redefinition of:
CMS_poly_object_definition::fromArray()
Import object from given array datas
getFieldDescription (line 186)

get admin field description if any

  • return: the label or false if none defined
  • access: public
string, getFieldDescription (mixed $language)
  • mixed $language: the language code (string) or the CMS_language (object) to use for label
getID (line 129)

Get field ID

  • return: the DB object ID
  • access: public
integer, getID ()
Redefinition of:
CMS_poly_object_definition::getID()
Get object ID
getObjectID (line 139)

Get object ID

  • return: the DB object ID
  • access: public
integer, getObjectID ()
getParameter (line 206)

get a parameter value for a given parameter internal name.

  • return: the parameter value
  • access: public
mixed, getParameter (string $internalName)
  • string $internalName: the parameter internal name
getTypeObject (line 217)

get an object instance of the field type

  • return: the object instance
  • access: public
mixed, getTypeObject ([ $returnDefinition = false], [ $public = false], boolean $returnDefinition,)
  • boolean $returnDefinition,: return object CMS_poly_object_definition or CMS_poly_object otherwise
  • $returnDefinition
  • $public
getValue (line 171)

get an object value.

  • return: the value
  • access: public
mixed, getValue (string $valueName)
  • string $valueName: the name of the value to get
Redefinition of:
CMS_poly_object_definition::getValue()
get an object value.
setValue (line 151)

Sets an object value.

  • return: true on success, false on failure
  • access: public
boolean setValue (string $valueName, mixed $value)
  • string $valueName: the name of the value to set
  • mixed $value: the value to set
Redefinition of:
CMS_poly_object_definition::setValue()
Sets an object value.
writeToPersistence (line 266)

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

  • return: true on success, false on failure
  • access: public
boolean writeToPersistence ()
Redefinition of:
CMS_poly_object_definition::writeToPersistence()
Writes object into persistence (MySQL for now), along with base data.

Inherited Methods

Inherited From CMS_poly_object_definition

CMS_poly_object_definition::__construct()
CMS_poly_object_definition::asArray()
CMS_poly_object_definition::compileDefinition()
CMS_poly_object_definition::convertDefinitions()
CMS_poly_object_definition::destroy()
CMS_poly_object_definition::fromArray()
CMS_poly_object_definition::getDescription()
CMS_poly_object_definition::getHTMLSubFieldsParameters()
CMS_poly_object_definition::getHTMLSubFieldsParametersSearch()
CMS_poly_object_definition::getID()
CMS_poly_object_definition::getLabel()
CMS_poly_object_definition::getObjectLabel()
CMS_poly_object_definition::getParamsValues()
CMS_poly_object_definition::getStructure()
CMS_poly_object_definition::getSubFieldParameters()
CMS_poly_object_definition::getValue()
CMS_poly_object_definition::hasCategories()
CMS_poly_object_definition::hasParameters()
CMS_poly_object_definition::isPrimaryResource()
CMS_poly_object_definition::isSecondaryResource()
CMS_poly_object_definition::loadParameters()
CMS_poly_object_definition::setUuid()
CMS_poly_object_definition::setValue()
CMS_poly_object_definition::treatParams()
CMS_poly_object_definition::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)

Inherited Constants

Inherited from CMS_poly_object_definition

CMS_poly_object_definition::MESSAGE_FIELD_NO
 CMS_poly_object_definition::MESSAGE_FIELD_YES
 CMS_poly_object_definition::MESSAGE_OBJECT_PARAMETER_LOADSUBOBJECTS
 CMS_poly_object_definition::MESSAGE_OBJECT_PARAMETER_LOADSUBOBJECTS_DESCRIPTION
 CMS_poly_object_definition::MESSAGE_OBJECT_PARAMETER_SEARCHEDOBJECTS

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
 CMS_grandFather::SYSTEM_LABEL

Documentation generated on Wed, 15 Feb 2012 15:37:32 +0100 by phpDocumentor 1.4.3