kernel/private/classes/ezcontentobjectstategroup.php

Show:

inherited

Classes
- \eZContentObjectStateGroup

Table of Contents

File containing the eZContentObjectStateGroup 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

\eZContentObjectStateGroup
jump to top

Package: kernel

Class respresenting a content object state group

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


                 $LanguageObject= ''

Details

Type: n/a


                 $PersistentDataDirty= ''

inheritedInherited from: \eZPersistentObject::$$PersistentDataDirty

Details

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


                 $States= ''

Details

Type: n/a


                 $Translations= ''

Details

Type: n/a

boolean
                 $allowInternalCUD= 'false'

static

flag which specifies if it is allowed to create, update or delete internal state groups and their states

Default valuefalseDetails

Type: boolean

Methods

__construct(
           $row
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$row

allTranslations(
          
          )
        
        :
          array

Returns

Type	Description
array

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

Get the languages the state group exists in.

Returns

Type	Description
array	an array of language code strings.

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(
          
          )
        
        :
          \eZContentObjectStateGroupLanguage

Returns

Type	Description
\eZContentObjectStateGroupLanguage

defaultLanguage(
          
          )
        
        :
          \eZContentLanguage

Returns

Type	Description
\eZContentLanguage

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(
          array $conditions, integer $limit, integer $offset
          )
        
        :
          array

static

Fetches content object state groups by certain conditions

Parameters

Name	Type	Description
$conditions	array
$limit	integer
$offset	integer

Returns

Type	Description
array

fetchById(
          integer $id
          )
        
        :
          \eZContentObjectStateGroup | boolean

static

Fetches a content object state group by its numerical ID

Parameters

Name	Type	Description
$id	integer

Returns

Type	Description
\eZContentObjectStateGroup \| boolean

fetchByIdentifier(
          string $identifier
          )
        
        :
          \eZContentObjectStateGroup | boolean

static

Fetches a content object state group by its identifier

Parameters

Name	Type	Description
$identifier	string

Returns

Type	Description
\eZContentObjectStateGroup \| boolean

fetchByOffset(
          int $limit, int $offset
          )
        
        :
          array

static

Parameters

Name	Type	Description
$limit	int
$offset	int

Returns

Type	Description
array

fetchHTTPPersistentVariables(
          
          )
        
        :
          void

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

"ContentObjectStateGroup" 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()

isInternal(
          
          )
        
        :
          void

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: \eZContentObjectStateGroup::store()

languages(
          
          )
        
        :
          array

Get the languages the state group exists in.

Returns

Type	Description
array	an array of eZContentLanguage instances

limitationValues(
          integer $groupID
          )
        
        :
          array

static

Returns an array of limitation values useable by the policy system

Parameters

Name	Type	Description
$groupID	integer

Returns

Type	Description
array

limitations(
          
          )
        
        :
          array

static

Returns an array of limitations useable by the policy system

Returns

Type	Description
array

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

staticinherited

Inherited from: \eZPersistentObject::newObjectOrder()

Parameters

Name	Type	Description
$def
$orderField
$conditions

newState(
          string $identifier
              =
              null
          )
        
        :
          \eZContentObjectState

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

Parameters

Name	Type	Description
$identifier	string	identifier for the new state group

Returns

Type	Description
\eZContentObjectState	the new 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

Parameters

Name	Type	Description
$id	integer

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

staticinherited

Inherited from: \eZPersistentObject::removeObject()

Parameters

Name	Type	Description
$def
$conditions
$extraConditions

removeStatesByID(
          array $idList
          )
        
        :
          void

Parameters

Name	Type	Description
$idList	array

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

staticinherited

Inherited from: \eZPersistentObject::reorderObject()

Parameters

Name	Type	Description
$def
$orderField
$conditions
$down

reorderStates(
          array $stateIDList
          )
        
        :
          boolean

Parameters

Name	Type	Description
$stateIDList	array

Returns

Type	Description
boolean

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

Parameters

Name	Type	Description
$locale	string

Returns

Type	Description
boolean

setHasDirtyData(
           $hasDirtyData
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::setHasDirtyData()

Parameters

Name	Type	Description
$hasDirtyData

setLanguageObject(
          \eZContentObjectStateGroupLanguage $stateGroupLanguage
          )
        
        :
          void

Parameters

Name	Type	Description
$stateGroupLanguage	\eZContentObjectStateGroupLanguage

stateByIdentifier(
           $stateIdentifier
          )
        
        :
          void

Parameters

Name	Type	Description
$stateIdentifier

states(
          boolean $refreshMemberVariable
              =
              false
          )
        
        :
          array

Parameters

Name	Type	Description
$refreshMemberVariable	boolean

Returns

Type	Description
array

store(
          array $fieldFilters
              =
              null
          )
        
        :
          void

Stores the content object state group and its translations.

Before storing a content object state group, you should use {@link eZContentObjectStateGroup::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(
          
          )
        
        :
          array

Returns

Type	Description
array

updateObjectList(
           $parameters
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::updateObjectList()

Parameters

Name	Type	Description
$parameters

kernel/private/classes/ezcontentobjectstategroup.php

\eZContentObjectStateGroupjump to top

Constants

Properties

Methods

\eZContentObjectStateGroup
jump to top