[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/WebAsset/ -> WebAssetRegistry.php (summary)

Joomla! Content Management System

Copyright: (C) 2018 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 445 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

WebAssetRegistry:: (13 methods):
  __construct()
  get()
  add()
  remove()
  exists()
  createAsset()
  addRegistryFile()
  getRegistryFiles()
  addTemplateRegistryFile()
  addExtensionRegistryFile()
  parseRegistryFiles()
  parseRegistryFile()
  dispatchAssetChanged()


Class: WebAssetRegistry  - X-Ref

Web Asset Registry class

__construct()   X-Ref
Registry constructor


get(string $type, string $name)   X-Ref
Get an existing Asset from a registry, by asset name.

param: string  $type  Asset type, script or style
param: string  $name  Asset name
return: WebAssetItem

add(string $type, WebAssetItemInterface $asset)   X-Ref
Add Asset to registry of known assets

param: string                 $type   Asset type, script or style
param: WebAssetItemInterface  $asset  Asset instance
return: self

remove(string $type, string $name)   X-Ref
Remove Asset from registry.

param: string  $type  Asset type, script or style
param: string  $name  Asset name
return: self

exists(string $type, string $name)   X-Ref
Check whether the asset exists in the registry.

param: string  $type  Asset type, script or style
param: string  $name  Asset name
return: boolean

createAsset(string $name,string $uri = null,array $options = [],array $attributes = [],array $dependencies = [])   X-Ref
Prepare new Asset instance.

param: string  $name          The asset name
param: string  $uri           The URI for the asset
param: array   $options       Additional options for the asset
param: array   $attributes    Attributes for the asset
param: array   $dependencies  Asset dependencies
return: WebAssetItem

addRegistryFile(string $path)   X-Ref
Register new file with Asset(s) info

param: string  $path  Relative path
return: self

getRegistryFiles()   X-Ref
Get a list of the registry files

return: array

addTemplateRegistryFile(string $template, int $client)   X-Ref
Helper method to register new file with Template Asset(s) info

param: string   $template  The template name
param: integer  $client    The application client id
return: self

addExtensionRegistryFile(string $name)   X-Ref
Helper method to register new file with Extension Asset(s) info

param: string  $name  A full extension name, actually a name in the /media folder, eg: com_example, plg_system_example etc.
return: self

parseRegistryFiles()   X-Ref
Parse registered files

return: void

parseRegistryFile($path)   X-Ref
Parse registry file

param: string  $path  Relative path to the data file
return: void

dispatchAssetChanged(string $type, WebAssetItemInterface $asset, string $change)   X-Ref
Dispatch an event to notify listeners about asset changes: new, remove, override
Events:
- onWebAssetRegistryChangedAssetNew       When new asset added to the registry
- onWebAssetRegistryChangedAssetOverride  When the asset overridden
- onWebAssetRegistryChangedAssetRemove    When new asset was removed from the registry

param: string                 $type    Asset type, script or style
param: WebAssetItemInterface  $asset   Asset instance
param: string                 $change  A type of change: new, remove, override
return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer