Class Document

An HTML document.

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

Extended by

Brickrouge\Document

Direct known subclasses

Icybee\Document

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

Methods summary

`public`	# `__construct( )` Constructor. Constructor. Creates the Javascript and CSS collectors.
`protected array`	# `get_assets( )` Returns the Javascript and CSS assets used by the document as an array or URLs. Returns the Javascript and CSS assets used by the document as an array or URLs. Returns `array` The assets used by the document.
`protected`	# `set_assets( array $assets )` Sets the assets of the document. Sets the assets of the document. Parameters `$assets` `array` $assets An array where CSS and JS assets are stored under the 'css' and 'js' keys respectively. Each asset is defined as a key/value pair where the key if the path to the asset and the key is its priority. Example $document->assets = array ( 'css' => array('brickrouge.css' => 0), 'js' => array('brickrouge.js' => 0) );
`protected`	# `__unset_assets( )` Clears JS and CSS assets. Clears JS and CSS assets. Example $document->js->add('brickrouge.js'); $document->css->add('brickrouge.css'); var_dump($document->assets); // ['css' => ['brickrouge.css'], 'js' => ['brickrouge.js']] unset($document->assets); var_dump($document->assets); // ['css' => [], 'js' => []]
`public`	# `add_assets( array $assets )` Adds a number of assets to the document. Adds a number of assets to the document. Parameters `$assets` `array` $assets An array where CSS and JS assets are stored under the 'css' and 'js' keys respectively. Each asset is defined as a key/value pair where the key if the path to the asset and the key is its priority. Example $document->add_assets ( array ( 'css' => array('brickrouge.css' => 0), 'js' => array('brickrouge.js' => 0) ) );
`public static string`	# `resolve_url( string $path, string $relative = null )` Resolves a server path into a URL accessible from the `DOCUMENT_ROOT`. Resolves a server path into a URL accessible from the `DOCUMENT_ROOT`. Unless the path uses a scheme (http://, https:// or phar://) it is always considered relative to the path specified by the $relative parameter or to the `DOCUMENT_ROOT`. Parameters `$path` `string` $path `$relative` `string` $relative Relative path that can be used to resolve the path. If the parameter is null the method tries to _guess_ the relative path using the resolve_root() private method. Returns `string` The URL resolved from the path.

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

Properties summary

`public mixed`	`$body`	#
`public Brickrouge\JSCollector`	`$js`	# Collector for Javascript assets. Collector for Javascript assets.
`public Brickrouge\CSSCollector`	`$css`	# Collector for CSS assets. Collector for CSS assets.

Magic properties

`public mixed`	`$assets`		# array The Javascript and CSS assets used by the document. array The Javascript and CSS assets used by the document.

Magic properties inherited from ICanBoogie\Object