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 Group

A <FIELDSET> element with an optional <LEGEND> element.

The direct children of the element are wrapped in a DIV.field element, see the Brickrouge\Group::render_child() method for more information.

Localization:

  • Labels defined using the Brickrouge\Element::LABEL attribute are translated within the

'group.label|element.label' scope.

  • Legends defined using the Brickrouge\Element::LEGEND attribute are translated within the 'group.legend'

scope.

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

Direct known subclasses

ICanBoogie\Modules\Thumbnailer\AdjustThumbnailOptions, ICanBoogie\Modules\Thumbnailer\AdjustThumbnailVersion, Icybee\Element\Group, Icybee\Modules\Forms\EmailComposer, WdEMailNotifyElement

Indirect known subclasses

Brickrouge\Widget\AdjustThumbnailVersion

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

Methods summary

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

Creates a <FIELDSET.group> element.

Creates a <FIELDSET.group> element.

Parameters

$attributes
array
$attributes

Overrides

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

Adds the no-legend class name if the group has no legend (the Brickrouge\Element::LEGEND attribute is empty).

Adds the no-legend class name if the group has no legend (the Brickrouge\Element::LEGEND attribute is empty).

Parameters

$class_names
array
$class_names

Returns

array

Overrides

Brickrouge\Element::alter_class_names
protected string
# render_child( Brickrouge\Element|string $child )

Override the method to render the child in a <DIV.field> wrapper:

Override the method to render the child in a <DIV.field> wrapper:

<div class="field [{normalized_field_name}][required]"> [<label for="{element_id}" class="input-label [required]">{element_form_label}</label>] <div class="input">{child}</div> </div>

Parameters

$child
Brickrouge\Element|string
$child

Returns

string

Overrides

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

Prepends the inner HTML with a description and a legend.

Prepends the inner HTML with a description and a legend.

If the Brickrouge\Element::DESCRIPTION attribute is defined the HTML is prepend with a DIV.group-description>DIV.group-description-inner element. The description is translated within the "group.description" scope. The description is not escaped.

If the Brickrouge\Element::LEGEND attribute is defined the HTML is prenpend with a <LEGEND> element. The legend can be provided as an object in which it is used _as is_, otherwise the legend is translated within the "group.legend" scope, then escaped.

The legend element is rendered using the Brickrouge\Group::render_group_legend() method.

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
protected string
# render_group_legend( string $legend )

Renders the group legend.

Renders the group legend.

Parameters

$legend
string
$legend The legend to render.

Returns

string
a legend.group-legend HTML element.
protected string
# render_group_description( string $description )

Renders the group description

Renders the group description

Parameters

$description
string
$description

Returns

string
a div.group-description>div.group-description-inner element.
protected string
# decorate_with_description( string $html, string $description )

The description decoration is disabled because the Brickrouge\Element::DESCRIPTION attribute is rendered by the Brickrouge\Group::render_inner_html() method to prepend the inner HTML.

The description decoration is disabled because the Brickrouge\Element::DESCRIPTION attribute is rendered by the Brickrouge\Group::render_inner_html() method to prepend the inner HTML.

Parameters

$html
string
$html
$description
string
$description

Returns

string

Overrides

Brickrouge\Element::decorate_with_description
protected string
# decorate_with_legend( string $html, string $legend )

The legend decoration is disabled because the Brickrouge\Element::LEGEND attribute is rendered by the Brickrouge\Group::render_inner_html() method to prepend the inner HTML.

The legend decoration is disabled because the Brickrouge\Element::LEGEND attribute is rendered by the Brickrouge\Group::render_inner_html() method to prepend the inner HTML.

Parameters

$html
string
$html
$legend
string
$legend

Returns

string

Overrides

Brickrouge\Element::decorate_with_legend

Methods inherited from Brickrouge\Element

__toString(), add_assets(), add_class(), adopt(), alter_attributes(), alter_dataset(), auto_element_id(), decorate(), decorate_with_inline_help(), decorate_with_label(), 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_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

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