BreadcrumbsHelper to register and display a breadcrumb trail for your views
Cake\View\Helper\UrlHelper
Cake\View\View
The View instance this helper is attached to
array<string, mixed>
Runtime config
bool
Whether the config property has already been configured with defaults
array<string, mixed>
Default config for the helper.
array<string, array>
A helper lookup table used to lazy load helper objects.
Cake\View\StringTemplate|null
StringTemplate instance.
array
The crumb list.
array
Other helpers used by BreadcrumbsHelper.
Provide non fatal errors on missing method calls.
Default Constructor
Returns an array that can be used to describe the internal state of this object.
Lazy loads helpers.
Deletes a single config key.
Reads a config key.
Writes a config key.
Returns a string to be used as onclick handler for confirm dialogs.
Add a crumb to the end of the trail.
Adds the given class to the element options
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. If found, the index of the matching crumb will be returned.
Formats a template string with $data
Returns the config.
Returns the config for this specific key.
Returns the crumb list.
Gets templates to use or a specific template.
Get the view instance this helper is bound to.
Get the View callbacks this helper is interested in.
Constructor hook method.
Insert a crumb after the first matching crumb with the specified title.
Insert a crumb at a specific index.
Insert a crumb before the first matching crumb with the specified title.
Prepend a crumb to the start of the queue.
Renders the breadcrumbs trail.
Removes all existing crumbs.
Sets the config.
Sets templates to use.
Returns the templater instance.
__call(string $method, array $params): mixed|void
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<string, mixed> $config = [])
Default Constructor
Cake\View\View
$view The View this helper is being attached to.
array<string, mixed>
$config optional Configuration settings for the helper.
__debugInfo(): array<string, mixed>
Returns an array that can be used to describe the internal state of this object.
array<string, mixed>
__get(string $name): Cake\View\Helper|null|void
Lazy loads helpers.
string
$name Name of the property being accessed.
Cake\View\Helper|null|void
_configDelete(string $key): void
Deletes a single config key.
string
$key Key to delete.
void
Cake\Core\Exception\CakeException
_configRead(string|null $key): mixed
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
array<string, mixed>|string
$key Key to write to.
mixed
$value Value to write.
string|bool
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
void
Cake\Core\Exception\CakeException
_confirm(string $okCode, string $cancelCode): string
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
add(array|string $title, array|string|null $url = null, array<string, mixed> $options = []): $this
Add a crumb to the end of the trail.
array|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:
array|string|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<string, mixed>
$options optional Array of options. These options will be used as attributes HTML attribute the crumb will be rendered in (a
$this
addClass(array<string, mixed> $options, string $class, string $key = 'class'): array<string, mixed>
Adds the given class to the element options
array<string, mixed>
$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'
.
array<string, mixed>
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this
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']);
array<string, mixed>|string
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
findCrumb(string $title): int|null
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|null
formatTemplate(string $name, array<string, mixed> $data): string
Formats a template string with $data
string
$name The template name.
array<string, mixed>
$data The data to insert.
string
getConfig(string|null $key = null, mixed $default = null): mixed
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.
mixed
getConfigOrFail(string $key): mixed
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.
mixed
InvalidArgumentException
getCrumbs(): array
Returns the crumb list.
array
getTemplates(string|null $template = null): array|string
Gets templates to use or a specific template.
string|null
$template optional String for reading a specific template, null for all.
array|string
getView(): Cake\View\View
Get the view instance this helper is bound to.
Cake\View\View
implementedEvents(): array<string, mixed>
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.
array<string, mixed>
initialize(array<string, mixed> $config): void
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array<string, mixed>
$config The configuration settings provided to this helper.
void
insertAfter(string $matchingTitle, string $title, array|string|null $url = null, array<string, mixed> $options = []): $this
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.
array|string|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<string, mixed>
$options optional Array of options. These options will be used as attributes HTML attribute the crumb will be rendered in (a
$this
LogicException
insertAt(int $index, string $title, array|string|null $url = null, array<string, mixed> $options = []): $this
Insert a crumb at a specific index.
If the index already exists, the new crumb will be inserted, before the existing element, shifting the existing element one index greater than before.
If the index is out of bounds, an exception will be thrown.
int
$index The index to insert at.
string
$title Title of the crumb.
array|string|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<string, mixed>
$options optional Array of options. These options will be used as attributes HTML attribute the crumb will be rendered in (a
$this
LogicException
insertBefore(string $matchingTitle, string $title, array|string|null $url = null, array<string, mixed> $options = []): $this
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.
array|string|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<string, mixed>
$options optional Array of options. These options will be used as attributes HTML attribute the crumb will be rendered in (a
$this
LogicException
prepend(array|string $title, array|string|null $url = null, array<string, mixed> $options = []): $this
Prepend a crumb to the start of the queue.
array|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:
array|string|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<string, mixed>
$options optional Array of options. These options will be used as attributes HTML attribute the crumb will be rendered in (a
$this
render(array<string, mixed> $attributes = [], array<string, mixed> $separator = []): string
Renders the breadcrumbs trail.
array<string, mixed>
$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<string, mixed>
$separator optional Array of attributes for the separator
template. Possible properties are :
string
reset(): $this
Removes all existing crumbs.
$this
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
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']);
array<string, mixed>|string
$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.
$this
Cake\Core\Exception\CakeException
setTemplates(array<string> $templates): $this
Sets templates to use.
array<string>
$templates Templates to be added.
$this
templater(): Cake\View\StringTemplate
Returns the templater instance.
Cake\View\StringTemplate
Cake\View\Helper\UrlHelper
The View instance this helper is attached to
Cake\View\View
Runtime config
array<string, mixed>
Whether the config property has already been configured with defaults
bool
Default config for the helper.
array<string, mixed>
A helper lookup table used to lazy load helper objects.
array<string, array>
StringTemplate instance.
Cake\View\StringTemplate|null
The crumb list.
array
Other 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.4/class-Cake.View.Helper.BreadcrumbsHelper.html