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

  • A
  • Actions
  • Alert
  • AlterCSSClassNamesEvent
  • AssetsCollector
  • Button
  • CSSCollector
  • Dataset
  • Date
  • DateRange
  • DateTime
  • Decorator
  • Document
  • DropdownMenu
  • Element
  • File
  • Form
  • Group
  • Helpers
  • HTMLString
  • Iterator
  • JSCollector
  • ListView
  • ListViewColumn
  • Modal
  • Pager
  • Popover
  • PopoverWidget
  • Ranger
  • RecursiveIterator
  • Salutation
  • Searchbox
  • Section
  • SplitButton
  • Text
  • Widget

Interfaces

  • CSSClassNames
  • DecoratorInterface
  • HTMLStringInterface
  • Validator

Traits

  • CSSClassNamesProperty

Exceptions

  • ElementIsEmpty

Functions

  • _array_flatten_callback
  • array_flatten
  • array_insert
  • check_session
  • dump
  • escape
  • escape_all
  • format
  • format_size
  • get_accessible_file
  • get_document
  • normalize
  • render_css_class
  • render_exception
  • retrieve_form
  • retrieve_form_errors
  • shorten
  • stable_sort
  • store_form
  • store_form_errors
  • strip
  • t

Class Popover

Creates a popover element.

Brickrouge provides the Brickrouge.Popover Javascript class that can be used to give behaviour to the element, but because the element is not a widget this is not automatic and left up to you.

Use the Brickrouge\PopoverWidget to create elements with automatically attached behaviour.

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait
Extended by Brickrouge\Element implements ArrayAccess, IteratorAggregate, Brickrouge\HTMLStringInterface
Extended by Brickrouge\Popover

Direct known subclasses

Brickrouge\PopoverWidget

Namespace: Brickrouge
Located at vendor/brickrouge/brickrouge/lib/popover.php

Methods summary

public
# __construct( array $tags = array() )

Constructor.

Constructor.

The class attribute is defined in the initial tags with the value "popover". The "popover" class is used to style the element but can also be used to give the element a behaviour. If you override the class attribute you should consider adding the "popover" class name.

The element is created as a DIV element.

Parameters

$tags
array
$tags

Overrides

Brickrouge\Element::__construct
protected array
# alter_class_names( array $class_names )

Adds the 'fit-content' class name if the Brickrouge\Popover::FIT_CONTENT attribute is truthy.

Adds the 'fit-content' class name if the Brickrouge\Popover::FIT_CONTENT attribute is truthy.

Parameters

$class_names
array
$class_names

Returns

array

See

Brickrouge.Element::alter_class_names()

Overrides

Brickrouge\Element::alter_class_names
protected array
# alter_dataset( array $dataset )

Adds the anchor specified using the Brickrouge\Popover::ANCHOR special attribute to the dataset before it is rendered.

Adds the anchor specified using the Brickrouge\Popover::ANCHOR special attribute to the dataset before it is rendered.

Parameters

$dataset
array
$dataset

Returns

array

See

Brickrouge.Element::alter_dataset()

Overrides

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

The inner HTML is wrapped in a number of DIV elements, and the title is used a the popover title.

The inner HTML is wrapped in a number of DIV elements, and the title is used a the popover title.

Returns

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

See

Brickrouge.Element::render_inner_html()

Overrides

Brickrouge\Element::render_inner_html
protected string
# render_actions( mixed $actions )

Renders actions.

Renders actions.

Actions are rendering using a Brickrouge\Actions element.

Actions buttons should provide a data-action attribute with the value of the action to use when the action event is fired by Javascript.

Parameters

$actions
mixed
$actions

Returns

string

Methods inherited from Brickrouge\Element

__toString(), add_assets(), add_class(), adopt(), alter_attributes(), 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|array ACTIONS '#actions'
#

Popover actions.

Popover actions.
string ANCHOR '#anchor'
#

Anchor ID or CSS selector.

Anchor ID or CSS selector.
boolean FIT_CONTENT '#fit-content'
#

Whether the popover element should fit the content.

Whether the popover element should fit the content.

By default the popover element have a width of 280px. Setting this attribute to true adds the 'fit-content' class to the element which remove the width constraint.
string PLACEMENT '#placement'
#

Placement of the popover relative to its anchor, one of before, after, above, below, vertical, horizontal or auto.

Placement of the popover relative to its anchor, one of before, after, above, below, vertical, horizontal or auto.
string TITLE '#title'
#

Optional title of the popover.

Optional title of the popover.

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