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 File

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\File

Direct known subclasses

Icybee\Modules\Files\FileUpload, Icybee\Modules\Images\UploadImage

Indirect known subclasses

Icybee\Modules\Images\ImageUpload

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

Methods summary

protected static
# add_assets( Brickrouge\Document $document )

Adds assets to the document.

Adds assets to the document.

Parameters

$document
Brickrouge\Document
$document

Overrides

Brickrouge\Element::add_assets
public
# __construct( array $attributes = array() )

Parameters

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

Overrides

Brickrouge\Element::__construct
protected
# infos( )
protected
# details( mixed $path )
protected
# preview( mixed $path )
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
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
protected string
# render_outer_html( )

Returns the HTML representation of the element and its contents.

Returns the HTML representation of the element and its contents.

The attributes are filtered before they are rendered. The attributes with a false or null value are discarded as well as custom attributes, attributes that start with the has sign "#". The dataset properties—attributes starting with "data-*"—are extracted to be handled separately.

The Brickrouge\Element::alter_attributes() method is invoked to alter the attributes and the Brickrouge\Element::render_attributes() method is invoked to render them.

The Brickrouge\File::alter_dataset() method is invoked to alter the dataset and the Brickrouge\Element::render_dataset() method is invoked to render them.

If the inner HTML is null the element is self-closing.

Note: The inner HTML is rendered before the outer HTML.

Returns

string

Overrides

Brickrouge\Element::render_outer_html

Methods inherited from Brickrouge\Element

__toString(), 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_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(), 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 FILE_WITH_LIMIT '#file-with-limit'
#
string T_UPLOAD_URL '#file-upload-url'
#
string BUTTON_LABEL '#file-button-label'
#

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