eZPublishCommunityProject  2013.9
eZ\Publish\Core\FieldType\Page\PageService Class Reference
+ Inheritance diagram for eZ\Publish\Core\FieldType\Page\PageService:

Public Member Functions

 __construct (array $zoneDefinition=array(), array $blockDefinition=array())
 Constructor. More...
 
 getArchivedBlockItems (Block $block)
 Returns archived items (that were previously displayed), for a given block. More...
 
 getAvailableZoneLayouts ()
 Returns list of available zone layouts. More...
 
 getBlockDefinition ()
 Returns block definition as an array. More...
 
 getBlockDefinitionByIdentifier ($blockIdentifier)
 Returns a block definition for a given block identifier. More...
 
 getLastValidBlockItem (Block $block)
 Returns the last valid item, for a given block. More...
 
 getLayoutTemplate ($layoutIdentifier)
 Returns the template to use for given layout. More...
 
 getValidBlockItems (Block $block)
 Returns valid items (that are to be displayed), for a given block. More...
 
 getWaitingBlockItems (Block $block)
 Returns queued items (the next to be displayed), for a given block. More...
 
 getZoneDefinition ()
 Returns zone definition as an array. More...
 
 getZoneDefinitionByLayout ($layoutIdentifier)
 Returns a zone definition for a given layout. More...
 
 hasBlockDefinition ($blockIdentifier)
 Checks if block definition contains a block having $blockIdentifier as identifier. More...
 
 hasStorageGateway ()
 Checks if storage gateway has already been injected or not. More...
 
 hasZoneLayout ($layoutIdentifier)
 Checks if zone definition contains a layout having $layoutIdentifier as identifier. More...
 
 setStorageGateway (Gateway $storageGateway)
 Injects the storage gateway to interact with. More...
 

Protected Member Functions

 getStorageGateway ()
 

Protected Attributes

 $archivedBlockItems
 
 $blockDefinition
 
 $lastValidItems
 
 $storageGateway
 
 $validBlockItems
 
 $waitingBlockItems
 
 $zoneDefinition
 

Constructor & Destructor Documentation

eZ\Publish\Core\FieldType\Page\PageService::__construct ( array  $zoneDefinition = array(),
array  $blockDefinition = array() 
)

Constructor.

Parameters
array$zoneDefinition
array$blockDefinition

Member Function Documentation

eZ\Publish\Core\FieldType\Page\PageService::getArchivedBlockItems ( Block  $block)

Returns archived items (that were previously displayed), for a given block.

Parameters
\eZ\Publish\Core\FieldType\Page\Parts\Block$block
Returns
[]
eZ\Publish\Core\FieldType\Page\PageService::getAvailableZoneLayouts ( )

Returns list of available zone layouts.

Returns
array
eZ\Publish\Core\FieldType\Page\PageService::getBlockDefinition ( )

Returns block definition as an array.

Returns
array
eZ\Publish\Core\FieldType\Page\PageService::getBlockDefinitionByIdentifier (   $blockIdentifier)

Returns a block definition for a given block identifier.

Parameters
string$blockIdentifier
Returns
array
Exceptions
\OutOfBoundsExceptionIf $blockIdentifier is invalid.
eZ\Publish\Core\FieldType\Page\PageService::getLastValidBlockItem ( Block  $block)

Returns the last valid item, for a given block.

Parameters
\eZ\Publish\Core\FieldType\Page\Parts\Block$block
Returns
|null
eZ\Publish\Core\FieldType\Page\PageService::getLayoutTemplate (   $layoutIdentifier)

Returns the template to use for given layout.

Parameters
string$layoutIdentifier
Returns
string
eZ\Publish\Core\FieldType\Page\PageService::getValidBlockItems ( Block  $block)

Returns valid items (that are to be displayed), for a given block.

Parameters
\eZ\Publish\Core\FieldType\Page\Parts\Block$block
Returns
[]

Referenced by eZ\Bundle\EzPublishCoreBundle\FieldType\Page\PageService\getValidBlockItemsAsContentInfo().

eZ\Publish\Core\FieldType\Page\PageService::getWaitingBlockItems ( Block  $block)

Returns queued items (the next to be displayed), for a given block.

Parameters
\eZ\Publish\Core\FieldType\Page\Parts\Block$block
Returns
[]
eZ\Publish\Core\FieldType\Page\PageService::getZoneDefinition ( )

Returns zone definition as an array.

Returns
array
eZ\Publish\Core\FieldType\Page\PageService::getZoneDefinitionByLayout (   $layoutIdentifier)

Returns a zone definition for a given layout.

It consists of a configuration array for the given layout.

Parameters
string$layoutIdentifier
Returns
array
Exceptions
\OutOfBoundsExceptionIf $layoutIdentifier is invalid

Referenced by eZ\Publish\Core\FieldType\Page\PageService\getLayoutTemplate().

eZ\Publish\Core\FieldType\Page\PageService::hasBlockDefinition (   $blockIdentifier)

Checks if block definition contains a block having $blockIdentifier as identifier.

Parameters
string$blockIdentifier
Returns
bool
eZ\Publish\Core\FieldType\Page\PageService::hasStorageGateway ( )

Checks if storage gateway has already been injected or not.

Returns
bool

Referenced by eZ\Publish\Core\FieldType\Page\PageService\getStorageGateway().

eZ\Publish\Core\FieldType\Page\PageService::hasZoneLayout (   $layoutIdentifier)

Checks if zone definition contains a layout having $layoutIdentifier as identifier.

Parameters
string$layoutIdentifier
Returns
bool
eZ\Publish\Core\FieldType\Page\PageService::setStorageGateway ( Gateway  $storageGateway)

Injects the storage gateway to interact with.

Parameters
\eZ\Publish\Core\FieldType\Page\PageStorage\Gateway$storageGateway

Member Data Documentation

eZ\Publish\Core\FieldType\Page\PageService::$archivedBlockItems
protected
eZ\Publish\Core\FieldType\Page\PageService::$blockDefinition
protected
eZ\Publish\Core\FieldType\Page\PageService::$lastValidItems
protected
eZ\Publish\Core\FieldType\Page\PageService::$storageGateway
protected
eZ\Publish\Core\FieldType\Page\PageService::$validBlockItems
protected
eZ\Publish\Core\FieldType\Page\PageService::$waitingBlockItems
protected
eZ\Publish\Core\FieldType\Page\PageService::$zoneDefinition
protected

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