Class lispa\amos\core\helpers\BreadcrumbHelper
| Inheritance | lispa\amos\core\helpers\BreadcrumbHelper » yii\base\Component » yii\base\Object |
|---|---|
| Implements | yii\base\Configurable |
Class BreadcrumbHelper
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $stack | lispa\amos\core\helpers\BreadcrumbHelper |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\Object |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| add() | Create the crumb and send it to the trail | lispa\amos\core\helpers\BreadcrumbHelper |
| addToTrail() | Add crumb to the trail | lispa\amos\core\helpers\BreadcrumbHelper |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| check() | Check if $crumb is already the last element of the trail | lispa\amos\core\helpers\BreadcrumbHelper |
| className() | Returns the fully qualified name of this class. | yii\base\Object |
| clearCache() | Reset cache | lispa\amos\core\helpers\BreadcrumbHelper |
| createCrumb() | lispa\amos\core\helpers\BreadcrumbHelper | |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getCache() | lispa\amos\core\helpers\BreadcrumbHelper | |
| getKeysMultidimensional() | lispa\amos\core\helpers\BreadcrumbHelper | |
| getUserId() | Return current logged user id | lispa\amos\core\helpers\BreadcrumbHelper |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes the object. | yii\base\Object |
| lastCrumbUrl() | lispa\amos\core\helpers\BreadcrumbHelper | |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| renderCrumbs() | It passes the trail to the core breadcrumb widget | lispa\amos\core\helpers\BreadcrumbHelper |
| reset() | Reset cache and trail | lispa\amos\core\helpers\BreadcrumbHelper |
| trigger() | Triggers an event. | yii\base\Component |
| write() | lispa\amos\core\helpers\BreadcrumbHelper |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| EVENT_CRUMB_ADDED | 'crumbAdded' | lispa\amos\core\helpers\BreadcrumbHelper | |
| EVENT_CRUMB_DELETED | 'crumbDeleted' | lispa\amos\core\helpers\BreadcrumbHelper |
Property Details
Method Details
Create the crumb and send it to the trail
| public static void add ( $label, $url = null, $template = null, $remove_action = null ) | ||
| $label | ||
| $url | null | |
| $template | null | |
| $remove_action | ||
Add crumb to the trail
| public static void addToTrail ( $crumb ) | ||
| $crumb | ||
Check if $crumb is already the last element of the trail
| public static boolean check ( $crumb, $trail ) | ||
| $crumb | ||
| $trail | ||
Reset cache
| public static void clearCache ( ) |
| public static null createCrumb ( $array_url = null ) | ||
| $array_url | ||
| public static null|object getCache ( ) |
| public static array getKeysMultidimensional ( array $array ) | ||
| $array | array | |
Return current logged user id
| public static mixed getUserId ( ) |
| public static void lastCrumbUrl ( ) |
It passes the trail to the core breadcrumb widget
| public static void renderCrumbs ( ) |
Reset cache and trail
| public static void reset ( ) |
| public static void write ( $trail ) | ||
| $trail | ||