eZPublishCommunityProject(LegacyStack)  2013.9
eZContentObjectStateGroup Class Reference
+ Inheritance diagram for eZContentObjectStateGroup:
+ Collaboration diagram for eZContentObjectStateGroup:

Public Member Functions

 __construct ($row=array())
 
 allTranslations ()
 
 availableLanguages ()
 Get the languages the state group exists in. More...
 
 currentTranslation ()
 
 defaultLanguage ()
 
 fetchHTTPPersistentVariables ()
 Fetches the HTTP persistent variables for this content object state group and its localizations. More...
 
 isInternal ()
 
 isValid (&$messages=array())
 Checks if all data is valid and can be stored to the database. More...
 
 languages ()
 Get the languages the state group exists in. More...
 
 newState ($identifier=null)
 Creates a new content object state in this content object state group. More...
 
 removeStatesByID ($idList)
 
 reorderStates ($stateIDList)
 
 setCurrentLanguage ($locale)
 
 stateByIdentifier ($stateIdentifier)
 
 states ($refreshMemberVariable=false)
 
 store ($fieldFilters=null)
 Stores the content object state group and its translations. More...
 
 translationByLocale ($locale)
 
 translations ()
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 Returns the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched. More...
 
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...
 

Static Public Member Functions

static definition ()
 
static fetchById ($id)
 Fetches a content object state group by its numerical ID. More...
 
static fetchByIdentifier ($identifier)
 Fetches a content object state group by its identifier. More...
 
static fetchByOffset ($limit, $offset)
 
static limitations ()
 Returns an array of limitations useable by the policy system. More...
 
static limitationValues ($groupID)
 Returns an array of limitation values useable by the policy system. More...
 
static removeByID ($id)
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 Calls conditionTextByRow with an empty row and $conditions. More...
 
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
 
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
 
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
 
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
 
static fetchObjectList ($def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null, $custom_tables=null, $custom_conds=null)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
 
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
 
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
 
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
 
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
 
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
 
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...
 

Public Attributes

const MAX_IDENTIFIER_LENGTH = 45
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

Static Public Attributes

static $allowInternalCUD = false
 

Private Member Functions

 setLanguageObject (eZContentObjectStateGroupLanguage $stateGroupLanguage)
 

Static Private Member Functions

static fetchByConditions ($conditions, $limit, $offset)
 Fetches content object state groups by certain conditions. More...
 

Private Attributes

 $AllTranslations
 
 $LanguageObject
 
 $States
 
 $Translations
 

Constructor & Destructor Documentation

eZContentObjectStateGroup::__construct (   $row = array())

Member Function Documentation

eZContentObjectStateGroup::allTranslations ( )
Returns
array

Referenced by fetchHTTPPersistentVariables(), and translationByLocale().

eZContentObjectStateGroup::availableLanguages ( )

Get the languages the state group exists in.

Returns
array an array of language code strings.
eZContentObjectStateGroup::currentTranslation ( )
eZContentObjectStateGroup::defaultLanguage ( )
static eZContentObjectStateGroup::definition ( )
static
static eZContentObjectStateGroup::fetchByConditions (   $conditions,
  $limit,
  $offset 
)
staticprivate

Fetches content object state groups by certain conditions.

Parameters
array$conditions
integer$limit
integer$offset
Returns
array
static eZContentObjectStateGroup::fetchById (   $id)
static

Fetches a content object state group by its numerical ID.

Parameters
integer$id
Returns
eZContentObjectStateGroup|boolean

Referenced by eZContentObjectState\group().

static eZContentObjectStateGroup::fetchByIdentifier (   $identifier)
static

Fetches a content object state group by its identifier.

Parameters
string$identifier
Returns
eZContentObjectStateGroup|boolean

Referenced by eZContentObjectTreeNode\createSortingSQLStrings().

static eZContentObjectStateGroup::fetchByOffset (   $limit,
  $offset 
)
static
Parameters
int$limit
int$offset
Returns
array

Referenced by eZContentObject\allowedAssignStateList().

eZContentObjectStateGroup::fetchHTTPPersistentVariables ( )

Fetches the HTTP persistent variables for this content object state group and its localizations.

"ContentObjectStateGroup" is used as base name for the persistent variables.

See Also
eZHTTPPersistence
eZContentObjectStateGroup::isInternal ( )
eZContentObjectStateGroup::isValid ( $messages = array())

Checks if all data is valid and can be stored to the database.

Parameters
array&$messages
Returns
boolean true when valid, false when not valid
See Also
eZContentObjectStateGroup::store()
eZContentObjectStateGroup::languages ( )

Get the languages the state group exists in.

Returns
array an array of eZContentLanguage instances

Referenced by availableLanguages().

static eZContentObjectStateGroup::limitations ( )
static

Returns an array of limitations useable by the policy system.

Returns
array
static eZContentObjectStateGroup::limitationValues (   $groupID)
static

Returns an array of limitation values useable by the policy system.

Parameters
integer$groupID
Returns
array
eZContentObjectStateGroup::newState (   $identifier = null)

Creates a new content object state in this content object state group.

Parameters
string$identifieridentifier for the new state group
Returns
eZContentObjectState the new content object state
static eZContentObjectStateGroup::removeByID (   $id)
static
Parameters
integer$id
eZContentObjectStateGroup::removeStatesByID (   $idList)
Parameters
array$idList
eZContentObjectStateGroup::reorderStates (   $stateIDList)
Parameters
array$stateIDList
Returns
boolean
eZContentObjectStateGroup::setCurrentLanguage (   $locale)
Parameters
string$locale
Returns
boolean
eZContentObjectStateGroup::setLanguageObject ( eZContentObjectStateGroupLanguage  $stateGroupLanguage)
private
Parameters
eZContentObjectStateGroupLanguage$stateGroupLanguage

Referenced by setCurrentLanguage().

eZContentObjectStateGroup::stateByIdentifier (   $stateIdentifier)
eZContentObjectStateGroup::states (   $refreshMemberVariable = false)
Parameters
boolean$refreshMemberVariable
Returns
array

Referenced by removeStatesByID(), and reorderStates().

eZContentObjectStateGroup::store (   $fieldFilters = null)

Stores the content object state group and its translations.

Before storing a content object state group, you should use eZContentObjectStateGroup::isValid() to check its validness.

Parameters
array$fieldFilters
eZContentObjectStateGroup::translationByLocale (   $locale)
eZContentObjectStateGroup::translations ( )
Returns
array

Referenced by allTranslations(), and setCurrentLanguage().

Member Data Documentation

eZContentObjectStateGroup::$allowInternalCUD = false
static
eZContentObjectStateGroup::$AllTranslations
private

Referenced by allTranslations().

eZContentObjectStateGroup::$LanguageObject
private

Referenced by currentTranslation().

eZContentObjectStateGroup::$States
private

Referenced by states().

eZContentObjectStateGroup::$Translations
private

Referenced by translations().

const eZContentObjectStateGroup::MAX_IDENTIFIER_LENGTH = 45

The documentation for this class was generated from the following file: