Référence de la classe WebAssetItem

Graphe d'héritage de WebAssetItem:

Fonctions membres publiques
	__construct (string $name, string $uri=null, array $options=[], array $attributes=[], array $dependencies=[])
	getName ()
	getVersion ()
	getDependencies ()
	getUri ($resolvePath=true)
	getOption (string $key, $default=null)
	setOption (string $key, $value=null)
	getOptions ()
	getAttribute (string $key, $default=null)
	setAttribute (string $key, $value=null)
	getAttributes ()

Fonctions membres protégées
	resolvePath (string $path, string $type)
	isPathExternal (string $path)
	isPathAbsolute (string $path)

Attributs protégés
	$name = ''
	$uri = ''
	$options = []
	$attributes = []
	$dependencies = []
	$version = 'auto'

Description détaillée

Web Asset Item class

Asset Item are "read only" object, all properties must be set through class constructor. Only properties allowed to be edited is an attributes and an options. Changing an uri or a dependencies are not allowed, prefer to create a new asset instance.

Depuis

4.0.0

Documentation des constructeurs et destructeur

__construct()

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

Class constructor

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

Depuis

4.0.0

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

Documentation des fonctions membres

getAttribute()

getAttribute	(	string	$key,
			$default = null
	)

Get the attribute

Paramètres

string	$key	An attributes key
string	$default	A default value

Renvoie

mixed

Depuis

4.0.0

Implémente WebAssetItemInterface.

Références $default, et $key.

getAttributes()

getAttributes

(

)

Get all attributes

Renvoie

array

Depuis

4.0.0

Implémente WebAssetItemInterface.

Références $attributes.

getDependencies()

getDependencies

(

)

Return dependencies list

Renvoie

array

Depuis

4.0.0

Implémente WebAssetItemInterface.

getName()

getName

(

)

Return Asset name

Renvoie

string

Depuis

4.0.0

Implémente WebAssetItemInterface.

Références $name.

getOption()

getOption	(	string	$key,
			$default = null
	)

Get the option

Paramètres

string	$key	An option key
string	$default	A default value

Renvoie

mixed

Depuis

4.0.0

Implémente WebAssetItemInterface.

Références $default, et $key.

getOptions()

getOptions

(

)

Get all options

Renvoie

array

Depuis

4.0.0

Implémente WebAssetItemInterface.

Références $options.

getUri()

getUri

(

$resolvePath = true

)

Get the file path

Paramètres

boolean

$resolvePath

Whether need to search for a real paths

Renvoie

string The resolved path if resolved, else an empty string.

Depuis

4.0.0

Implémente WebAssetItemInterface.

Références $path, et $uri.

getVersion()

getVersion

(

)

Return Asset version

Renvoie

string

Depuis

4.0.0

Implémente WebAssetItemInterface.

Références $version.

isPathAbsolute()

isPathAbsolute ( string  $path )

protected

Check if the Path is relative to /media folder or absolute

Paramètres

string

$path

Path to test

Renvoie

boolean

Depuis

4.0.0

Références $path, et JPATH_ROOT.

isPathExternal()

isPathExternal ( string  $path )

protected

Check if the Path is External

Paramètres

string

$path

Path to test

Renvoie

boolean

Depuis

4.0.0

Références $path.

resolvePath()

resolvePath ( string  $path, string  $type  )

protected

Resolve path

Paramètres

string	$path	The path to resolve
string	$type	The resolver method

Renvoie

string

Depuis

4.0.0

Références $path, $type, et HTMLHelper\_().

setAttribute()

setAttribute	(	string	$key,
			$value = null
	)

Set the attribute

Paramètres

string	$key	An attribute key
string	$value	An attribute value

Renvoie

self

Depuis

4.0.0

Implémente WebAssetItemInterface.

Références $key, $this, et $value.

setOption()

setOption	(	string	$key,
			$value = null
	)

Set the option

Paramètres

string	$key	An option key
string	$value	An option value

Renvoie

self

Depuis

4.0.0

Implémente WebAssetItemInterface.

Références $key, $this, et $value.

Documentation des champs

$attributes

$attributes = []

protected

$dependencies

$dependencies = []

protected

$name

string $name = ''

protected

Asset name

Depuis

4.0.0

$options

$options = []

protected

$uri

$uri = ''

protected

$version

$version = 'auto'

protected

---

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

• WebAssetItem.php