Class CMS_poly_plugin_definitions

Description
Description | Methods (details) Constants

Class CMS_poly_plugin_definitions Represent a plugin definition for a poly_object

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

CMS_grandFather
   |
   --CMS_poly_plugin_definitions
Method Summary
Description | Constants Methods (details)
void __construct ([integer $id = 0], [array $dbValues = array()])
array asArray ([array $params = array()],  &$files, array $files)
boolean compileDefinition ()
boolean convertDefinitions (CMS_module $module)
boolean destroy ()
boolean fromArray (array $data, array $params, CMS_language $cms_language,  &$idsRelation,  &$infos, array $idsRelation, string $infos)
string, getDescription (mixed $language)
integer, getID ()
string, getLabel ([mixed $language = ''])
mixed, getValue (string $valueName)
boolean needSelection ()
boolean setValue (string $valueName, mixed $value)
boolean writeToPersistence ()
Methods
Description | Constants Methods (details)
Constructor __construct (line 59)

Constructor.

initialize object.

  • access: public
void __construct ([integer $id = 0], [array $dbValues = array()])
  • integer $id: DB id
  • array $dbValues: DB values
asArray (line 329)

Get plugin object 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
compileDefinition (line 216)

Compile the Plugin definition

  • return: true on success, false on failure
  • access: public
boolean compileDefinition ()
convertDefinitions (line 444)

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)
destroy (line 286)

Destroy this object in DB

  • return: true on success, false on failure
  • access: public
boolean destroy ()
fromArray (line 365)

Import plugin 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 plugin datas to import
  • array $params: The import parameters. array( module => false|true : the module to create plugin (required) 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
getDescription (line 188)

get object description

  • return: the description
  • access: public
string, getDescription (mixed $language)
  • mixed $language: the language code (string) or the CMS_language (object) to use for description
getID (line 108)

Get object ID

  • return: the DB object ID
  • access: public
integer, getID ()
getLabel (line 172)

get object label

  • return: the label
  • access: public
string, getLabel ([mixed $language = ''])
  • mixed $language: the language code (string) or the CMS_language (object) to use for label
getValue (line 156)

get an object value.

  • return: the value
  • access: public
mixed, getValue (string $valueName)
  • string $valueName: the name of the value to get
needSelection (line 203)

is this plugin need a selection

  • access: public
boolean needSelection ()
setValue (line 121)

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
writeToPersistence (line 232)

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
Description | Constants (details) | Methods (details)

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
 CMS_grandFather::SYSTEM_LABEL

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