PHP Класс Themosis\Asset\Asset

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$action Themosis\Hook\ActionBuilder
$allowedAreas array Allowed areas.
$area string The default area where to load assets.
$args array WordPress properties of an asset.
$filter Themosis\Hook\FilterBuilder
$html Themosis\Html\HtmlBuilder
$instances array A list of all Asset instances.
$instantiated array A list of enqueued assets.
$key string Asset key name.
$type string Type of the asset.

Открытые методы

Метод Описание
__construct ( string $type, array $args, Themosis\Hook\IHook $action, HtmlBuilder $html, Themosis\Hook\IHook $filter ) Build an Asset instance.
addAttributes ( array $atts ) : Asset Add attributes to the asset opening tag.
getArea ( ) : string Return the asset area.
getArgs ( string $name = '' ) : array | string Return the asset properties. If $name isset, return its value.
getKey ( ) : string Return the asset key.
getType ( ) : string Return the asset type.
inline ( string $data, string $position = 'after' ) : Asset Add inline code before or after the loaded asset.
install ( ) Install the appropriate asset depending of its area.
isQueued ( ) : boolean Tells if an asset is queued or not.
localize ( string $objectName, mixed $data ) : Asset Localize data for the linked asset.
remove ( ) : Asset Remove a declared asset.
to ( string $area ) : Asset Allow the developer to define where to load the asset.

Защищенные методы

Метод Описание
orderInstances ( ) Manipulate the static::$instances variable in order to separate each asset in its area.
parse ( array $args ) : mixed Parse defined asset properties.
parseMixed ( $mixed ) : string | boolean Parse the mixed argument.
parseVersion ( string | boolean | null $version ) : mixed Parse the version number.
register ( Asset $asset ) Register the asset.
registerInline ( Asset $asset ) Register inline code.
registerInstance ( ) Register asset instances.
registerScript ( Asset $asset ) Register a 'script' asset.
registerStyle ( Asset $asset ) Register a 'style' asset.

Описание методов

__construct() публичный Метод

Build an Asset instance.
public __construct ( string $type, array $args, Themosis\Hook\IHook $action, HtmlBuilder $html, Themosis\Hook\IHook $filter )
$type string
$args array
$action Themosis\Hook\IHook
$html Themosis\Html\HtmlBuilder
$filter Themosis\Hook\IHook

addAttributes() публичный Метод

Add attributes to the asset opening tag.
public addAttributes ( array $atts ) : Asset
$atts array The asset attributes to add.
Результат Asset

getArea() публичный Метод

Return the asset area.
public getArea ( ) : string
Результат string

getArgs() публичный Метод

If nothing is defined, return all properties.
public getArgs ( string $name = '' ) : array | string
$name string The argument name.
Результат array | string

getKey() публичный Метод

Return the asset key.
public getKey ( ) : string
Результат string

getType() публичный Метод

Return the asset type.
public getType ( ) : string
Результат string

inline() публичный Метод

Default to "after".
public inline ( string $data, string $position = 'after' ) : Asset
$data string The inline code to output.
$position string Accepts "after" or "before" as values. Note that position is only working for JS assets.
Результат Asset

install() публичный Метод

Install the appropriate asset depending of its area.
public install ( )

isQueued() публичный Метод

Tells if an asset is queued or not.
public isQueued ( ) : boolean
Результат boolean

localize() публичный Метод

Output JS object right before the script output.
public localize ( string $objectName, mixed $data ) : Asset
$objectName string The name of the JS variable that will hold the data.
$data mixed Any data to attach to the JS variable: string, boolean, object, array, ...
Результат Asset

orderInstances() защищенный Метод

Manipulate the static::$instances variable in order to separate each asset in its area.
protected orderInstances ( )

parse() защищенный Метод

Parse defined asset properties.
protected parse ( array $args ) : mixed
$args array The asset properties.
Результат mixed

parseMixed() защищенный Метод

Parse the mixed argument.
protected parseMixed ( $mixed ) : string | boolean
$mixed
Результат string | boolean

parseVersion() защищенный Метод

Parse the version number.
protected parseVersion ( string | boolean | null $version ) : mixed
$version string | boolean | null
Результат mixed

register() защищенный Метод

Register the asset.
protected register ( Asset $asset )
$asset Asset

registerInline() защищенный Метод

Register inline code.
protected registerInline ( Asset $asset )
$asset Asset

registerInstance() защищенный Метод

Register asset instances.
protected registerInstance ( )

registerScript() защищенный Метод

Register a 'script' asset.
protected registerScript ( Asset $asset )
$asset Asset

registerStyle() защищенный Метод

Register a 'style' asset.
protected registerStyle ( Asset $asset )
$asset Asset

remove() публичный Метод

Remove a declared asset.
public remove ( ) : Asset
Результат Asset

to() публичный Метод

Only 'admin', 'login' and 'customizer' are accepted. If none of those values are used, simply keep the default front-end area.
public to ( string $area ) : Asset
$area string Specify where to load the asset: 'admin', 'login' or 'customizer'.
Результат Asset

Описание свойств

$action защищенное свойство

protected ActionBuilder,Themosis\Hook $action
Результат Themosis\Hook\ActionBuilder

$allowedAreas защищенное свойство

Allowed areas.
protected array $allowedAreas
Результат array

$area защищенное свойство

The default area where to load assets.
protected string $area
Результат string

$args защищенное свойство

WordPress properties of an asset.
protected array $args
Результат array

$filter защищенное свойство

protected FilterBuilder,Themosis\Hook $filter
Результат Themosis\Hook\FilterBuilder

$html защищенное свойство

protected HtmlBuilder,Themosis\Html $html
Результат Themosis\Html\HtmlBuilder

$instances защищенное статическое свойство

A list of all Asset instances.
protected static array $instances
Результат array

$instantiated защищенное статическое свойство

A list of enqueued assets.
protected static array $instantiated
Результат array

$key защищенное свойство

Asset key name.
protected string $key
Результат string

$type защищенное свойство

Type of the asset.
protected string $type
Результат string