Class ViewBlock

activesource public

active( )

Get the name of the currently open block.

Returns

mixed
Either null or the name of the last open block.

appendsource public

append( string $name , string $value null )

Append to an existing or new block. Appending to a new block will create the block.

Calling append() 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.

Deprecated

3.0.0 As of 2.3 use ViewBlock::concat() instead.

Parameters

string $name

Name of the block

string $value optional null

The content for the block.

concatsource public

concat( string $name , mixed $value null , string $mode 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.

Parameters

string $name

Name of the block

mixed $value optional null

The content for the block

string $mode optional ViewBlock::APPEND

If ViewBlock::APPEND content will be appended to existing content. If ViewBlock::PREPEND it will be prepended.

endsource public

end( )

End a capturing block. The compliment to ViewBlock::start()

See

ViewBlock::start()

existssource public

exists( string $name )

Check if a block exists

Parameters

string $name

Name of the block

Returns

boolean
bool

getsource public

get( string $name , string $default '' )

Get the content for a block.

Parameters

string $name

Name of the block

string $default optional ''

Default string

Returns

string
The block content or $default if the block does not exist.

keyssource public

keys( )

Get the names of all the existing blocks.

Returns

array
An array containing the blocks.

setsource public

set( string $name , mixed $value )

Set the content for a block. This will overwrite any existing content.

Parameters

string $name

Name of the block

mixed $value

The content for the block.

startsource public

start( string $name )

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();

Parameters

string $name

The name of the block to capture for.

Throws

CakeException
When starting a block twice

startIfEmptysource public

startIfEmpty( string $name )

Start capturing output for a 'block' if it is empty

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();

Parameters

string $name

The name of the block to capture for.

unclosedsource public

unclosed( )

Get the names of the unclosed/active blocks.

Returns

array
An array of unclosed blocks.

array()

array()

false