LanguageAdapter

扩展自 InstallerAdapter

语言安装程序

3.1

Joomla CMS

方法

__construct

构造函数

__construct(\Joomla\CMS\Installer\Installer parent, \Joomla\Database\DatabaseDriver db, mixed||string|int options = []) : 
继承

3.4

参数

父级

Installer父级对象

db

DatabaseDriver数据库对象

options

array<string|int, mixed>配置选项

响应

混合

__get

db 变量的代理。

__get( name) : 
继承 已弃用

4.2.0

已弃用

4.3 将在 6.0 中移除 使用 getDatabase() 而不是直接访问 _db

参数

name

string元素的名称

响应

mixed如果设置了元素的值,则为该值,否则为 null

_install

旨在处理单个客户端的安装函数

_install( cname,  basePath,  clientId,  &element) : bool|int

3.1

参数

cname

stringCname @todo: 未使用

basePath

string基本名称。

clientId

int客户端 ID。

element

objectXML 元素。

响应

bool|int成功时的扩展 ID,失败时的布尔值 false

canUninstallPackageChild

检查包扩展是否允许单独卸载其子扩展

canUninstallPackageChild( packageId) : 
继承

3.7.0

注意

此方法默认为 true 以模拟 3.6 及更早版本的行为,这些版本不支持此查找

参数

packageId

int要检查的包的扩展 ID

响应

布尔

checkExistingExtension

检查扩展是否已存在于数据库中的方法

checkExistingExtension() : 
继承

3.4

抛出

RuntimeException

响应

checkExtensionInFilesystem

检查扩展是否存在于文件系统中的方法,如果存在则将路由标记为更新

checkExtensionInFilesystem() : 
继承

3.4

抛出

RuntimeException

响应

copyBaseFiles

<files> 标记和清单文件复制扩展基本文件的方法

copyBaseFiles() : 

3.4

抛出

RuntimeException

响应

createContentLanguage

创建一个未发布的内容语言。

createContentLanguage( tag) : 
抛出

异常

4.0.0

参数

tag

mixedstring 语言标签

响应

混合

createExtensionRoot

如果需要,创建扩展根路径的方法

createExtensionRoot() : 
继承

3.4

抛出

RuntimeException

响应

discover

自定义发现方法 查找语言文件

discover() : \Joomla\CMS\Table\Extension||string|int

3.1

响应

array<string|int, Extension>已发现扩展的数组。

discover_install

自定义发现安装方法 基本上更新清单缓存并保持所有内容不变

discover_install() : 

3.1

响应

int扩展 ID

doDatabaseTransactions

处理安装程序数据库事务的方法

doDatabaseTransactions() : 
继承

3.4

抛出

RuntimeException

响应

bool成功时为 True

doLoadLanguage

加载语言文件

doLoadLanguage( extension,  source,  base = JPATH_ADMINISTRATOR) : 
继承

3.4

参数

extension

string扩展的名称

source

string扩展的路径

base

string扩展语言的基本路径

响应

finaliseInstall

完成安装处理的方法

finaliseInstall() : 

4.0.0

抛出

RuntimeException

响应

finaliseUninstall

完成卸载处理的方法

finaliseUninstall() : 

4.0.0

抛出

RuntimeException

响应

布尔

getDiscoverInstallSupported

检查适配器是否支持 discover_install

getDiscoverInstallSupported() : 
继承

3.4

响应

布尔

getElement

从清单中获取已过滤的扩展元素

getElement( element = null) : 
继承

3.4

参数

element

string要转换的可选元素名称

响应

string已过滤的元素

getManifest

获取清单对象。

getManifest() : \SimpleXMLElement
继承

3.4

响应

SimpleXMLElement清单对象

getName

从清单中获取已过滤的组件名称

getName() : 
继承

3.4

响应

string已过滤的名称

getParent

检索父安装程序

getParent() : \Joomla\CMS\Installer\Installer
继承

4.0.0

响应

安装程序

getRoute

获取正在使用的安装路由

getRoute() : 
继承

3.4

响应

string安装路由

getScriptClassName

获取安装适配器脚本的类名。

getScriptClassName() : 
继承

3.4

响应

string类名。

getSefString

获取唯一的语言 SEF 字符串。

getSefString( itemLanguageTag) : 

此函数检查其他具有相同代码的现有语言,如果它们存在则提供唯一的 SEF 名称。例如:en-GB、en-US 和 en-AU 默认情况下将共享相同的 SEF 代码:www.mywebsite.com/en/ 为避免此冲突,此函数在存在冲突的情况下创建特定的 SEF:例如:www.mywebsite.com/en-au/

3.7.0

参数

itemLanguageTag

string语言标签。

响应

字符串

install

自定义安装方法

install() : bool|int

注意:由于在 1.5.x 中间进行的黑客攻击以添加一次安装多个不同包的功能,因此此方法的行为很糟糕。首选方法是使用包安装多个语言包。

3.1

响应

bool|int成功时的扩展 ID,失败时的布尔值 false

parseOptionalTags

解析清单中可选标记的方法

parseOptionalTags() : 
继承

3.1

响应

parseQueries

解析在 <sql> 标记中指定的查询的方法

parseQueries() : 
继承

3.4

抛出

RuntimeException

响应

prepareDiscoverInstall

为 discover_install 任务准备适配器

prepareDiscoverInstall() : 
继承

3.4

响应

refreshManifestCache

刷新扩展表缓存

refreshManifestCache() : 

3.1

响应

bool操作结果,如果更新则为 true,如果失败则为 false

removeExtensionFiles

删除此扩展的文件

removeExtensionFiles() : 

4.0.0

抛出

RuntimeException

响应

resetUserLanguage

将用户语言重置为默认语言

resetUserLanguage() : 

4.0.0

响应

setManifest

设置清单对象。

setManifest( manifest) : \Joomla\CMS\Installer\InstallerAdapter
继承

3.4

参数

manifest

object清单对象

响应

InstallerAdapter支持链式调用的此类的实例

setRoute

设置正在使用的安装路由

setRoute( route) : \Joomla\CMS\Installer\InstallerAdapter
继承

3.4

参数

route

string正在使用的安装路由

响应

InstallerAdapter支持链式调用的此类的实例

setupInstallPaths

执行任何预检查并为扩展设置安装路径的方法

setupInstallPaths() : 

3.4

响应

setupScriptfile

为使用它的那些适配器设置清单脚本文件。

setupScriptfile() : 
继承

3.4

响应

setupUninstall

执行任何预检查并设置卸载作业的方法

setupUninstall() : 

4.0.0

响应

setupUpdates

为适配器设置更新例程的方法

setupUpdates() : 
继承

3.4

响应

storeExtension

将扩展存储到数据库中的方法

storeExtension() : 

3.4

抛出

RuntimeException

响应

triggerManifestScript

执行自定义安装脚本方法

triggerManifestScript( method) : 
继承

3.4

抛出

RuntimeException

参数

method

string要执行的安装方法

响应

bool成功时为 True

uninstall

扩展的通用更新方法

uninstall( id) : 
继承

4.0.0

参数

id

int扩展 ID

响应

bool成功时为 True

update

自定义更新方法

update() : 

3.1

响应

bool成功时为 True,失败时为 False

属性

changelogurl

扩展的变更日志 URL

继承

4.0.0

类型

字符串

currentExtensionId

如果存在,则为当前已安装扩展的 ID

继承

3.4

类型

int

element

扩展的唯一标识符(例如 mod_login)

继承

3.4

类型

字符串

extension

扩展对象。

继承

3.4

类型

扩展

extensionMessage

自定义脚本呈现的消息

继承

3.4

类型

字符串

manifest

XML 清单文件的副本。

继承

公开此对象允许扩展在自定义脚本中自定义清单。

3.4

类型

SimpleXMLElement

manifest_script

清单中 scriptfile 声明引用的 PHP 文件的路径。

继承

3.4

类型

字符串

name

扩展的名称

继承

3.4

类型

字符串

父级

与此适配器一起使用的安装程序

继承

4.0.0

类型

安装程序

route

安装函数路由

继承

3.4

类型

字符串

supportsDiscoverInstall

适配器是否支持发现安装的标志

继承

如果发现安装不受支持,则适配器应覆盖此项并设置为 false

3.4

类型

布尔

type

正在使用的适配器类型

继承

3.4

类型

字符串

核心

核心语言包标志

3.0.0

类型

布尔

tag

包的语言标签

4.0.0

类型

字符串

ignoreUninstallQueries

指示卸载过程不应运行 SQL 查询的标志

4.0.0

类型

布尔