Joomla! CMS 5.1.x API » \Joomla\CMS\WebAsset\WebAssetRegistry

注册表构造函数

__construct() :

自	4.0.0

响应

混合

将资源添加到已知资源的注册表中

add( type, \Joomla\CMS\WebAsset\WebAssetItemInterface asset) :

自	4.0.0

参数

类型: string资源类型，脚本或样式
资源: WebAssetItemInterface资源实例

响应

自身

辅助方法，用于使用扩展资源信息注册新文件

addExtensionRegistryFile( name) :

自	4.0.0

参数

名称: string完整的扩展名，实际上是 /media 文件夹中的名称，例如：com_example、plg_system_example 等。

响应

自身

使用资源信息注册新文件

addRegistryFile( path) :

自	4.0.0

参数

路径: string相对路径

响应

自身

辅助方法，用于使用模板资源信息注册新文件

addTemplateRegistryFile( template,  client) :

自	4.0.0

参数

模板: string模板名称
客户端: int应用程序客户端 ID

响应

自身

准备新的资源实例。

createAsset( name,  uri = null, mixed||string|int options = [], mixed||string|int attributes = [], mixed||string|int dependencies = []) : \Joomla\CMS\WebAsset\WebAssetItem

自	4.0.0

参数

名称: string资源名称
URI: string资源的 URI
选项: array<string|int, mixed>资源的其他选项
属性: array<string|int, mixed>资源的属性
依赖项: array<string|int, mixed>资源依赖项

响应

WebAssetItem

分派事件以通知侦听器有关资源更改的信息：新资源、删除资源、覆盖事件

onWebAssetRegistryChangedAssetNew 当向注册表添加新资源时
onWebAssetRegistryChangedAssetOverride 当资源被覆盖时
onWebAssetRegistryChangedAssetRemove 当新资源从注册表中删除时

dispatchAssetChanged( type, \Joomla\CMS\WebAsset\WebAssetItemInterface asset,  change) :

自	4.0.0

参数

类型: string资源类型，脚本或样式
资源: WebAssetItemInterface资源实例
更改: string更改类型：新资源、删除资源、覆盖资源

响应

空

检查资源是否存在于注册表中。

exists( type,  name) :

自	4.0.0

参数

类型: string资源类型，脚本或样式
名称: string资源名称

响应

布尔值

从注册表中获取现有资源，通过资源名称。

get( type,  name) : \Joomla\CMS\WebAsset\WebAssetItem

抛出	`UnknownAssetException`当找不到资源时
自	4.0.0

参数

类型: string资源类型，脚本或样式
名称: string资源名称

响应

WebAssetItem

获取注册表文件的列表

getRegistryFiles() : mixed||string|int

自	4.0.0

响应

array<string|int, mixed>

解析注册表文件

parseRegistryFile( path) :

抛出	`RuntimeException`如果文件为空或无效
自	4.0.0

参数

路径: string数据文件的相对路径

响应

空

解析已注册的文件

parseRegistryFiles() :

自	4.0.0

响应

空

从注册表中删除资源。

remove( type,  name) :

自	4.0.0

参数

类型: string资源类型，脚本或样式
名称: string资源名称

响应

自身

包含资源信息的。文件路径应为相对路径。

示例	注册表文件 { "title" : "Example", "name" : "com_example", "author": "Joomla! CMS", "assets": [ { "name": "library1", "version": "3.5.0", "type": "script", "uri": "com_example/library1.min.js" }, { "name": "library2", "version": "3.5.0", "type": "script", "uri": "com_example/library2.min.js", "dependencies": [ "core", "library1" ], "attribute": { "attr-name": "attr value" "defer": true } }, { "name": "library1", "version": "3.5.0", "type": "style", "uri": "com_example/library1.min.css" "attribute": { "media": "all" } }, { "name": "library1", "type": "preset", "dependencies": { "library1#style", "library1#script" } }, ] }
自	4.0.0

示例

注册表文件

{ "title" : "Example", "name" : "com_example", "author": "Joomla! CMS", "assets": [ { "name": "library1", "version": "3.5.0", "type": "script", "uri": "com_example/library1.min.js" }, { "name": "library2", "version": "3.5.0", "type": "script", "uri": "com_example/library2.min.js", "dependencies": [ "core", "library1" ], "attribute": { "attr-name": "attr value" "defer": true } }, { "name": "library1", "version": "3.5.0", "type": "style", "uri": "com_example/library1.min.css" "attribute": { "media": "all" } }, { "name": "library1", "type": "preset", "dependencies": { "library1#style", "library1#script" } }, ] }

自

4.0.0

类型(s)

array<string|int, mixed>

已解析文件的列表

自	4.0.0

类型(s)

array<string|int, mixed>

可用资源的注册表

自	4.0.0

类型(s)

array<string|int, mixed>

WebAssetRegistry

方法

__construct

响应

add

参数

响应

addExtensionRegistryFile

参数

响应

addRegistryFile

参数

响应

addTemplateRegistryFile

参数

响应

createAsset

参数

响应

dispatchAssetChanged

参数

响应

exists

参数

响应

get

参数

响应

getRegistryFiles

响应

parseRegistryFile

参数

响应

parseRegistryFiles

响应

remove

参数

响应

属性

dataFilesNew

类型(s)

dataFilesParsed

类型(s)

资源

类型(s)