PHP Class Pimcore\Model\Document\Tag\Block

Inheritance: extends Pimcore\Model\Document\Tag
Show file Open project: pimcore/pimcore

Public Properties

Property Type Description
$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[]

Public Methods

Method Description
__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

Method Details

__wakeup() public method

If object was serialized, set the counter back to 0
public __wakeup ( ) : void
return void

admin() public method

See also: Document\Tag\TagInterface::admin
public admin ( )

blockConstruct() public method

public blockConstruct ( )

blockDestruct() public method

public blockDestruct ( )

blockEnd() public method

Is called evertime a new iteration ends (new entry of the block while looping)
public blockEnd ( ) : void
return void

blockStart() public method

Is called evertime a new iteration starts (new entry of the block while looping)
public blockStart ( ) : void
return void

end() public method

Is executed at the end of the loop and removes the settings set in start()
public end ( ) : void
return void

enumerate() public method

Alias for loop
See also: loop()
Deprecation:
public enumerate ( ) : boolean
return boolean

frontend() public method

See also: Document\Tag\TagInterface::frontend
public frontend ( )

getCount() public method

Return the amount of block elements
public getCount ( ) : integer
return integer

getCurrent() public method

Return current iteration step
public getCurrent ( ) : integer
return integer

getCurrentIndex() public method

Return current index
public getCurrentIndex ( ) : integer
return integer

getData() public method

See also: Document\Tag\TagInterface::getData
public getData ( ) : mixed
return mixed

getElements() public method

public getElements ( ) : Pimcore\Model\Document\Tag\Block\Item[]
return Pimcore\Model\Document\Tag\Block\Item[]

getFromWebserviceImport() public method

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() public method

See also: Document\Tag\TagInterface::getType
public getType ( ) : string
return string

isEmpty() public method

public isEmpty ( ) : boolean
return boolean

loop() public method

Loops through the block
public loop ( ) : boolean
return boolean

outputEditmode() public method

Sends data to the output stream
public outputEditmode ( string $v ) : void
$v string
return void

setDataFromEditmode() public method

See also: Document\Tag\TagInterface::setDataFromEditmode
public setDataFromEditmode ( mixed $data )
$data mixed

setDataFromResource() public method

See also: Document\Tag\TagInterface::setDataFromResource
public setDataFromResource ( mixed $data )
$data mixed

setDefault() public method

public setDefault ( )

setOptions() public method

public setOptions ( array $options )
$options array

setupStaticEnvironment() public method

Setup some settings that are needed for blocks
public setupStaticEnvironment ( ) : void
return void

start() public method

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

Property Details

$current public property

Current step of the block while iteration
public int $current
return integer

$indices public property

Contains an array of indices, which represent the order of the elements in the block
public array $indices
return array

$suffixes public property

public string[] $suffixes
return string[]