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

Public Member Functions

 __construct ($row=array())
 
 allTranslations ()
 
 availableLanguages ()
 
 currentTranslation ()
 Return the current translation of the content object state. More...
 
 defaultLanguage ()
 
 fetchHTTPPersistentVariables ()
 Fetches the HTTP persistent variables for this content object state and its localizations. More...
 
 group ()
 
 isValid (&$messages=array())
 Checks if all data is valid and can be stored to the database. More...
 
 languages ()
 Retrieves the languages this content object state is translated into. More...
 
 objectCount ()
 
 setCurrentLanguage ($locale)
 Sets the current language. More...
 
 store ($fieldFilters=null)
 Stores the content object state 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 cleanDefaultsCache ()
 Cleans the cache used by eZContentObjectState::defaults(). More...
 
static defaults ()
 The defaults are cached in a static class variable, so subsequent calls to this method do not require queries to the database each time. More...
 
static definition ()
 
static fetchByGroup ($groupID, $limit=false, $offset=false)
 Fetches all content object states of a content object state group. More...
 
static fetchById ($id)
 Fetches a content object state by its numerical ID. More...
 
static fetchByIdentifier ($identifier, $groupID)
 Fetches a content object state by its identifier and group ID. More...
 
static limitationList ()
 Get the list of content object states that is used to create the object state limitation list in the policy/edit view. More...
 
static removeByID ($id)
 Removes a content object state by its numerical ID. More...
 
- 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
 

Private Member Functions

 setLanguageObject (eZContentObjectStateLanguage $stateLanguage)
 

Static Private Member Functions

static fetchByConditions ($conditions, $limit, $offset)
 Fetches content object states by conditions. More...
 

Private Attributes

 $AllTranslations
 
 $LanguageObject
 
 $Translations
 

Static Private Attributes

static $Defaults = null
 

Constructor & Destructor Documentation

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

Member Function Documentation

eZContentObjectState::allTranslations ( )
Returns
array an array of eZContentObjectStateLanguage objects, representing all possible translations of this content object state

Referenced by fetchHTTPPersistentVariables(), and translationByLocale().

eZContentObjectState::availableLanguages ( )
Returns
array the languages the state exists in, as an array with language code strings.
static eZContentObjectState::cleanDefaultsCache ( )
static
eZContentObjectState::currentTranslation ( )

Return the current translation of the content object state.

Returns
eZContentObjectStateLanguage
eZContentObjectState::defaultLanguage ( )
Returns
int the numerical ID of the default language
static eZContentObjectState::defaults ( )
static

The defaults are cached in a static class variable, so subsequent calls to this method do not require queries to the database each time.

To clear this cache use eZContentObjectState::cleanDefaultsCache().

Returns
array an array of all default content object states

Referenced by eZContentObject\assignDefaultStates().

static eZContentObjectState::definition ( )
static
static eZContentObjectState::fetchByConditions (   $conditions,
  $limit,
  $offset 
)
staticprivate

Fetches content object states by conditions.

The content object states are fetched in the right language, depending on the list of prioritized languages of the site access.

Parameters
$conditions
$limit
$offset
Returns
array
static eZContentObjectState::fetchByGroup (   $groupID,
  $limit = false,
  $offset = false 
)
static

Fetches all content object states of a content object state group.

Parameters
integer$groupID
integer$limit
integer$ofset
Returns
array

Referenced by eZContentObjectStateGroup\removeByID(), and eZContentObjectStateGroup\states().

static eZContentObjectState::fetchById (   $id)
static

Fetches a content object state by its numerical ID.

Parameters
integer$idthe numerical ID of the content object state
Returns
eZContentObjectState|boolean an instance of eZContentObjectState, or false if the requested state does not exist

Referenced by eZContentOperationCollection\updateObjectState().

static eZContentObjectState::fetchByIdentifier (   $identifier,
  $groupID 
)
static

Fetches a content object state by its identifier and group ID.

Parameters
string$identifierthe identifier of the content object state, which is unique per content object state group
integer$groupIDthe numerical ID of the content object state group
Returns
eZContentObjectState|boolean an instance of eZContentObjectState, or false if the requested state does not exist

Referenced by eZContentObjectStateGroup\stateByIdentifier().

eZContentObjectState::fetchHTTPPersistentVariables ( )

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

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

See Also
eZHTTPPersistence
eZContentObjectState::group ( )
eZContentObjectState::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
eZContentObjectState::store()
eZContentObjectState::languages ( )

Retrieves the languages this content object state is translated into.

Returns
array an array of eZContentLanguage instances

Referenced by availableLanguages().

static eZContentObjectState::limitationList ( )
static

Get the list of content object states that is used to create the object state limitation list in the policy/edit view.

Returns
array
eZContentObjectState::objectCount ( )
Returns
integer The count of objects that have this content object state
static eZContentObjectState::removeByID (   $id)
static

Removes a content object state by its numerical ID.

This method should not be used directly, instead use eZContentObjectStateGroup::removeStatesByID().

Parameters
integer$idthe numerical ID of the content object state

Referenced by eZContentObjectStateGroup\removeByID(), and eZContentObjectStateGroup\removeStatesByID().

eZContentObjectState::setCurrentLanguage (   $locale)

Sets the current language.

Parameters
string$localethe locale code
Returns
boolean true if the language was found and set, false if the language was not found
eZContentObjectState::setLanguageObject ( eZContentObjectStateLanguage  $stateLanguage)
private
Parameters
eZContentObjectStateLanguage$stateLanguage

Referenced by setCurrentLanguage().

eZContentObjectState::store (   $fieldFilters = null)

Stores the content object state and its translations.

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

Parameters
array$fieldFilters
eZContentObjectState::translationByLocale (   $locale)
eZContentObjectState::translations ( )
Returns
an array of eZContentObjectStateLanguage objects, representing all available translations of this content object state

Referenced by allTranslations(), and setCurrentLanguage().

Member Data Documentation

eZContentObjectState::$AllTranslations
private

Referenced by allTranslations().

eZContentObjectState::$Defaults = null
staticprivate
eZContentObjectState::$LanguageObject
private

Referenced by currentTranslation().

eZContentObjectState::$Translations
private

Referenced by translations().

const eZContentObjectState::MAX_IDENTIFIER_LENGTH = 45

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