Autodoc
  • Namespace
  • Class
  • Tree

Namespaces

  • BlueTihi
    • Context
  • Brickrouge
    • Element
      • Nodes
    • Renderer
    • Widget
  • ICanBoogie
    • ActiveRecord
    • AutoConfig
    • CLDR
    • Composer
    • Core
    • Event
    • Exception
    • HTTP
      • Dispatcher
      • Request
    • I18n
      • Translator
    • Mailer
    • Modules
      • Taxonomy
        • Support
      • Thumbnailer
        • Versions
    • Object
    • Operation
      • Dispatcher
    • Prototype
    • Routes
    • Routing
      • Dispatcher
    • Session
  • Icybee
    • ActiveRecord
      • Model
    • ConfigOperation
    • Document
    • EditBlock
    • Element
      • ActionbarContextual
      • ActionbarSearch
      • ActionbarToolbar
    • FormBlock
    • Installer
    • ManageBlock
    • Modules
      • Articles
      • Cache
        • Collection
        • ManageBlock
      • Comments
        • ManageBlock
      • Contents
        • ManageBlock
      • Dashboard
      • Editor
        • Collection
      • Files
        • File
        • ManageBlock
      • Forms
        • Form
        • ManageBlock
      • I18n
      • Images
        • ManageBlock
      • Members
      • Modules
        • ManageBlock
      • Nodes
        • ManageBlock
        • Module
      • Pages
        • BreadcrumbElement
        • LanguagesElement
        • ManageBlock
        • NavigationBranchElement
        • NavigationElement
        • Page
        • PageController
      • Registry
      • Search
      • Seo
      • Sites
        • ManageBlock
      • Taxonomy
        • Terms
          • ManageBlock
        • Vocabulary
          • ManageBlock
      • Users
        • ManageBlock
        • NonceLogin
        • Roles
      • Views
        • ActiveRecordProvider
        • Collection
        • View
    • Operation
      • ActiveRecord
      • Constructor
      • Module
      • Widget
    • Rendering
  • None
  • Patron
  • PHP

Classes

  • Blueprint
  • BlueprintNode
  • BreadcrumbElement
  • Content
  • ContentModel
  • CopyOperation
  • DeleteOperation
  • EditBlock
  • ExportBlock
  • ExportOperation
  • Hooks
  • ImportOperation
  • LanguagesElement
  • ListView
  • ManageBlock
  • Model
  • Module
  • NavigationBranchElement
  • NavigationElement
  • NavigationExcludeOperation
  • NavigationIncludeOperation
  • Page
  • PageController
  • PopPage
  • PopTemplate
  • QueryOperationOperation
  • SaveOperation
  • TemplateEditorsOperation
  • UpdateTreeOperation

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
Extended by Brickrouge\Element implements ArrayAccess, IteratorAggregate, Brickrouge\HTMLStringInterface
Extended by Icybee\Modules\Pages\BreadcrumbElement
Namespace: Icybee\Modules\Pages
Located at vendor/icanboogie-modules/pages/lib/elements/breadcrumb.php

Methods summary

public static string
# markup( )

Returns the breadcrumb for the current page.

Returns the breadcrumb for the current page.

The breadcrumb is build and rendered using the #\Brickrouge\Element\Breadcrumb element.

Returns

string
public
# __construct( string $tags )

Parameters

$tags
string
$type Type of the element, it can be one of the custom types (TYPE_*) or any HTML type.

Overrides

Brickrouge\Element::__construct
protected string|null
# render_inner_html( )

Returns the HTML representation of the element's content.

Returns the HTML representation of the element's content.

The children of the element are ordered before they are rendered using the Brickrouge\Element::render_children() method.

According to their types, the following methods can be invoked to render the inner HTML of elements:

  • Brickrouge\Element::render_inner_html_for_select()
  • Brickrouge\Element::render_inner_html_for_textarea()
  • Brickrouge\Element::render_inner_html_for_checkbox_group()
  • Brickrouge\Element::render_inner_html_for_radio_group()

Returns

string|null
The content of the element. The element is to be considered _self-closing_ if null is returned.

Overrides

Brickrouge\Element::render_inner_html

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

to_array_recursive()

Methods used from ICanBoogie\ToArrayRecursiveTrait

to_array_recursive()

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

Magic properties inherited from Brickrouge\Element

$class, $dataset, $id

Magic properties inherited from ICanBoogie\Object

$prototype

Autodoc API documentation generated by ApiGen 2.8.0