kernel/private/classes/ezcontentobjectstate.php

Show:

inherited

Classes
- \eZContentObjectState

Table of Contents

File containing the eZContentObjectState class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Package: kernel
Version: 4.6.0

\eZContentObjectState
jump to top

Package: kernel

Class representing a content object state

Parent(s): \eZPersistentObject
Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
Version: 4.6.0

Constants

 
                MAX_IDENTIFIER_LENGTH
                = 45

Properties


                 $AllTranslations= ''

Details

Type: n/a


                 $Defaults= 'null'

static

Default valuenullDetails

Type: n/a


                 $LanguageObject= ''

Details

Type: n/a


                 $PersistentDataDirty= ''

inheritedInherited from: \eZPersistentObject::$$PersistentDataDirty

Details

Type: n/a
Inherited_from: \eZPersistentObject::$$PersistentDataDirty


                 $Translations= ''

Details

Type: n/a

Methods

__construct(
           $row
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$row

allTranslations(
          
          )
        
        :
          array

Returns

Type	Description
array	an array of eZContentObjectStateLanguage objects, representing all possible translations of this content object state

attribute(
           $attr,  $noFunction
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::attribute()

Parameters

Name	Type	Description
$attr
$noFunction

attributes(
          
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::attributes()

availableLanguages(
          
          )
        
        :
          array

Returns

Type	Description
array	the languages the state exists in, as an array with language code strings.

cleanDefaultsCache(
          
          )
        
        :
          void

static

Cleans the cache used by {@link eZContentObjectState::defaults()}.

conditionText(
           $conditions
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::conditionText()

Parameters

Name	Type	Description
$conditions

conditionTextByRow(
           $conditions,  $row
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::conditionTextByRow()

Parameters

Name	Type	Description
$conditions
$row

count(
           $def,  $conds
              =
              null,  $field
              =
              null
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::count()

Parameters

Name	Type	Description
$def
$conds
$field

currentTranslation(
          
          )
        
        :
          \eZContentObjectStateLanguage

Return the current translation of the content object state

Returns

Type	Description
\eZContentObjectStateLanguage

defaultLanguage(
          
          )
        
        :
          int

Returns

Type	Description
int	the numerical ID of the default language

defaults(
          
          )
        
        :
          array

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 {@link eZContentObjectState::cleanDefaultsCache()}.

Returns

Type	Description
array	an array of all default content object states

definition(
          
          )
        
        :
          void

static

eZPersistentObject(
           $row
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::eZPersistentObject()

Parameters

Name	Type	Description
$row

escapeArray(
           $array
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::escapeArray()

Parameters

Name	Type	Description
$array

fetchByConditions(
           $conditions,  $limit,  $offset
          )
        
        :
          array

static

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

Name	Type	Description
$conditions
$limit
$offset

Returns

Type	Description
array

fetchByGroup(
          integer $groupID, integer $limit
              =
              false,  $offset
              =
              false
          )
        
        :
          array

static

Fetches all content object states of a content object state group

Parameters

Name	Type	Description
$groupID	integer
$limit	integer
$offset

Returns

Type	Description
array

fetchById(
          integer $id
          )
        
        :
          \eZContentObjectState | boolean

static

Fetches a content object state by its numerical ID.

Parameters

Name	Type	Description
$id	integer	the numerical ID of the content object state

Returns

Type	Description
\eZContentObjectState \| boolean	an instance of eZContentObjectState, or false if the requested state does not exist

fetchByIdentifier(
          string $identifier, integer $groupID
          )
        
        :
          \eZContentObjectState | boolean

static

Fetches a content object state by its identifier and group ID

Parameters

Name	Type	Description
$identifier	string	the identifier of the content object state, which is unique per content object state group
$groupID	integer	the numerical ID of the content object state group

Returns

Type	Description
\eZContentObjectState \| boolean	an instance of eZContentObjectState, or false if the requested state does not exist

fetchHTTPPersistentVariables(
          
          )
        
        :
          void

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

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

Details

See: \eZHTTPPersistence

fetchObject(
           $def,  $field_filters,  $conds,  $asObject
              =
              true,  $grouping
              =
              null,  $custom_fields
              =
              null
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::fetchObject()

Parameters

Name	Type	Description
$def
$field_filters
$conds
$asObject
$grouping
$custom_fields

fetchObjectList(
           $def,  $field_filters
              =
              null,  $conds
              =
              null,  $sorts
              =
              null,  $limit
              =
              null,  $asObject
              =
              true,  $grouping
              =
              false,  $custom_fields
              =
              null,  $custom_tables
              =
              null,  $custom_conds
              =
              null
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::fetchObjectList()

Parameters

Name	Type	Description
$def
$field_filters
$conds
$sorts
$limit
$asObject
$grouping
$custom_fields
$custom_tables
$custom_conds

fill(
           $row
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::fill()

Parameters

Name	Type	Description
$row

getShortAttributeName(
           $db,  $def,  $attrName
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::getShortAttributeName()

Parameters

Name	Type	Description
$db
$def
$attrName

handleRows(
           $rows,  $class_name,  $asObject
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::handleRows()

Parameters

Name	Type	Description
$rows
$class_name
$asObject

hasAttribute(
           $attr
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::hasAttribute()

Parameters

Name	Type	Description
$attr

hasDirtyData(
          
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::hasDirtyData()

isValid(
          array $messages
              =
              array()
          )
        
        :
          boolean

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

Parameters

Name	Type	Description
$messages	array	&$messages

Returns

Type	Description
boolean	true when valid, false when not valid

Details

See: \eZContentObjectState::store()

languages(
          
          )
        
        :
          array

Retrieves the languages this content object state is translated into

Returns

Type	Description
array	an array of eZContentLanguage instances

limitationList(
          
          )
        
        :
          array

static

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

Returns

Type	Description
array

newObjectOrder(
           $def,  $orderField,  $conditions
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::newObjectOrder()

Parameters

Name	Type	Description
$def
$orderField
$conditions

objectCount(
          
          )
        
        :
          integer

Returns

Type	Description
integer	The count of objects that have this content object state

remove(
           $conditions
              =
              null,  $extraConditions
              =
              null
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::remove()

Parameters

Name	Type	Description
$conditions
$extraConditions

removeByID(
          integer $id
          )
        
        :
          void

static

Removes a content object state by its numerical ID

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

Parameters

Name	Type	Description
$id	integer	the numerical ID of the content object state

removeObject(
           $def,  $conditions
              =
              null,  $extraConditions
              =
              null
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::removeObject()

Parameters

Name	Type	Description
$def
$conditions
$extraConditions

reorderObject(
           $def,  $orderField,  $conditions,  $down
              =
              true
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::reorderObject()

Parameters

Name	Type	Description
$def
$orderField
$conditions
$down

replaceFieldsWithShortNames(
           $db,  $fieldDefs,  $fields
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::replaceFieldsWithShortNames()

Parameters

Name	Type	Description
$db
$fieldDefs
$fields

setAttribute(
           $attr,  $val
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::setAttribute()

Parameters

Name	Type	Description
$attr
$val

setCurrentLanguage(
          string $locale
          )
        
        :
          boolean

Sets the current language

Parameters

Name	Type	Description
$locale	string	the locale code

Returns

Type	Description
boolean	true if the language was found and set, false if the language was not found

setHasDirtyData(
           $hasDirtyData
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::setHasDirtyData()

Parameters

Name	Type	Description
$hasDirtyData

setLanguageObject(
          \eZContentObjectStateLanguage $stateLanguage
          )
        
        :
          void

Parameters

Name	Type	Description
$stateLanguage	\eZContentObjectStateLanguage

store(
          array $fieldFilters
              =
              null
          )
        
        :
          void

Stores the content object state and its translations.

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

Parameters

Name	Type	Description
$fieldFilters	array

storeObject(
           $obj,  $fieldFilters
              =
              null
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::storeObject()

Parameters

Name	Type	Description
$obj
$fieldFilters

swapRow(
           $table,  $keys,  $order_id,  $rows,  $id1,  $id2
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::swapRow()

Parameters

Name	Type	Description
$table
$keys
$order_id
$rows
$id1
$id2

sync(
           $fieldFilters
              =
              null
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::sync()

Parameters

Name	Type	Description
$fieldFilters

translationByLocale(
           $locale
          )
        
        :
          void

Parameters

Name	Type	Description
$locale

translations(
          
          )
        
        :
          \an

Returns

Type	Description
\an	array of eZContentObjectStateLanguage objects, representing all available translations of this content object state

updateObjectList(
           $parameters
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::updateObjectList()

Parameters

Name	Type	Description
$parameters

kernel/private/classes/ezcontentobjectstate.php

\eZContentObjectStatejump to top

Constants

Properties

Methods

\eZContentObjectState
jump to top