ViewBlock implements the concept of Blocks or Slots in the View layer. Slots or blocks are combined with extending views and layouts to afford slots of content that are present in a layout or parent view, but are defined by the child view or elements used in the view.
active( )
Get the name of the currently open block.
string|null
concat( string $name , mixed $value null , string $mode Cake\View\ViewBlock::APPEND )
Concat content to an existing or new block. Concating to a new block will create the block.
Calling concat() without a value will create a new capturing block that needs to be finished with View::end(). The content of the new capturing context will be added to the existing block context.
$name
$value
optional null $mode
optional Cake\View\ViewBlock::APPEND
end( )
End a capturing block. The compliment to ViewBlock::start()
Cake\View\ViewBlock::start()
exists( string $name )
Check if a block exists
$name
boolean
get( string $name , string $default '' )
Get the content for a block.
$name
$default
optional '' string
keys( )
Get the names of all the existing blocks.
array
set( string $name , mixed $value )
Set the content for a block. This will overwrite any existing content.
$name
$value
start( string $name , string $mode Cake\View\ViewBlock::OVERRIDE )
Start capturing output for a 'block'
Blocks allow you to create slots or blocks of dynamic content in the layout. view files can implement some or all of a layout's slots.
You can end capturing blocks using View::end(). Blocks can be output using View::get();
$name
$mode
optional Cake\View\ViewBlock::OVERRIDE
Cake\Core\Exception\Exception
unclosed( )
Get the names of the unclosed/active blocks.
array
string | APPEND Append content | 'append' |
string | OVERRIDE Override content | 'override' |
string | PREPEND Prepend content | 'prepend' |
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.View.ViewBlock.html