Joomla! 框架 3.x API » \Joomla\Keychain\Keychain

自	1.0
包	Joomla 框架

用于克隆注册表对象的魔法函数。

__clone() :

继承

自	1.0.0

响应

void

构造函数

__construct(\Joomla\Crypt\Crypt crypt,  data = null) :

自	2.0.0

参数

crypt: Crypt加密处理程序。
data: mixed绑定到新 Keychain 的数据。

响应

mixed

用于访问 separator 属性的魔法方法。

__get( name) : string|null

继承已弃用

自
已弃用	3.0 这是对已弃用读访问的 B/C 代理

参数

name: string属性的名称。

响应

string|null如果属性名称有效，则为值，否则为 null。

用于访问 separator 属性的魔法方法。

__set( name,  value) :

继承已弃用

自
已弃用	3.0 这是对已弃用读访问的 B/C 代理

参数

name: string属性的名称。
value: mixed属性的值。

响应

void

将此对象呈现为字符串的魔法函数，使用 toString 方法的默认参数。

__toString() :

继承

自	1.0.0

响应

string

将值追加到注册表中的路径

append( path,  value) :

继承

自	1.4.0

参数

path: string父注册表路径（例如 joomla.content.showauthor）
value: mixed条目值

响应

mixed已设置的值。

用于将数据对象递归地转换为数组的方法。

asArray( data) : mixed||string|int

继承

自	1.0.0

参数

data: object要作为数组返回的数据对象。

响应

array<string|int, mixed>输入对象的数组表示形式。

用于将数据递归地绑定到父对象的方法。

bindData( parent,  data,  recursive = true,  allowNull = true) :

继承

自	1.0.0

参数

parent: object要附加数据值的父对象。
data: mixed要绑定到父对象的数组或数据对象。
recursive: bool如果要支持递归 bindData，则为 True。
allowNull: bool如果允许 null 值，则为 True。

响应

void

计算数据对象的元素数

count() :

继承

link
自	1.3.0

响应

int自定义计数作为整数。

如果尚未分配，则设置默认值。

def( key,  default = '') :

继承

自	1.0.0

参数

key: string参数的名称。
default: mixed参数的可选值。

响应

mixed设置的值，如果该值之前未设置（或为 null），则为默认值。

检查注册表路径是否存在。

exists( path) :

继承

自	1.0.0

参数

path: string注册表路径（例如 joomla.content.showauthor）

响应

bool

用于从路径中提取子注册表的方法

extract( path) : \Joomla\Registry\Registry

继承

自	1.2.0 2.0.0

参数

path: string注册表路径（例如 joomla.content.showauthor）

响应

Registry注册表对象（如果不存在数据，则为空）

转储为一维数组。

flatten( separator = null) : string||string|int

继承

自	1.3.0

参数

separator: string键分隔符。

响应

array<string|int, string>转储的数组。

获取注册表值。

get( path,  default = null) :

继承

自	1.0.0

参数

path: string注册表路径（例如 joomla.content.showauthor）
default: mixed可选的默认值，如果内部值为 null，则返回该值。

响应

mixed条目的值或 null

获取表示为 ArrayIterator 的此对象。

getIterator() : \ArrayIterator

继承

这允许通过 foreach 语句访问数据属性。

参见	IteratorAggregate::getIterator()
自	1.3.0

响应

ArrayIterator表示为 ArrayIterator 的此对象。

JsonSerializable 接口的实现。

jsonSerialize() :

继承

允许我们将 Registry 对象传递给 json_encode。

自	1.0.0
注意	该接口仅存在于 PHP 5.4 及更高版本中。

响应

object

将关联数组的值加载到默认命名空间中

loadArray(mixed||string|int array,  flattened = false,  separator = null) :

继承

自	1.0.0 2.0.0

参数

array: array<string|int, mixed>要加载的值的关联数组
flattened: bool从一维数组加载
separator: string键分隔符

响应

$this

将文件内容加载到注册表中

loadFile( file,  format = 'JSON', mixed||string|int options = []) :

继承

自	1.0.0 2.0.0

参数

file: string要加载的文件的路径
format: string文件的格式 [可选：默认为 JSON]
options: array<string|int, mixed>格式化程序使用的选项

响应

$this

将密钥链文件加载到此对象中。

loadKeychain( keychainFile) :

自

自	1.0
抛出	`RuntimeException`如果密钥链文件不存在 `CryptExceptionInterface`如果密钥链无法解密

1.0

抛出

RuntimeException如果密钥链文件不存在

CryptExceptionInterface如果密钥链无法解密

参数

keychainFile: string密钥链文件的路径。

响应

$this

将对象的公共变量加载到默认命名空间中。

loadObject( object) :

继承

自	1.0.0

参数

object: object包含要加载的公共变量的对象

响应

$this

将字符串加载到注册表中

loadString( data,  format = 'JSON', mixed||string|int options = []) :

继承

自	1.0.0 2.0.0

参数

data: string要加载到注册表中的字符串
format: string字符串的格式
options: array<string|int, mixed>格式化程序使用的选项

响应

$this

将 Registry 对象合并到此对象中

merge(\Joomla\Registry\Registry source,  recursive = false) :

继承

自	1.0.0 2.0.0

参数

source: Registry要合并的源 Registry 对象。
recursive: bool如果要支持递归合并子级值，则为 True。

响应

$this

检查迭代器中是否存在偏移量。

offsetExists( offset) :

继承

自	1.0.0

参数

offset: mixed数组偏移量。

响应

bool如果偏移量存在，则为 True，否则为 False。

获取迭代器中的偏移量。

offsetGet( offset) :

继承

自	1.0.0

参数

offset: mixed数组偏移量。

响应

mixed如果存在，则为数组值，否则为 null。

设置迭代器中的偏移量。

offsetSet( offset,  value) :

继承

自	1.0.0

参数

offset: mixed数组偏移量。
value: mixed数组值。

响应

void

取消设置迭代器中的偏移量。

offsetUnset( offset) :

继承

自	1.0.0

参数

offset: mixed数组偏移量。

响应

void

删除注册表值

remove( path) :

继承

自	1.6.0

参数

path: string注册表路径（例如 joomla.content.showauthor）

响应

mixed已删除节点的值，如果未设置，则为 null

将此密钥链保存到文件。

saveKeychain( keychainFile) :

自

自	1.0
抛出	`RuntimeException`如果密钥链文件路径无效 `CryptExceptionInterface`如果密钥链无法加密

1.0

抛出

RuntimeException如果密钥链文件路径无效

CryptExceptionInterface如果密钥链无法加密

参数

keychainFile: string密钥链文件的路径。

响应

bool存储文件的結果。

设置注册表值。

set( path,  value,  separator = null) :

继承

自	1.0.0

参数

path: string注册表路径（例如 joomla.content.showauthor）
value: mixed条目值
separator: string键分隔符。将在版本 4 中删除。

响应

mixed已设置的值。

将命名空间转换为数组

toArray() : mixed||string|int

继承

自	1.0.0

响应

array<string|int, mixed>包含命名空间数据的关联数组

用于将数据递归地转换为一维数组的方法。

toFlatten( separator = null, array|object data = null, mixed||string|int &array = [],  prefix = '') :

继承

自	1.3.0 2.0.0

参数

separator: string键分隔符。
data: array<string|int, mixed>|object此范围的数据源。
array: array<string|int, mixed>结果数组，它是通过引用传递的。
prefix: string最后一级键前缀。

响应

void

将命名空间转换为对象

toObject() :

继承

自	1.0.0

响应

object包含命名空间数据的对象

以给定的字符串格式获取命名空间

toString( format = 'JSON', mixed||string|int options = []) :

继承

自	1.0.0

参数

format: string要返回的字符串的格式
options: array<string|int, mixed>格式化程序使用的参数，有关更多信息，请参见格式化程序

响应

string以字符串格式表示的命名空间

注册表对象

继承

自	1.0.0

类型

stdClass

如果注册表数据对象已初始化，则为标志

继承

自	1.5.2

类型

bool

路径分隔符

继承

自	1.4.0

类型

string

加密处理程序。

自	2.0.0

类型

Crypt