Référence de la classe WebAssetRegistry

Graphe d'héritage de WebAssetRegistry:

Fonctions membres publiques
	__construct ()
	get (string $type, string $name)
	add (string $type, WebAssetItemInterface $asset)
	remove (string $type, string $name)
	exists (string $type, string $name)
	createAsset (string $name, string $uri=null, array $options=[], array $attributes=[], array $dependencies=[])
	addRegistryFile (string $path)
	getRegistryFiles ()
	addTemplateRegistryFile (string $template, int $client)
	addExtensionRegistryFile (string $name)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)

Fonctions membres protégées
	parseRegistryFiles ()
	parseRegistryFile ($path)
	dispatchAssetChanged (string $type, WebAssetItemInterface $asset, string $change)

Attributs protégés
	$dataFilesNew = []
	$dataFilesParsed = []
	$assets = []

Description détaillée

Web Asset Registry class

Depuis

4.0.0

Documentation des constructeurs et destructeur

__construct()

__construct

(

)

Registry constructor

Depuis

4.0.0

Références Joomla\Event\setDispatcher().

Documentation des fonctions membres

add()

add	(	string	$type,
		WebAssetItemInterface	$asset
	)

Add Asset to registry of known assets

Paramètres

string	$type	Asset type, script or style
WebAssetItemInterface	$asset	Asset instance

Renvoie

self

Depuis

4.0.0

Implémente WebAssetRegistryInterface.

Références $this, $type, et WebAssetItemInterface\getName().

addExtensionRegistryFile()

addExtensionRegistryFile

(

string

$name

)

Helper method to register new file with Extension Asset(s) info

Paramètres

string

$name

A full extension name, actually a name in the /media folder, eg: com_example, plg_system_example etc.

Renvoie

self

Depuis

4.0.0

Références $name, et $this.

addRegistryFile()

addRegistryFile

(

string

$path

)

Register new file with Asset(s) info

Paramètres

string

$path

Relative path

Renvoie

self

Depuis

4.0.0

Références $path, $this, Path\clean(), et JPATH_ROOT.

addTemplateRegistryFile()

addTemplateRegistryFile	(	string	$template,
		int	$client
	)

Helper method to register new file with Template Asset(s) info

Paramètres

string	$template	The template name
integer	$client	The application client id

Renvoie

self

Depuis

4.0.0

Références $client, $template, et $this.

createAsset()

createAsset	(	string	$name,
		string	$uri = null,
		array	$options = [],
		array	$attributes = [],
		array	$dependencies = []
	)

Prepare new Asset instance.

Paramètres

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

Renvoie

WebAssetItem

Depuis

4.0.0

Références $attributes, $className, $name, $options, $uri, et null.

dispatchAssetChanged()

dispatchAssetChanged ( string  $type, WebAssetItemInterface  $asset, string  $change  )

protected

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ètres

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

Renvoie

void

Depuis

4.0.0

Références $this, $type, AbstractEvent\create(), et Joomla\CMS\Application\getDispatcher().

exists()

exists	(	string	$type,
		string	$name
	)

Check whether the asset exists in the registry.

Paramètres

string	$type	Asset type, script or style
string	$name	Asset name

Renvoie

boolean

Depuis

4.0.0

Implémente WebAssetRegistryInterface.

Références $name, et $type.

get()

get	(	string	$type,
		string	$name
	)

Get an existing Asset from a registry, by asset name.

Paramètres

string	$type	Asset type, script or style
string	$name	Asset name

Renvoie

WebAssetItem

Exceptions

UnknownAssetException

When Asset cannot be found

Depuis

4.0.0

Implémente WebAssetRegistryInterface.

Références $name, et $type.

getRegistryFiles()

getRegistryFiles

(

)

Get a list of the registry files

Renvoie

array

Depuis

4.0.0

parseRegistryFile()

parseRegistryFile (   $path )

protected

Parse registry file

Paramètres

string

$path

Relative path to the data file

Renvoie

void

Exceptions

Références $data, $i, $item, $name, $namespace, $options, $path, $uri, JPATH_ROOT, et null.

parseRegistryFiles()

parseRegistryFiles ( )

protected

Parse registered files

Renvoie

void

Depuis

4.0.0

Références $path.

remove()

remove	(	string	$type,
		string	$name
	)

Remove Asset from registry.

Paramètres

string	$type	Asset type, script or style
string	$name	Asset name

Renvoie

self

Depuis

4.0.0

Implémente WebAssetRegistryInterface.

Références $name, $this, et $type.

Documentation des champs

$assets

$assets = []

protected

$dataFilesNew

$dataFilesNew = []

protected

$dataFilesParsed

$dataFilesParsed = []

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• WebAsset/WebAssetRegistry.php