Class BreadcrumbsHelper

BreadcrumbsHelper to register and display a breadcrumb trail for your views

Namespace: Cake\View\Helper

Properties summary

  • $Url public
    \Cake\View\Helper\UrlHelper
  • $_View protected
    \Cake\View\View

    The View instance this helper is attached to

  • $_config protected
    array

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array

    Default config for the helper.

  • $_helperMap protected
    array

    A helper lookup table used to lazy load helper objects.

  • $_templater protected
    \Cake\View\StringTemplate

    StringTemplate instance.

  • $crumbs protected
    array

    The crumb list.

  • $helpers public
    array

    Other helpers used by BreadcrumbsHelper.

Method Summary

  • __call() public

    Provide non fatal errors on missing method calls.

  • __construct() public

    Default Constructor

  • __debugInfo() public

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

  • __get() public

    Lazy loads helpers.

  • _configDelete() protected

    Deletes a single config key.

  • _configRead() protected

    Reads a config key.

  • _configWrite() protected

    Writes a config key.

  • _confirm() protected

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

  • add() public

    Add a crumb to the end of the trail.

  • addClass() public

    Adds the given class to the element options

  • configShallow() public

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

  • findCrumb() protected

    Search a crumb in the current stack which title matches the one provided as argument.

  • formatTemplate() public

    Formats a template string with $data

  • getConfig() public

    Returns the config.

  • getConfigOrFail() public

    Returns the config for this specific key.

  • getCrumbs() public

    Returns the crumb list.

  • getTemplates() public

    Gets templates to use or a specific template.

  • getView() public

    Get the view instance this helper is bound to.

  • implementedEvents() public

    Get the View callbacks this helper is interested in.

  • initialize() public

    Constructor hook method.

  • 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.

  • setConfig() public

    Sets the config.

  • setTemplates() public

    Sets templates to use.

  • templater() public

    Returns the templater instance.

Method Detail

__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|void

__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|void

Helper instance if helper with provided name exists

_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 $key)

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite() protected 

_configWrite(mixed $key, mixed $value, mixed $merge)

Writes a config key.

Parameters

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.

Throws

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

_confirm() protected 

_confirm(string $okCode, string $cancelCode)

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

Parameters

string $okCode

Code to be executed after user chose 'OK'

string $cancelCode

Code to be executed after user chose 'Cancel'

Returns

string

"onclick" JS code

add() public 

add(mixed $title, mixed $url, 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

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

    addClass() public 

    addClass(array $options, string $class, string $key)

    Adds the given class to the element options

    Parameters

    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'.

    Returns

    array

    Array of options with $key set.

    configShallow() public 

    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']);

    Parameters

    string|array $key

    The key to set, or a complete array of configs.

    mixed|null $value optional

    The value to set.

    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

    int|null

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

    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

    getConfig() public 

    getConfig(?string $key, mixed $default)

    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

    The key to get or null for the whole config.

    mixed $default optional

    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.

    getConfigOrFail() public 

    getConfigOrFail(string $key)

    Returns the config for this specific key.

    The config value for this key must exist, it can never be null.

    Parameters

    string $key

    The key to get.

    Returns

    mixed

    Configuration data at the named key

    Throws

    InvalidArgumentException

    getCrumbs() public 

    getCrumbs()

    Returns the crumb list.

    Returns

    array

    getTemplates() public 

    getTemplates(?string $template)

    Gets templates to use or a specific template.

    Parameters

    string|null $template optional

    String for reading a specific template, null for all.

    Returns

    string|array

    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

    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.

    insertAfter() public 

    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.

    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

    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(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.

    Parameters

    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

  • 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, 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.

    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

    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(mixed $title, mixed $url, array $options)

    Prepend a crumb to the start of the queue.

    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

    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

    setConfig() public 

    setConfig(mixed $key, mixed $value, mixed $merge)

    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

    The value to set.

    bool $merge optional

    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.

    setTemplates() public 

    setTemplates(array $templates)

    Sets templates to use.

    Parameters

    string[] $templates

    Templates to be added.

    Returns

    $this

    templater() public 

    templater()

    Returns the templater instance.

    Returns

    \Cake\View\StringTemplate

    Property Detail

    $Url public

    Type

    \Cake\View\Helper\UrlHelper

    $_View protected

    The View instance this helper is attached to

    Type

    \Cake\View\View

    $_config protected

    Runtime config

    Type

    array

    $_configInitialized protected

    Whether the config property has already been configured with defaults

    Type

    bool

    $_defaultConfig protected

    Default config for the helper.

    Type

    array

    $_helperMap protected

    A helper lookup table used to lazy load helper objects.

    Type

    array

    $_templater protected

    StringTemplate instance.

    Type

    \Cake\View\StringTemplate

    $crumbs protected

    The crumb list.

    Type

    array

    $helpers public

    Other helpers used by BreadcrumbsHelper.

    Type

    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