Class Document

An HTML document.

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait

Extended by

Brickrouge\Document

Extended by

Icybee\Document

Namespace: Icybee
Located at vendor/icybee/icybee/lib/element/document.php

Methods summary

`public static Icybee\Document`	# `get( )` Getter hook for the use ICanBoogie\Core::$document property. Getter hook for the use ICanBoogie\Core::$document property. Returns `Icybee\Document`
`public static`	# `markup_document_title( array $args, Patron\Engine $patron, mixed $template )`
`public static string`	# `markup_document_metas( )` Returns the rendered metas of the document. Returns the rendered metas of the document. `Icybee\Document\BeforeRenderMetasEvent` is fired to collect HTTP equiv tags and meta tags. `Icybee\Document\RenderMetasEvent` is fired once the metas have been rendered into a HTML string. Returns `string`
`public static \|string`	# `markup_document_css( array $args, Patron\Engine $engine, mixed $template )` CSS assets can be collected and rendered into `LINK` elements with the `p:document:css` element. The `href` attribute is used to add an asset to the collection. The `weight` attribute specifies the weight of that asset. If the `weight` attribute is not specified, the weight of the asset is defaulted to 100. If the `href` attribute is not specified, the assets are rendered. If a template is specified the collection is passed as `this`, otherwise the collection is rendered into an HTML string of `LINK` elements. CSS assets can be collected and rendered into `LINK` elements with the `p:document:css` element. The `href` attribute is used to add an asset to the collection. The `weight` attribute specifies the weight of that asset. If the `weight` attribute is not specified, the weight of the asset is defaulted to 100. If the `href` attribute is not specified, the assets are rendered. If a template is specified the collection is passed as `this`, otherwise the collection is rendered into an HTML string of `LINK` elements. Note: Currently, the element is not rendered right away, a placeholder is inserted instead and is replaced when the `Icybee\Modules\Pages\PageController::render` event is fired. <p:document:css href = string weight = int> <!-- Content: p:with-params, template? --> </p:document:css> Example: <p:document:css href="/public/page.css" /> <p:document:css href="/public/reset.css" weight="-100" /> <p:document:css /> Produces: <link href="/public/reset.css" type="text/css" rel="stylesheet" /> <link href="/public/page.css" type="text/css" rel="stylesheet" /> Parameters `$args` `array` $args `$engine` `Patron\Engine` $engine `$template` `mixed` $template Returns `\|string`
`public static \|string`	# `markup_document_js( array $args, Patron\Engine $engine, mixed $template )` JavaScript assets can be collected and rendered into `SCRIPT` elements with the `p:document:js` element. The `href` attribute is used to add an asset to the collection. The `weight` attribute specifies the weight of that asset. If the `weight` attribute is not specified, the weight of the asset is defaulted to 100. If the `href` attribute is not specified, the assets are rendered. If a template is specified the collection is passed as `this`, otherwise the collection is rendered into an HTML string of `SCRIPT` elements. JavaScript assets can be collected and rendered into `SCRIPT` elements with the `p:document:js` element. The `href` attribute is used to add an asset to the collection. The `weight` attribute specifies the weight of that asset. If the `weight` attribute is not specified, the weight of the asset is defaulted to 100. If the `href` attribute is not specified, the assets are rendered. If a template is specified the collection is passed as `this`, otherwise the collection is rendered into an HTML string of `SCRIPT` elements. <p:document:js href = string weight = int> <!-- Content: p:with-params, template? --> </p:document:js> Example: <p:document:js href="/public/page.js" /> <p:document:js href="/public/reset.js" weight="-100" /> <p:document:js /> Produces: <script src="/public/reset.css" type="text/javascript"></script> <script src="/public/page.css" type="text/javascript"></script> Parameters `$args` `array` $args `$engine` `Patron\Engine` $engine `$template` `mixed` $template Returns `\|string`
`public`	# `__construct( )` Constructor. Constructor. Creates the Javascript and CSS collectors. Overrides `Brickrouge\Document::__construct`
`public mixed`	# `__get( string $property )` Returns the value of an inaccessible property. Returns the value of an inaccessible property. Multiple callbacks are tried in order to retrieve the value of the property: `get_<property>`: Get and return the value of the property. `lazy_get_<property>`: Get, set and return the value of the property. Because new properties are created as public the callback is only called once which is ideal for lazy loading. 3. The prototype is queried for callbacks for the `get_<property>` and `lazy_get_<property>` methods. 4. Finally, the `ICanBoogie\Object::property` event is fired to try and retrieve the value of the property. Parameters `$property` `string` $property Returns `mixed` The value of the inaccessible property. Throws `PropertyNotReadable` when the property has a protected or private scope and no suitable callback could be found to retrieve its value. `PropertyNotDefined` when the property is undefined and there is no suitable callback to retrieve its values. Overrides `ICanBoogie\Object::__get`
`protected string`	# `get_css_class( )` Returns the CSS class of the node. Returns the CSS class of the node. Returns `string`
`protected array[string]mixed`	# `get_css_class_names( )` Returns the CSS class names of the node. Returns the CSS class names of the node. Returns `array[string]mixed`
`public string`	# `css_class( string\|array $modifiers = null )` Return the CSS class of the node. Return the CSS class of the node. Parameters `$modifiers` `string\|array` $modifiers CSS class names modifiers Returns `string`

Methods inherited from Brickrouge\Document

__unset_assets(), add_assets(), get_assets(), resolve_url(), set_assets()

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(), __set(), __sleep(), __wakeup(), get_prototype(), has_method(), has_property(), last_chance_get(), last_chance_set()

Magic methods summary

Properties summary

`public mixed`	`$title`	#
`public mixed`	`$page_title`	#

Properties inherited from Brickrouge\Document

$body, $css, $js

Magic properties inherited from Brickrouge\Document

Magic properties inherited from ICanBoogie\Object