PHP Class Pimcore\Model\Document\Tag\Areablock

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

Public Properties

Property Type Description
$current integer Current step of the block while iteration
$currentIndex array
$indices array Contains an array of indices, which represent the order of the elements in the block

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)
content ( )
end ( ) : void Is executed at the end of the loop and removes the settings set in start()
frontend ( )
getAreaDirectory ( ) : string
getAreaDirs ( ) : array
getBrickConfig ( $name )
getBrickConfigs ( ) : array | mixed
getCount ( ) : integer Return the amount of block elements
getCurrent ( ) : integer Return current iteration step
getCurrentIndex ( ) : integer Return current index
getData ( ) : mixed
getElement ( $name ) : Pimcore\Model\Document\Tag\Areablock\Item[]
getFromWebserviceImport ( Pimcore\Model\Webservice\Data\Document\Element $wsElement, $document = null, mixed $params = [], null $idMapper = null )
getPathForBrick ( $name ) : string
getType ( ) : string
isBrickEnabled ( $name ) : boolean
isCustomAreaPath ( ) : boolean
isEmpty ( ) : boolean
loop ( )
outputEditmode ( string $v ) : void Sends data to the output stream
renderIndex ( $index )
setDataFromEditmode ( mixed $data )
setDataFromResource ( mixed $data )
setOptions ( array $options ) : void
setupStaticEnvironment ( ) : void Setup some settings that are needed for blocks
start ( ) : void Is executed at the beginning of the loop and setup some general settings

Protected Methods

Method Description
getToolBarDefaultConfig ( )

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

content() public method

public content ( )

end() public method

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

frontend() public method

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

getAreaDirectory() public method

public getAreaDirectory ( ) : string
return string

getAreaDirs() public method

public getAreaDirs ( ) : array
return array

getBrickConfig() public method

public getBrickConfig ( $name )
$name

getBrickConfigs() public method

public getBrickConfigs ( ) : array | mixed
return array | mixed

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

getElement() public method

public getElement ( $name ) : Pimcore\Model\Document\Tag\Areablock\Item[]
$name
return Pimcore\Model\Document\Tag\Areablock\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

getPathForBrick() public method

public getPathForBrick ( $name ) : string
$name
return string

getToolBarDefaultConfig() protected method

protected getToolBarDefaultConfig ( )

getType() public method

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

isBrickEnabled() public method

public isBrickEnabled ( $name ) : boolean
$name
return boolean

isCustomAreaPath() public method

public isCustomAreaPath ( ) : boolean
return boolean

isEmpty() public method

public isEmpty ( ) : boolean
return boolean

loop() public method

public loop ( )

outputEditmode() public method

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

renderIndex() public method

public renderIndex ( $index )
$index

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

setOptions() public method

public setOptions ( array $options ) : void
$options array
return void

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 ( ) : void
return void

Property Details

$current public_oe property

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

$currentIndex public_oe property

public array $currentIndex
return array

$indices public_oe property

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