PHP 클래스 eZ\Publish\Core\FieldType\Page\PageService

파일 보기 프로젝트 열기: ezsystems/ezpublish-kernel 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$archivedBlockItems SplObjectStorage Cached archived block items by block.
$blockDefinition array Block definition set in YAML config.
$blocksById eZ\Publish\Core\FieldType\Page\Parts\Block[] Cached Blocks by id.
$contentService eZ\Publish\API\Repository\ContentService
$lastValidItems SplObjectStorage Cached last valid items, by block (one per block).
$storageGateway eZ\Publish\Core\FieldType\Page\PageStorage\Gateway
$validBlockItems SplObjectStorage Cached valid block items by block.
$waitingBlockItems SplObjectStorage Cached waiting block items by block.
$zoneDefinition array Zone definition set in YAML config.

공개 메소드들

메소드 설명
__construct ( eZ\Publish\API\Repository\ContentService $contentService, array $zoneDefinition = [], array $blockDefinition = [] ) Constructor.
getArchivedBlockItems ( Block $block ) : Item[] Returns archived items (that were previously displayed), for a given block.
getAvailableZoneLayouts ( ) : array Returns list of available zone layouts.
getBlockDefinition ( ) : array Returns block definition as an array.
getBlockDefinitionByIdentifier ( string $blockIdentifier ) : array Returns a block definition for a given block identifier.
getLastValidBlockItem ( Block $block ) : Item | null Returns the last valid item, for a given block.
getLayoutTemplate ( string $layoutIdentifier ) : string Returns the template to use for given layout.
getValidBlockItems ( Block $block ) : Item[] Returns valid items (that are to be displayed), for a given block.
getWaitingBlockItems ( Block $block ) : Item[] Returns queued items (the next to be displayed), for a given block.
getZoneDefinition ( ) : array Returns zone definition as an array.
getZoneDefinitionByLayout ( string $layoutIdentifier ) : array Returns a zone definition for a given layout.
hasBlockDefinition ( string $blockIdentifier ) : boolean Checks if block definition contains a block having $blockIdentifier as identifier.
hasStorageGateway ( ) : boolean Checks if storage gateway has already been injected or not.
hasZoneLayout ( string $layoutIdentifier ) : boolean Checks if zone definition contains a layout having $layoutIdentifier as identifier.
loadBlock ( integer | string $id ) : Block Loads Block object for the given $id.
setStorageGateway ( Gateway $storageGateway ) Injects the storage gateway to interact with.

보호된 메소드들

메소드 설명
getStorageGateway ( ) : Gateway

메소드 상세

__construct() 공개 메소드

Constructor.
public __construct ( eZ\Publish\API\Repository\ContentService $contentService, array $zoneDefinition = [], array $blockDefinition = [] )
$contentService eZ\Publish\API\Repository\ContentService
$zoneDefinition array
$blockDefinition array

getArchivedBlockItems() 공개 메소드

Returns archived items (that were previously displayed), for a given block.
public getArchivedBlockItems ( Block $block ) : Item[]
$block eZ\Publish\Core\FieldType\Page\Parts\Block
리턴 eZ\Publish\Core\FieldType\Page\Parts\Item[]

getAvailableZoneLayouts() 공개 메소드

Returns list of available zone layouts.
public getAvailableZoneLayouts ( ) : array
리턴 array

getBlockDefinition() 공개 메소드

Returns block definition as an array.
public getBlockDefinition ( ) : array
리턴 array

getBlockDefinitionByIdentifier() 공개 메소드

Returns a block definition for a given block identifier.
public getBlockDefinitionByIdentifier ( string $blockIdentifier ) : array
$blockIdentifier string
리턴 array

getLastValidBlockItem() 공개 메소드

Returns the last valid item, for a given block.
public getLastValidBlockItem ( Block $block ) : Item | null
$block eZ\Publish\Core\FieldType\Page\Parts\Block
리턴 eZ\Publish\Core\FieldType\Page\Parts\Item | null

getLayoutTemplate() 공개 메소드

Returns the template to use for given layout.
public getLayoutTemplate ( string $layoutIdentifier ) : string
$layoutIdentifier string
리턴 string

getStorageGateway() 보호된 메소드

protected getStorageGateway ( ) : Gateway
리턴 eZ\Publish\Core\FieldType\Page\PageStorage\Gateway

getValidBlockItems() 공개 메소드

Returns valid items (that are to be displayed), for a given block.
public getValidBlockItems ( Block $block ) : Item[]
$block eZ\Publish\Core\FieldType\Page\Parts\Block
리턴 eZ\Publish\Core\FieldType\Page\Parts\Item[]

getWaitingBlockItems() 공개 메소드

Returns queued items (the next to be displayed), for a given block.
public getWaitingBlockItems ( Block $block ) : Item[]
$block eZ\Publish\Core\FieldType\Page\Parts\Block
리턴 eZ\Publish\Core\FieldType\Page\Parts\Item[]

getZoneDefinition() 공개 메소드

Returns zone definition as an array.
public getZoneDefinition ( ) : array
리턴 array

getZoneDefinitionByLayout() 공개 메소드

It consists of a configuration array for the given layout.
public getZoneDefinitionByLayout ( string $layoutIdentifier ) : array
$layoutIdentifier string
리턴 array

hasBlockDefinition() 공개 메소드

Checks if block definition contains a block having $blockIdentifier as identifier.
public hasBlockDefinition ( string $blockIdentifier ) : boolean
$blockIdentifier string
리턴 boolean

hasStorageGateway() 공개 메소드

Checks if storage gateway has already been injected or not.
public hasStorageGateway ( ) : boolean
리턴 boolean

hasZoneLayout() 공개 메소드

Checks if zone definition contains a layout having $layoutIdentifier as identifier.
public hasZoneLayout ( string $layoutIdentifier ) : boolean
$layoutIdentifier string
리턴 boolean

loadBlock() 공개 메소드

Loads Block object for the given $id.
public loadBlock ( integer | string $id ) : Block
$id integer | string
리턴 eZ\Publish\Core\FieldType\Page\Parts\Block

setStorageGateway() 공개 메소드

Injects the storage gateway to interact with.
public setStorageGateway ( Gateway $storageGateway )
$storageGateway eZ\Publish\Core\FieldType\Page\PageStorage\Gateway

프로퍼티 상세

$archivedBlockItems 보호되어 있는 프로퍼티

Cached archived block items by block.
protected SplObjectStorage $archivedBlockItems
리턴 SplObjectStorage

$blockDefinition 보호되어 있는 프로퍼티

Block definition set in YAML config.
protected array $blockDefinition
리턴 array

$blocksById 보호되어 있는 프로퍼티

Cached Blocks by id.
protected Block[],eZ\Publish\Core\FieldType\Page\Parts $blocksById
리턴 eZ\Publish\Core\FieldType\Page\Parts\Block[]

$contentService 보호되어 있는 프로퍼티

protected ContentService,eZ\Publish\API\Repository $contentService
리턴 eZ\Publish\API\Repository\ContentService

$lastValidItems 보호되어 있는 프로퍼티

Cached last valid items, by block (one per block).
protected SplObjectStorage $lastValidItems
리턴 SplObjectStorage

$storageGateway 보호되어 있는 프로퍼티

protected Gateway,eZ\Publish\Core\FieldType\Page\PageStorage $storageGateway
리턴 eZ\Publish\Core\FieldType\Page\PageStorage\Gateway

$validBlockItems 보호되어 있는 프로퍼티

Cached valid block items by block.
protected SplObjectStorage $validBlockItems
리턴 SplObjectStorage

$waitingBlockItems 보호되어 있는 프로퍼티

Cached waiting block items by block.
protected SplObjectStorage $waitingBlockItems
리턴 SplObjectStorage

$zoneDefinition 보호되어 있는 프로퍼티

Zone definition set in YAML config.
protected array $zoneDefinition
리턴 array