Class CMS_subobject_common

Description
Description | Descendents | Methods (details) Constants

Class CMS_subobject_common

represent common stuff for CMS_subobject_{type}

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

CMS_grandFather
   |
   --CMS_subobject_common
Direct descendents
Description | Descendents | Methods (details) Constants
Class Description
class CMS_subobject_text Class CMS_subobject_text
class CMS_subobject_integer Class CMS_subobject_integer
class CMS_subobject_string Class CMS_subobject_string
class CMS_subobject_date Class CMS_subobject_date
Method Summary
Description | Descendants | Constants Methods (details)
void __construct ([integer $id = 0], [array $objectIDs = array()], [array $dbValues = array()], [boolean $public = false])
boolean destroy ()
integer getID ()
integer getObjectFieldID ()
integer getObjectID ()
integer getObjectSubFieldID ()
string getTableName ()
string getValue ()
boolean setDefinition (integer $fieldDefinition)
boolean setObjectFieldID ( $objectFieldID, integer $objectUniqueID)
boolean setObjectID (integer $objectID)
boolean setObjectSubFieldID ( $objectSubFieldID, integer $objectUniqueID)
boolean writeToPersistence ()
Methods
Description | Descendents | Constants Methods (details)
Constructor __construct (line 96)

Constructor.

initialize object.

  • access: public
void __construct ([integer $id = 0], [array $objectIDs = array()], [array $dbValues = array()], [boolean $public = false])
  • integer $id: DB id
  • array $objectIDs: DB object values : array('objectID' => integer, 'objectFieldID' => integer, 'objectSubFieldID' => integer)
  • array $dbValues: DB values array('string dbFieldName' => 'value')
  • boolean $public: values are public or edited ? (default is edited)
Redefined in descendants as:
destroy (line 352)

Destroy this object, in DB and filesystem if needed

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

Gets the DB ID of the instance.

  • return: the DB id
  • access: public
integer getID ()
getObjectFieldID (line 194)

Gets the DB object field ID of the instance.

  • return: the DB object field id
  • access: public
integer getObjectFieldID ()
getObjectID (line 183)

Gets the DB object ID of the instance.

  • return: the DB object id
  • access: public
integer getObjectID ()
getObjectSubFieldID (line 205)

Gets the DB object subfield ID of the instance.

  • return: the DB object subfield id
  • access: public
integer getObjectSubFieldID ()
getTableName (line 283)

Gets the current DB table name

  • return: the DB table name
  • access: public
string getTableName ()
getValue (line 294)

Gets the string value.

  • return: the string value
  • access: public
string getValue ()
Redefined in descendants as:
setDefinition (line 268)

Sets the DB object definitions (objectID, fieldID, subFieldID).

  • return: true on success, false on failure
  • access: public
boolean setDefinition (integer $fieldDefinition)
  • integer $fieldDefinition: the DB object definition array("objectID" => integer, "fieldID" => integer, "subFieldID" => integer)
setObjectFieldID (line 234)

Sets the DB object Unique ID of the instance.

  • return: true on success, false on failure
  • access: public
boolean setObjectFieldID ( $objectFieldID, integer $objectUniqueID)
  • integer $objectUniqueID: the DB object Unique id to set
  • $objectFieldID
setObjectID (line 217)

Sets the DB object ID of the instance.

  • return: true on success, false on failure
  • access: public
boolean setObjectID (integer $objectID)
  • integer $objectID: the DB object id to set
setObjectSubFieldID (line 251)

Sets the DB object Unique ID of the instance.

  • return: true on success, false on failure
  • access: public
boolean setObjectSubFieldID ( $objectSubFieldID, integer $objectUniqueID)
  • integer $objectUniqueID: the DB object Unique id to set
  • $objectSubFieldID
writeToPersistence (line 305)

Writes the subobject 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 | Descendants | 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:39:42 +0100 by phpDocumentor 1.4.3