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

添加对魔术方法调用的支持

__call( method, mixed||string|int arguments) :

抛出	`BadMethodCallException`
自	4.0.0

参数

方法: string方法名称
参数: array<string|int, mixed>方法参数

响应

混合

类构造函数

__construct(\Joomla\CMS\WebAsset\WebAssetRegistry registry) :

自	4.0.0

参数

注册表: WebAssetRegistryWeb 资产注册表实例

响应

混合

添加新的内联内容资产。

addInline( type, \Joomla\CMS\WebAsset\WebAssetItem|string content, mixed||string|int options = [], mixed||string|int attributes = [], mixed||string|int dependencies = []) :

允许通过调用 addInline($type, $assetInstance) 在注册表中注册 WebAssetItem 实例。或者通过调用 addInline($type, $content, $options ....) 创建一个资产并在注册表中注册。

自	4.0.0
抛出	`InvalidArgumentException`

参数

类型: string资产类型，脚本或样式
内容: WebAssetItem|string内联资产的内容
选项: array<string|int, mixed>资产的附加选项
属性: array<string|int, mixed>资产的属性
依赖项: array<string|int, mixed>资产依赖项

响应

自身

addInlineScript(\Joomla\CMS\WebAsset\WebAssetItem|string content,  options = [],  attributes = [],  dependencies = []) : \Joomla\CMS\WebAsset\WebAssetManager

参数

内容: WebAssetItem|string
选项: 混合
属性: 混合
依赖项: 混合

响应

WebAssetManager

addInlineStyle(\Joomla\CMS\WebAsset\WebAssetItem|string content,  options = [],  attributes = [],  dependencies = []) : \Joomla\CMS\WebAsset\WebAssetManager

参数

内容: WebAssetItem|string
选项: 混合
属性: 混合
依赖项: 混合

响应

WebAssetManager

帮助方法，用于检查资产是否存在于注册表中。

assetExists( type,  name) :

自	4.0.0

参数

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

响应

布尔值

通过其依赖项计算活动资产的权重

calculateOrderOfActiveAssets( type) : \Joomla\CMS\WebAsset\WebAssetItem||string|int

自	4.0.0

参数

类型: string资产类型，脚本或样式

响应

array<string|int, WebAssetItem>

帮助方法，用于调用实现 WebAssetAttachBehaviorInterface 的脚本资产的 onAttachCallback

callOnAttachCallback(mixed||string|int assets, \Joomla\CMS\Document\Document document, mixed||string|int cache = []) : mixed||string|int

静态

自	5.1.0

参数

资产: array<string|int, mixed>资产数组
文档: Document要附加的文档实例
缓存: array<string|int, mixed>已调用回调的对象 ID 数组

响应

array<string|int, mixed>已调用回调的对象 ID 数组

停用资产项，使其不会附加到文档

disableAsset( type,  name) :

抛出

抛出	`UnknownAssetException`当找不到资产时 `InvalidActionException`当管理器已附加到文档时
自	4.0.0

UnknownAssetException当找不到资产时

InvalidActionException当管理器已附加到文档时

自

4.0.0

参数

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

响应

自身

disablePreset( name) : \Joomla\CMS\WebAsset\WebAssetManager

参数

名称: 混合

响应

WebAssetManager

停用预设项提供的资产列表。

disablePresetItems( name) :

抛出	`UnsatisfiedDependencyException`当找不到资产依赖项时
自	4.0.0

参数

名称: string资产名称

响应

自身

disableScript( name) : \Joomla\CMS\WebAsset\WebAssetManager

参数

名称: 混合

响应

WebAssetManager

disableStyle( name) : \Joomla\CMS\WebAsset\WebAssetManager

参数

名称: 混合

响应

WebAssetManager

更新所有活动资产或仅更新给定资产的依赖项状态

enableDependencies( type = null, \Joomla\CMS\WebAsset\WebAssetItem asset = null) :

自	4.0.0

参数

类型: string资产类型，脚本或样式
资产: WebAssetItem需要启用依赖项的资产实例

响应

自身

帮助方法，用于过滤内联资产

filterOutInlineAssets(\Joomla\CMS\WebAsset\WebAssetItem||string|int &assets) : \Joomla\CMS\WebAsset\WebAssetItem||string|int

自	4.0.0

参数

资产: array<string|int, WebAssetItem>对活动资产完整列表的引用

响应

array<string|int, WebAssetItem>内联资产数组

帮助方法，用于从注册表中获取资产。

getAsset( type,  name) : \Joomla\CMS\WebAsset\WebAssetItemInterface

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

参数

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

响应

WebAssetItemInterface

获取所有活动资产，可以选择将其排序以遵循依赖项图

getAssets( type,  sort = false) : \Joomla\CMS\WebAsset\WebAssetItem||string|int

抛出

抛出	`UnknownAssetException`当找不到资产时 `UnsatisfiedDependencyException`当找不到依赖项时
自	4.0.0

UnknownAssetException当找不到资产时

UnsatisfiedDependencyException当找不到依赖项时

自

4.0.0

参数

类型: string资产类型，脚本或样式
排序: bool是否需要排序资产以遵循依赖项图

响应

array<string|int, WebAssetItem>

获取资产的状态

getAssetState( type,  name) :

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

参数

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

响应

整型

为给定资产构建出站和入站连接图。

getConnectionsGraph(\Joomla\CMS\WebAsset\WebAssetItem||string|int assets) : mixed||string|int

自	4.0.0

参数

资产: array<string|int, WebAssetItem>资产实例

响应

array<string|int, mixed>

将资产的依赖项作为 WebAssetItem 对象数组返回

getDependenciesForAsset( type, \Joomla\CMS\WebAsset\WebAssetItem asset,  recursively = false,  recursionType = null, \Joomla\CMS\WebAsset\WebAssetItem recursionRoot = null) : mixed||string|int

抛出	`UnsatisfiedDependencyException`当找不到依赖项时
自	4.0.0

参数

类型: string资产类型，脚本或样式
资产: WebAssetItem资产实例
递归: bool是否递归搜索依赖项
递归类型: string初始项的类型，以防止循环
递归根: WebAssetItem初始项，以防止循环

响应

array<string|int, mixed>

帮助方法，用于计算内联到非内联关系（前后位置）。

getInlineRelation(\Joomla\CMS\WebAsset\WebAssetItem||string|int assets) : mixed||string|int

返回一个关联数组，该数组包含依赖项（句柄）名称作为键，以及每个位置的内联项列表。例如：['handle.name' => ['before' => ['inline1', 'inline2'], 'after' => ['inline3', 'inline4']]]

注意：如果内联资产具有多个依赖项，则将使用列表中的最后一个依赖项进行定位

自	4.0.0

参数

资产: array<string|int, WebAssetItem>资产列表

响应

array<string|int, mixed>

获取管理器状态。注册表文件和活动资产名称（按类型）的集合。

getManagerState() : mixed||string|int

自	4.0.0

响应

array<string|int, mixed>

获取关联的注册表实例

getRegistry() : \Joomla\CMS\WebAsset\WebAssetRegistry

自	4.0.0

响应

WebAssetRegistry

检查资产是否已启用

isAssetActive( type,  name) :

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

参数

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

响应

布尔值

锁定管理器以防止进一步修改

lock() :

自	4.0.0

响应

自身

registerAndUsePreset(\Joomla\CMS\WebAsset\WebAssetItem|string asset,  uri = '\'\'',  options = [],  attributes = [],  dependencies = []) : \Joomla\CMS\WebAsset\WebAssetManager

参数

资产: WebAssetItem|string
uri: 字符串
选项: 混合
属性: 混合
依赖项: 混合

响应

WebAssetManager

registerAndUseScript(\Joomla\CMS\WebAsset\WebAssetItem|string asset,  uri = '\'\'',  options = [],  attributes = [],  dependencies = []) : \Joomla\CMS\WebAsset\WebAssetManager

参数

资产: WebAssetItem|string
uri: 字符串
选项: 混合
属性: 混合
依赖项: 混合

响应

WebAssetManager

registerAndUseStyle(\Joomla\CMS\WebAsset\WebAssetItem|string asset,  uri = '\'\'',  options = [],  attributes = [],  dependencies = []) : \Joomla\CMS\WebAsset\WebAssetManager

参数

资产: WebAssetItem|string
uri: 字符串
选项: 混合
属性: 混合
依赖项: 混合

响应

WebAssetManager

注册新的资产。

registerAsset( type, \Joomla\CMS\WebAsset\WebAssetItem|string asset,  uri = '', mixed||string|int options = [], mixed||string|int attributes = [], mixed||string|int dependencies = []) :

允许通过调用 registerAsset($type, $assetInstance) 在注册表中注册 WebAssetItem 实例。或者通过调用 registerAsset($type, $assetName, $uri, $options ....) 创建一个资产并在注册表中注册。

自	4.0.0
抛出	`InvalidArgumentException`

参数

类型: string资产类型，脚本或样式
资产: WebAssetItem|string要注册的资产名称或实例
uri: string资产的 URI
选项: array<string|int, mixed>资产的附加选项
属性: array<string|int, mixed>资产的属性
依赖项: array<string|int, mixed>资产依赖项

响应

自身

registerPreset(\Joomla\CMS\WebAsset\WebAssetItem|string asset,  uri = '\'\'',  options = [],  attributes = [],  dependencies = []) : \Joomla\CMS\WebAsset\WebAssetManager

参数

资产: WebAssetItem|string
uri: 字符串
选项: 混合
属性: 混合
依赖项: 混合

响应

WebAssetManager

registerScript(\Joomla\CMS\WebAsset\WebAssetItem|string asset,  uri = '\'\'',  options = [],  attributes = [],  dependencies = []) : \Joomla\CMS\WebAsset\WebAssetManager

参数

资产: WebAssetItem|string
uri: 字符串
选项: 混合
属性: 混合
依赖项: 混合

响应

WebAssetManager

registerStyle(\Joomla\CMS\WebAsset\WebAssetItem|string asset,  uri = '\'\'',  options = [],  attributes = [],  dependencies = []) : \Joomla\CMS\WebAsset\WebAssetManager

参数

资产: WebAssetItem|string
uri: 字符串
选项: 混合
属性: 混合
依赖项: 混合

响应

WebAssetManager

清除所有收集的项目。

reset() :

自	4.1.1

响应

自身

启用资产项以附加到文档

useAsset( type,  name) :

抛出

抛出	`UnknownAssetException`当找不到资产时 `InvalidActionException`当管理器已附加到文档时
自	4.0.0

UnknownAssetException当找不到资产时

InvalidActionException当管理器已附加到文档时

自

4.0.0

参数

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

响应

自身

usePreset( name) : \Joomla\CMS\WebAsset\WebAssetManager

参数

名称: 混合

响应

WebAssetManager

启用预设项提供的资产列表。

usePresetItems( name) :

“预设”是一种特殊的资产，它包含一个资产列表，这些资产必须启用，与直接调用每个列表项的 useAsset() 相同。可以包含不同类型的资产（脚本、样式、其他预设等），类型在资产名称后的 # 符号后提供，例如：foo#style、bar#script。

该方法为其每个依赖项内部调用 useAsset()，这对于保持已启用项的 FIFO 顺序非常重要。预设不是严格的资产，可以通过 disableAsset() 在以后安全地禁用其每个依赖项。

抛出	`UnsatisfiedDependencyException`当找不到资产依赖项时
自	4.0.0

参数

名称: string资产名称

响应

自身

useScript( name) : \Joomla\CMS\WebAsset\WebAssetManager

参数

名称: 混合

响应

WebAssetManager

useStyle( name) : \Joomla\CMS\WebAsset\WebAssetManager

参数

名称: 混合

响应

WebAssetManager

标记非活动资产

值	0
自	4.0.0

类型

整型

标记活动资产。刚刚启用，但没有解析依赖项

值	1
自	4.0.0

类型

整型

标记作为另一个资产的依赖项而启用的活动资产

值	2
自	4.0.0

类型

整型

Web 资产注册表实例

自	4.0.0

类型

WebAssetRegistry

活动资产列表（包括其依赖项）。

名称 => 状态数组

自	4.0.0

类型

array<string|int, mixed>

内部标记，用于检查管理器状态，以防止在渲染资产后使用管理器

自	4.0.0

类型

布尔值

内部标记，用于跟踪何时需要重新检查依赖项

自	4.0.0

类型

布尔值

用于存储排序资产列表的缓存。由 getAssets() 方法使用。当依赖项实际化时，该缓存将清空，请参见 enableDependencies() 方法

自	5.1.0

类型

array<string|int, mixed>