W3cubDocs

/CakePHP 3.4

Class BreadcrumbsHelper

BreadcrumbsHelper to register and display a breadcrumb trail for your views

Cake\View\Helper implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
Extended by Cake\View\Helper\BreadcrumbsHelper uses Cake\View\StringTemplateTrait

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

Inherited Properties

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.
  • 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()source 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()source 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()source public

    getCrumbs( )

    Returns the crumb list.

    Returns

    array

    insertAfter()source 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()source 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()source 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()source 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()source 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()source public

    reset( )

    Removes all existing crumbs.

    Returns


    $this

    Methods inherited from Cake\View\Helper

    __call()source 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.

    __construct()source 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()source public

    __debugInfo( )

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

    Returns

    array

    __get()source 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

    _confirm()source 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()source 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.

    Returns

    array
    Array of options with $key set.

    getView()source public

    getView( )

    Get the view instance this helper is bound to.

    Returns

    Cake\View\View
    The bound view instance.

    implementedEvents()source 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()source 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()source 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()source 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()source public

    setTemplates( array $templates )

    Sets templates to use.

    Parameters

    array $templates
    Templates to be added.

    Returns


    $this

    templater()source public

    templater( )

    Returns the templater instance.

    Returns

    Cake\View\StringTemplate

    templates()source public

    templates( string|null|array $templates null )

    Gets/sets templates to use.

    Deprecated

    3.4.0 Use setTemplates()/getTemplates() instead.

    Parameters

    string|null|array $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()source 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()source protected

    _configRead( string|null $key )

    Reads a config key.

    Parameters

    string|null $key
    Key to read.

    Returns

    mixed

    _configWrite()source 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()source public

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

    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()source public

    getConfig( string|null $key 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');

    Parameters

    string|null $key optional null
    The key to get or null for the whole config.

    Returns

    mixed
    Config value being read.

    setConfig()source 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

    $_defaultConfigsource

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

    $crumbssource

    protected array

    The crumb list.

    []

    $helperssource

    public array

    Other helpers used by BreadcrumbsHelper.

    ['Url']

    Magic properties detail

    © 2005–2017 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/3.4/class-Cake.View.Helper.BreadcrumbsHelper.html