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 Widget

An HTML element.

The Element class can create any kind of HTML element. It supports class names, dataset, children. It handles values and default values. It can decorate the HTML element with a label, a legend and a description.

This is the base class to all element types.

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

Direct known subclasses

ICanBoogie\Modules\Thumbnailer\PopThumbnailVersion, Icybee\Modules\Images\AdjustThumbnail, Icybee\Modules\Nodes\PopNode, Icybee\Modules\Nodes\TitleSlugCombo

Indirect known subclasses

Brickrouge\Widget\AdjustThumbnail, Brickrouge\Widget\PopThumbnailVersion, Icybee\Modules\Editor\ImageEditorElement, Icybee\Modules\Images\PopImage

Abstract
Namespace: Brickrouge
See: http://dev.w3.org/html5/spec/Overview.html#embedding-custom-non-visible-data-with-the-data-attributes
Located at vendor/icybee/icybee/lib/widget/widget.php

Methods summary

public
# __construct( string $type, array $attributes = array() )

Interpolates a widget constructor name from the widget class.

Interpolates a widget constructor name from the widget class.

Parameters

$type
string
$type
$attributes
array
$attributes

Overrides

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

Renders the class attribute value.

Renders the class attribute value.

Parameters

$class_names
array
$class_names An array of class names. Each key/value pair describe a class name. The key is the identifier of the class name, the value is its value. If the value is empty then the class name is discarted. If the value is true the identifier of the class name is used as value.

Returns

string

Overrides

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

Alters the dataset.

Alters the dataset.

The method is invoked before the dataset is rendered.

The method might add the default-value and widget-constructor keys.

Parameters

$dataset
array
$dataset

Returns

array

Overrides

Brickrouge\Element::alter_dataset
public
# get_results( array $options = array() )

Methods inherited from Brickrouge\Element

__toString(), add_assets(), add_class(), adopt(), alter_attributes(), alter_class_names(), 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_dataset(), render_inner_html(), 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 CONSTRUCTOR '#widget-constructor'
#

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