PHP Класс Pimcore\Model\Document\Tag\Block

Наследование: extends Pimcore\Model\Document\Tag
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$current integer Current step of the block while iteration
$indices array Contains an array of indices, which represent the order of the elements in the block
$suffixes string[]

Открытые методы

Метод Описание
__wakeup ( ) : void If object was serialized, set the counter back to 0
admin ( )
blockConstruct ( )
blockDestruct ( )
blockEnd ( ) : void Is called evertime a new iteration ends (new entry of the block while looping)
blockStart ( ) : void Is called evertime a new iteration starts (new entry of the block while looping)
end ( ) : void Is executed at the end of the loop and removes the settings set in start()
enumerate ( ) : boolean Alias for loop
frontend ( )
getCount ( ) : integer Return the amount of block elements
getCurrent ( ) : integer Return current iteration step
getCurrentIndex ( ) : integer Return current index
getData ( ) : mixed
getElements ( ) : Pimcore\Model\Document\Tag\Block\Item[]
getFromWebserviceImport ( Pimcore\Model\Webservice\Data\Document\Element $wsElement, $document = null, mixed $params = [], null $idMapper = null )
getType ( ) : string
isEmpty ( ) : boolean
loop ( ) : boolean Loops through the block
outputEditmode ( string $v ) : void Sends data to the output stream
setDataFromEditmode ( mixed $data )
setDataFromResource ( mixed $data )
setDefault ( )
setOptions ( array $options )
setupStaticEnvironment ( ) : void Setup some settings that are needed for blocks
start ( ) Is executed at the beginning of the loop and setup some general settings

Описание методов

__wakeup() публичный Метод

If object was serialized, set the counter back to 0
public __wakeup ( ) : void
Результат void

admin() публичный Метод

См. также: Document\Tag\TagInterface::admin
public admin ( )

blockConstruct() публичный Метод

public blockConstruct ( )

blockDestruct() публичный Метод

public blockDestruct ( )

blockEnd() публичный Метод

Is called evertime a new iteration ends (new entry of the block while looping)
public blockEnd ( ) : void
Результат void

blockStart() публичный Метод

Is called evertime a new iteration starts (new entry of the block while looping)
public blockStart ( ) : void
Результат void

end() публичный Метод

Is executed at the end of the loop and removes the settings set in start()
public end ( ) : void
Результат void

enumerate() публичный Метод

Alias for loop
См. также: loop()
Устаревший:
public enumerate ( ) : boolean
Результат boolean

frontend() публичный Метод

См. также: Document\Tag\TagInterface::frontend
public frontend ( )

getCount() публичный Метод

Return the amount of block elements
public getCount ( ) : integer
Результат integer

getCurrent() публичный Метод

Return current iteration step
public getCurrent ( ) : integer
Результат integer

getCurrentIndex() публичный Метод

Return current index
public getCurrentIndex ( ) : integer
Результат integer

getData() публичный Метод

См. также: Document\Tag\TagInterface::getData
public getData ( ) : mixed
Результат mixed

getElements() публичный Метод

public getElements ( ) : Pimcore\Model\Document\Tag\Block\Item[]
Результат Pimcore\Model\Document\Tag\Block\Item[]

getFromWebserviceImport() публичный Метод

public getFromWebserviceImport ( Pimcore\Model\Webservice\Data\Document\Element $wsElement, $document = null, mixed $params = [], null $idMapper = null )
$wsElement Pimcore\Model\Webservice\Data\Document\Element
$params mixed
$idMapper null

getType() публичный Метод

См. также: Document\Tag\TagInterface::getType
public getType ( ) : string
Результат string

isEmpty() публичный Метод

public isEmpty ( ) : boolean
Результат boolean

loop() публичный Метод

Loops through the block
public loop ( ) : boolean
Результат boolean

outputEditmode() публичный Метод

Sends data to the output stream
public outputEditmode ( string $v ) : void
$v string
Результат void

setDataFromEditmode() публичный Метод

См. также: Document\Tag\TagInterface::setDataFromEditmode
public setDataFromEditmode ( mixed $data )
$data mixed

setDataFromResource() публичный Метод

См. также: Document\Tag\TagInterface::setDataFromResource
public setDataFromResource ( mixed $data )
$data mixed

setDefault() публичный Метод

public setDefault ( )

setOptions() публичный Метод

public setOptions ( array $options )
$options array

setupStaticEnvironment() публичный Метод

Setup some settings that are needed for blocks
public setupStaticEnvironment ( ) : void
Результат void

start() публичный Метод

Is executed at the beginning of the loop and setup some general settings
public start ( )

Описание свойств

$current публичное свойство

Current step of the block while iteration
public int $current
Результат integer

$indices публичное свойство

Contains an array of indices, which represent the order of the elements in the block
public array $indices
Результат array

$suffixes публичное свойство

public string[] $suffixes
Результат string[]