Class BreadcrumbElement
BreadcrumbElement
Renders a _location_ breadcumb, showing where the page is located in the website hierarchy.
A breadcrumb is a navigation aid. It allows users to keep track of their locations within the website. A breadcrumb typically appears horizontally across the top of a web page, usually below title bars or headers. It provides links to the parent pages of the current one. The SINGLE RIGHT-POINTING ANGLE QUOTATION MARK character (›) serves as hierarchy separator.
The breadcrumb element is made of slices. In each slice there is a link to the page of the slice unless the slice if the last one in which case the in a strong element.
The breadcrumb is an OL element and each of its slice is a LI element.
Event: render_inner_html:before
Fired before the inner HTML of the element is rendered.
Signature
before_render_inner_html($event, $sender);
Arguments
- event - (ICanBoogie\Event) An event object with the following properties: * slices - (&array) The slices of the breadcrumb * separator - (&string) The separator for the slices. * page - (Icybee\Modules\Pages\Page) The current page object.
- target -
Icybee\Modules\Pages\BreadcrumbElement
The breadcrumb element that fired the event.
Event: render_inner_html
Fired when the inner HTML of the element has been rendered.
Signature
on_render_inner_html($event, $sender);
Arguments
- event - (ICanBoogie\Event) An event object with the following properties: * rc - (&string) The rendered inner HTML. * page - (Icybee\Modules\Pages\Page) The current page object.
- sender -
Icybee\Modules\Pages\BreadcrumbElement
The breadcrumb element that fired the event.
- ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait
- Brickrouge\Element implements ArrayAccess, IteratorAggregate, Brickrouge\HTMLStringInterface
- Icybee\Modules\Pages\BreadcrumbElement
Located at vendor/icanboogie-modules/pages/lib/elements/breadcrumb.php
Methods summary
public static
string
|
|
public
|
|
protected
string|null
|
Methods inherited from Brickrouge\Element
__toString()
,
add_assets()
,
add_class()
,
adopt()
,
alter_attributes()
,
alter_class_names()
,
alter_dataset()
,
auto_element_id()
,
decorate()
,
decorate_with_description()
,
decorate_with_inline_help()
,
decorate_with_label()
,
decorate_with_legend()
,
getIterator()
,
get_attributes()
,
get_class()
,
get_dataset()
,
get_ordered_children()
,
handle_assets()
,
has_class()
,
lazy_get_id()
,
offsetExists()
,
offsetGet()
,
offsetSet()
,
offsetUnset()
,
remove_class()
,
render()
,
render_attributes()
,
render_child()
,
render_children()
,
render_class()
,
render_dataset()
,
render_inner_html_for_checkbox_group()
,
render_inner_html_for_radio_group()
,
render_inner_html_for_select()
,
render_inner_html_for_textarea()
,
render_outer_html()
,
set_class()
,
set_dataset()
,
validate()
Methods inherited from ICanBoogie\Object
from()
,
resolve_facade_properties()
,
resolve_private_properties()
,
to_array()
,
to_json()
Methods inherited from ICanBoogie\ToArrayRecursive
Methods used from ICanBoogie\ToArrayRecursiveTrait
Methods used from ICanBoogie\PrototypeTrait
__call()
,
__get()
,
__set()
,
__sleep()
,
__wakeup()
,
get_prototype()
,
has_method()
,
has_property()
,
last_chance_get()
,
last_chance_set()
Magic methods summary
Constants summary
string |
PAGE
|
'#breadcrumb-page' |
|
string |
DIVIDER
|
'#breadcrumb-divider' |
|
string |
DEFAULT_DIVIDER
|
'›' |
Constants inherited from Brickrouge\Element
CHILDREN
,
DEFAULT_VALUE
,
DESCRIPTION
,
GROUP
,
GROUPS
,
INLINE_HELP
,
INNER_HTML
,
LABEL
,
LABEL_MISSING
,
LABEL_POSITION
,
LEGEND
,
OPTIONS
,
OPTIONS_DISABLED
,
REQUIRED
,
STATE
,
TYPE_CHECKBOX
,
TYPE_CHECKBOX_GROUP
,
TYPE_RADIO
,
TYPE_RADIO_GROUP
,
VALIDATOR
,
VALIDATOR_OPTIONS
,
WEIGHT
,
WIDGET_CONSTRUCTOR
Properties summary
Properties inherited from Brickrouge\Element
$auto_element_id
,
$children
,
$class_names
,
$inner_html
,
$tag_name
,
$tags
,
$type