BreadcrumbsHelper to register and display a breadcrumb trail for your views
\Cake\View\Helper\UrlHelper\Cake\View\ViewThe View instance this helper is attached to
arrayRuntime config
boolWhether the config property has already been configured with defaults
arrayDefault config for the helper.
arrayA helper lookup table used to lazy load helper objects.
\Cake\View\StringTemplateStringTemplate instance.
arrayThe crumb list.
arrayOther helpers used by BreadcrumbsHelper.
Returns an array that can be used to describe the internal state of this object.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Search a crumb in the current stack which title matches the one provided as argument.
__call(string $method, array $params)
Provide non fatal errors on missing method calls.
string $method Method to invoke
array $params Array of params for the method.
mixed|void__construct(\Cake\View\View $view, array $config)
Default Constructor
\Cake\View\View $view The View this helper is being attached to.
array $config optional Configuration settings for the helper.
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
array__get(string $name)
Lazy loads helpers.
string $name Name of the property being accessed.
\Cake\View\Helper|null|voidHelper instance if helper with provided name exists
_configDelete(string $key)
Deletes a single config key.
string $key Key to delete.
Cake\Core\Exception\Exception_configRead(?string $key)
Reads a config key.
string|null $key Key to read.
mixed_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
string|array $key Key to write to.
mixed $value Value to write.
bool|string $merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception_confirm(string $okCode, string $cancelCode)
Returns a string to be used as onclick handler for confirm dialogs.
string $okCode Code to be executed after user chose 'OK'
string $cancelCode Code to be executed after user chose 'Cancel'
string"onclick" JS code
add(mixed $title, mixed $url, array $options)
Add a crumb to the end of the trail.
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:
string|array|null $url optional 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
$thisaddClass(array $options, string $class, string $key)
Adds the given class to the element options
array $options Array options/attributes to add a class to
string $class The class name being added.
string $key optional the key to use for class. Defaults to 'class'.
arrayArray of options with $key set.
configShallow(mixed $key, mixed $value)
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']);
string|array $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thisfindCrumb(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.
string $title Title to find.
int|nullIndex of the crumb found, or null if it can not be found.
formatTemplate(string $name, array $data)
Formats a template string with $data
string $name The template name.
array $data The data to insert.
stringgetConfig(?string $key, mixed $default)
Returns the config.
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'); string|null $key optional The key to get or null for the whole config.
mixed $default optional The return value when the key does not exist.
mixedConfiguration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string $key The key to get.
mixedConfiguration data at the named key
InvalidArgumentExceptiongetCrumbs()
Returns the crumb list.
arraygetTemplates(?string $template)
Gets templates to use or a specific template.
string|null $template optional String for reading a specific template, null for all.
string|arraygetView()
Get the view instance this helper is bound to.
\Cake\View\ViewThe bound view instance.
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.
arrayinitialize(array $config)
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array $config The configuration settings provided to this helper.
insertAfter(string $matchingTitle, string $title, mixed $url, 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.
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 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
$thisLogicExceptioninsertAt(int $index, string $title, mixed $url, 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.
int $index The index to insert at.
string $title Title of the crumb.
string|array|null $url optional 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
$thisLogicExceptioninsertBefore(string $matchingTitle, string $title, mixed $url, 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.
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 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
$thisLogicExceptionprepend(mixed $title, mixed $url, array $options)
Prepend a crumb to the start of the queue.
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:
string|array|null $url optional 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
$thisrender(array $attributes, array $separator)
Renders the breadcrumbs trail.
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 :
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.
stringThe breadcrumbs trail
reset()
Removes all existing crumbs.
$thissetConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
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']);
string|array $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
bool $merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$thisCake\Core\Exception\ExceptionsetTemplates(array $templates)
Sets templates to use.
string[] $templates Templates to be added.
$thistemplater()
Returns the templater instance.
\Cake\View\StringTemplate\Cake\View\Helper\UrlHelperThe View instance this helper is attached to
\Cake\View\ViewRuntime config
arrayWhether the config property has already been configured with defaults
boolDefault config for the helper.
arrayA helper lookup table used to lazy load helper objects.
arrayStringTemplate instance.
\Cake\View\StringTemplateThe crumb list.
arrayOther helpers used by BreadcrumbsHelper.
array
© 2005–present 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.
https://api.cakephp.org/4.1/class-Cake.View.Helper.BreadcrumbsHelper.html