Class Cake\View\Helper\BreadcrumbsHelper

Properties summary

$_defaultConfig protected

array

Default config for the helper.
$crumbs protected

array

The crumb list.
$helpers public

array

Other helpers used by BreadcrumbsHelper.

Magic properties summary

$Url public

Cake\View\Helper\UrlHelper

Inherited Properties

_View, _helperMap, fieldset, tags _config, _configInitialized _templater

Method Summary

add() public

Add a crumb to the end of the trail.
findCrumb() protected

Search a crumb in the current stack which title matches the one provided as argument. If found, the index of the matching crumb will be returned.
getCrumbs() public

Returns the crumb list.
insertAfter() public

Insert a crumb after the first matching crumb with the specified title.
insertAt() public

Insert a crumb at a specific index.
insertBefore() public

Insert a crumb before the first matching crumb with the specified title.
prepend() public

Prepend a crumb to the start of the queue.
render() public

Renders the breadcrumbs trail.
reset() public

Removes all existing crumbs.

Method Detail

add() public ¶

add( string|array $title , string|array|null $url = null , array $options = [] )

Add a crumb to the end of the trail.

Parameters

string|array $title: If provided as a string, it represents the title of the crumb. Alternatively, if you want to add multiple crumbs at once, you can provide an array, with each values being a single crumb. Arrays are expected to be of this form: - title The title of the crumb - link The link of the crumb. If not provided, no link will be made - options Options of the crumb. See description of params option of this method.
string|array|null $url optional null: URL of the crumb. Either a string, an array of route params to pass to Url::build() or null / empty if the crumb does not have a link.
array $options optional []: Array of options. These options will be used as attributes HTML attribute the crumb will be rendered in (a
tag by default). It accepts two special keys: - innerAttrs: An array that allows you to define attributes for the inner element of the crumb (by default, to the link) - templateVars: Specific template vars in case you override the templates provided.

Returns

$this

findCrumb() protected ¶

findCrumb( string $title )

Search a crumb in the current stack which title matches the one provided as argument. If found, the index of the matching crumb will be returned.

Parameters

string $title: Title to find.

Returns

integer|null
Index of the crumb found, or null if it can not be found.

getCrumbs() public ¶

getCrumbs( )

Returns the crumb list.

Returns

array

insertAfter() public ¶

insertAfter( string $matchingTitle , string $title , string|array|null $url = null , array $options = [] )

Insert a crumb after the first matching crumb with the specified title.

Finds the index of the first crumb that matches the provided class, and inserts the supplied callable before it.

Parameters

string $matchingTitle: The title of the crumb you want to insert this one after.
string $title: Title of the crumb.
string|array|null $url optional null: URL of the crumb. Either a string, an array of route params to pass to Url::build() or null / empty if the crumb does not have a link.
array $options optional []: Array of options. These options will be used as attributes HTML attribute the crumb will be rendered in (a
tag by default). It accepts two special keys: - innerAttrs: An array that allows you to define attributes for the inner element of the crumb (by default, to the link) - templateVars: Specific template vars in case you override the templates provided.

Returns

$this

Throws

LogicException
In case the matching crumb can not be found.

insertAt() public ¶

insertAt( integer $index , string $title , string|array|null $url = null , array $options = [] )

Insert a crumb at a specific index.

If the index already exists, the new crumb will be inserted, and the existing element will be shifted one index greater. If the index is out of bounds, it will throw an exception.

Parameters

integer $index: The index to insert at.
string $title: Title of the crumb.
string|array|null $url optional null: URL of the crumb. Either a string, an array of route params to pass to Url::build() or null / empty if the crumb does not have a link.
array $options optional []: Array of options. These options will be used as attributes HTML attribute the crumb will be rendered in (a
tag by default). It accepts two special keys: - innerAttrs: An array that allows you to define attributes for the inner element of the crumb (by default, to the link) - templateVars: Specific template vars in case you override the templates provided.

Returns

$this

Throws

LogicException
In case the index is out of bound

insertBefore() public ¶

insertBefore( string $matchingTitle , string $title , string|array|null $url = null , array $options = [] )

Insert a crumb before the first matching crumb with the specified title.

Finds the index of the first crumb that matches the provided class, and inserts the supplied callable before it.

Parameters

string $matchingTitle: The title of the crumb you want to insert this one before.
string $title: Title of the crumb.
string|array|null $url optional null: URL of the crumb. Either a string, an array of route params to pass to Url::build() or null / empty if the crumb does not have a link.
array $options optional []: Array of options. These options will be used as attributes HTML attribute the crumb will be rendered in (a
tag by default). It accepts two special keys: - innerAttrs: An array that allows you to define attributes for the inner element of the crumb (by default, to the link) - templateVars: Specific template vars in case you override the templates provided.

Returns

$this

Throws

LogicException
In case the matching crumb can not be found

prepend() public ¶

prepend( string $title , string|array|null $url = null , array $options = [] )

Prepend a crumb to the start of the queue.

Parameters

string $title: If provided as a string, it represents the title of the crumb. Alternatively, if you want to add multiple crumbs at once, you can provide an array, with each values being a single crumb. Arrays are expected to be of this form: - title The title of the crumb - link The link of the crumb. If not provided, no link will be made - options Options of the crumb. See description of params option of this method.
string|array|null $url optional null: URL of the crumb. Either a string, an array of route params to pass to Url::build() or null / empty if the crumb does not have a link.
array $options optional []: Array of options. These options will be used as attributes HTML attribute the crumb will be rendered in (a
tag by default). It accepts two special keys: - innerAttrs: An array that allows you to define attributes for the inner element of the crumb (by default, to the link) - templateVars: Specific template vars in case you override the templates provided.

Returns

$this

render() public ¶

render( array $attributes = [] , array $separator = [] )

Renders the breadcrumbs trail.

Parameters

array $attributes optional []: Array of attributes applied to the wrapper template. Accepts the templateVars key to allow the insertion of custom template variable in the template.
array $separator optional []: Array of attributes for the separator template. Possible properties are : - separator The string to be displayed as a separator - templateVars Allows the insertion of custom template variable in the template - innerAttrs To provide attributes in case your separator is divided in two elements. All other properties will be converted as HTML attributes and will replace the attrs key in the template. If you use the default for this option (empty), it will not render a separator.

Returns

string
The breadcrumbs trail

reset() public ¶

reset( )

Removes all existing crumbs.

Returns

$this

Methods inherited from Cake\View\Helper

__call() public ¶

__call( string $method , array $params )

Provide non fatal errors on missing method calls.

Parameters

string $method: Method to invoke
array $params: Array of params for the method.

Returns

mixed|

__construct() public ¶

__construct( Cake\View\View $View , array $config = [] )

Default Constructor

Parameters

Cake\View\View $View: The View this helper is being attached to.
array $config optional []: Configuration settings for the helper.

__debugInfo() public ¶

__debugInfo( )

Returns an array that can be used to describe the internal state of this object.

Returns

array

__get() public ¶

__get( string $name )

Lazy loads helpers.

Parameters

string $name: Name of the property being accessed.

Returns

Cake\View\Helper|null
Helper instance if helper with provided name exists

__set() public ¶

__set( string $name , mixed $value )

Magic setter for removed properties.

Parameters

string $name: Property name.
mixed $value: Value to set.

_cleanConfirmMessage() protected ¶

_cleanConfirmMessage( string $message )

Returns a string read to be used in confirm()

Parameters

string $message: The message to clean

Returns

mixed

_confirm() protected ¶

_confirm( string $message , string $okCode , string $cancelCode = '' , array $options = [] )

Returns a string to be used as onclick handler for confirm dialogs.

Parameters

string $message: Message to be displayed
string $okCode: Code to be executed after user chose 'OK'
string $cancelCode optional '': Code to be executed after user chose 'Cancel'
array $options optional []: Array of options

Returns

string
onclick JS code

addClass() public ¶

addClass( array $options = [] , string|null $class = null , string $key = 'class' )

Adds the given class to the element options

Parameters

array $options optional []: Array options/attributes to add a class to
string|null $class optional null: The class name being added.
string $key optional 'class': the key to use for class. Defaults to 'class'.

Returns

array
Array of options with $key set.

getView() public ¶

getView( )

Get the view instance this helper is bound to.

Returns

Cake\View\View
The bound view instance.

implementedEvents() public ¶

implementedEvents( )

Get the View callbacks this helper is interested in.

By defining one of the callback methods a helper is assumed to be interested in the related event.

Override this method if you need to add non-conventional event listeners. Or if you want helpers to listen to non-standard events.

Returns

array

Implementation of

Cake\Event\EventListenerInterface::implementedEvents()

initialize() public ¶

initialize( array $config )

Constructor hook method.

Implement this method to avoid having to overwrite the constructor and call parent.

Parameters

array $config: The configuration settings provided to this helper.

Methods used from Cake\View\StringTemplateTrait

formatTemplate() public ¶

formatTemplate( string $name , array $data )

Formats a template string with $data

Parameters

string $name: The template name.
array $data: The data to insert.

Returns

string

getTemplates() public ¶

getTemplates( string|null $template = null )

Gets templates to use or a specific template.

Parameters

string|null $template optional null: String for reading a specific template, null for all.

Returns

string|array

setTemplates() public ¶

setTemplates( array $templates )

Sets templates to use.

Parameters

array $templates: Templates to be added.

Returns

$this

templater() public ¶

templater( )

Returns the templater instance.

Returns

Cake\View\StringTemplate

templates() public deprecated ¶

templates( string|array|null $templates = null )

Gets/sets templates to use.

Deprecated

3.4.0 Use setTemplates()/getTemplates() instead.

Parameters

string|array|null $templates optional null: null or string allow reading templates. An array allows templates to be added.

Returns

$this|string|array

Methods used from Cake\Core\InstanceConfigTrait

_configDelete() protected ¶

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key: Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead() protected ¶

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key: Key to read.

Returns

mixed

_configWrite() protected ¶

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

Writes a config key.

Parameters

string|array $key: Key to write to.
mixed $value: Value to write.
boolean|string $merge optional false: True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

config() public deprecated ¶

config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )

Gets/Sets the config.

Usage

Reading the whole config:

$this->config();

Reading a specific value:

$this->config('key');

Reading a nested value:

$this->config('some.nested.key');

Setting a specific value:

$this->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);

Deprecated

3.4.0 use setConfig()/getConfig() instead.

Parameters

string|array|null $key optional null: The key to get/set, or a complete array of configs.
mixed|null $value optional null: The value to set.
boolean $merge optional true: Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed
Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow() public ¶

configShallow( string|array $key , mixed|null $value = null )

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

Setting a specific value:

$this->configShallow('key', $value);

Setting a nested value:

$this->configShallow('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key: The key to set, or a complete array of configs.
mixed|null $value optional null: The value to set.

Returns

$this

getConfig() public ¶

getConfig( string|null $key = null , mixed $default = null )

Returns the config.

Usage

Reading the whole config:

$this->getConfig();

Reading a specific value:

$this->getConfig('key');

Reading a nested value:

$this->getConfig('some.nested.key');

Reading with default value:

$this->getConfig('some-key', 'default-value');

Parameters

string|null $key optional null: The key to get or null for the whole config.
mixed $default optional null: The return value when the key does not exist.

Returns

mixed
Configuration data at the named key or null if the key does not exist.

setConfig() public ¶

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

Sets the config.

Usage

Setting a specific value:

$this->setConfig('key', $value);

Setting a nested value:

$this->setConfig('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key: The key to set, or a complete array of configs.
mixed|null $value optional null: The value to set.
boolean $merge optional true: Whether to recursively merge or overwrite existing config, defaults to true.

Returns

$this

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

Properties detail

`$_defaultConfig` ¶

protected array

Default config for the helper.

[
    'templates' => [
        'wrapper' => '<ul{{attrs}}>{{content}}</ul>',
        'item' => '<li{{attrs}}><a href="{{url}}"{{innerAttrs}}>{{title}}</a></li>{{separator}}',
        'itemWithoutLink' => '<li{{attrs}}><span{{innerAttrs}}>{{title}}</span></li>{{separator}}',
        'separator' => '<li{{attrs}}><span{{innerAttrs}}>{{separator}}</span></li>'
    ]
]

`$crumbs` ¶

protected array

The crumb list.

[]

`$helpers` ¶

public array

Other helpers used by BreadcrumbsHelper.

['Url']

Magic properties detail

`$Url` ¶

public Cake\View\Helper\UrlHelper

Namespaces

Classes

Traits

Class BreadcrumbsHelper

Properties summary

Magic properties summary

Inherited Properties

Method Summary

add() public

findCrumb() protected

getCrumbs() public

insertAfter() public

insertAt() public

insertBefore() public

prepend() public

render() public

reset() public

Method Detail

add() public ¶

Parameters

Returns

findCrumb() protected ¶

Parameters

Returns

getCrumbs() public ¶

Returns

insertAfter() public ¶

Parameters

Returns

Throws

insertAt() public ¶

Parameters

Returns

Throws

insertBefore() public ¶

Parameters

Returns

Throws

prepend() public ¶

Parameters

Returns

render() public ¶

Parameters

Returns

reset() public ¶

Returns

Methods inherited from Cake\View\Helper

__call() public ¶

Parameters

Returns

__construct() public ¶

Parameters

__debugInfo() public ¶

Returns

__get() public ¶

Parameters

Returns

__set() public ¶

Parameters

_cleanConfirmMessage() protected ¶

Parameters

Returns

_confirm() protected ¶

Parameters

Returns

addClass() public ¶

Parameters

Returns

getView() public ¶

Returns

implementedEvents() public ¶

Returns

Implementation of

initialize() public ¶

Parameters

Methods used from Cake\View\StringTemplateTrait

formatTemplate() public ¶

Parameters

Returns

getTemplates() public ¶

`$_defaultConfig` ¶

`$crumbs` ¶

`$helpers` ¶

`$Url` ¶