Registry
实现 JsonSerializable, ArrayAccess, IteratorAggregate, CountableRegistry 类
自 |
1.0.0 2.0.0 |
---|---|
包 |
Joomla 框架 |
方法
__clone
用于克隆 Registry 对象的魔术函数。
__clone() :
自 |
1.0.0 |
---|
响应
void
__construct
构造函数
__construct( data = null, separator = '.') :
自 |
1.0.0 |
---|
参数
- data
mixed
要绑定到新 Registry 对象的数据。- separator
string
路径分隔符,空字符串将扁平化 Registry。
响应
mixed
__get
用于访问 separator 属性的魔术方法。
__get( name) : string|null
自 | |
---|---|
已弃用 |
3.0 这是对已弃用读取访问的 B/C 代理 |
参数
- name
string
属性的名称。
响应
string|null
如果属性名称有效,则为一个值,否则为 null。
__set
用于访问 separator 属性的魔术方法。
__set( name, value) :
自 | |
---|---|
已弃用 |
3.0 这是对已弃用读取访问的 B/C 代理 |
参数
- name
string
属性的名称。- value
mixed
属性的值。
响应
void
__toString
用于使用 toString 方法的默认参数将此对象呈现为字符串的魔术函数。
__toString() :
自 |
1.0.0 |
---|
响应
string
append
将值附加到 Registry 中的路径
append( path, value) :
自 |
1.4.0 |
---|
参数
- path
string
父 Registry 路径(例如 joomla.content.showauthor)- value
mixed
条目的值
响应
mixed
已设置的值。
asArray
用于递归地将数据对象转换为数组的方法。
asArray( data) : mixed||string|int
自 |
1.0.0 |
---|
参数
- data
object
要作为数组返回的数据对象。
响应
array<string|int, mixed>
输入对象的数组表示形式。
bindData
用于递归地将数据绑定到父对象的方法。
bindData( parent, data, recursive = true, allowNull = true) :
自 |
1.0.0 |
---|
参数
- parent
object
要附加数据值的父对象。- data
mixed
要绑定到父对象的数据数组或对象。- recursive
bool
如果要支持递归 bindData,则为 True。- allowNull
bool
如果允许空值,则为 True。
响应
void
count
计算数据对象的元素数量
count() :
link | |
---|---|
自 |
1.3.0 |
响应
int
自定义计数,为整数。
def
如果尚未分配,则设置默认值。
def( key, default = '') :
自 |
1.0.0 |
---|
参数
- key
string
参数的名称。- default
mixed
参数的可选值。
响应
mixed
设置的值,或者如果之前未设置该值(或为 null),则为默认值。
exists
检查 Registry 路径是否存在。
exists( path) :
自 |
1.0.0 |
---|
参数
- path
string
Registry 路径(例如 joomla.content.showauthor)
响应
bool
extract
用于从路径提取子 Registry 的方法
extract( path) : \Joomla\Registry\Registry
自 |
1.2.0 2.0.0 |
---|
参数
- path
string
Registry 路径(例如 joomla.content.showauthor)
响应
Registry
Registry 对象(如果不存在数据,则为空)
flatten
转储为一维数组。
flatten( separator = null) : string||string|int
自 |
1.3.0 |
---|
参数
- separator
string
键分隔符。
响应
array<string|int, string>
转储的数组。
get
获取 Registry 值。
get( path, default = null) :
自 |
1.0.0 |
---|
参数
- path
string
Registry 路径(例如 joomla.content.showauthor)- default
mixed
可选的默认值,如果内部值为 null,则返回该值。
响应
mixed
条目的值或 null
getIterator
获取此对象作为 ArrayIterator 的表示形式。
getIterator() : \ArrayIterator
这允许通过 foreach 语句访问数据属性。
参见 | IteratorAggregate::getIterator() |
---|---|
自 |
1.3.0 |
响应
ArrayIterator
此对象作为 ArrayIterator 的表示形式。
jsonSerialize
JsonSerializable 接口的实现。
jsonSerialize() :
允许我们将 Registry 对象传递给 json_encode。
自 |
1.0.0 |
---|---|
注意 |
该接口仅存在于 PHP 5.4 及更高版本中。 |
响应
object
loadArray
将关联数组的值加载到默认命名空间中
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
将文件的内容加载到 Registry 中
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
loadObject
将对象的公共变量加载到默认命名空间中。
loadObject( object) :
自 |
1.0.0 |
---|
参数
- object
object
包含要加载的公共变量的对象
响应
$this
loadString
将字符串加载到 Registry 中
loadString( data, format = 'JSON', mixed||string|int options = []) :
自 |
1.0.0 2.0.0 |
---|
参数
- data
string
要加载到 Registry 中的字符串- format
string
字符串的格式- options
array<string|int, mixed>
格式化程序使用的选项
响应
$this
merge
将 Registry 对象合并到此对象中
merge(\Joomla\Registry\Registry source, recursive = false) :
offsetExists
检查迭代器中是否存在偏移量。
offsetExists( offset) :
自 |
1.0.0 |
---|
参数
- offset
mixed
数组偏移量。
响应
bool
如果偏移量存在,则为 True,否则为 False。
offsetGet
获取迭代器中的偏移量。
offsetGet( offset) :
自 |
1.0.0 |
---|
参数
- offset
mixed
数组偏移量。
响应
mixed
如果数组值存在,则为该值,否则为 null。
offsetSet
设置迭代器中的偏移量。
offsetSet( offset, value) :
自 |
1.0.0 |
---|
参数
- offset
mixed
数组偏移量。- value
mixed
数组值。
响应
void
offsetUnset
取消设置迭代器中的偏移量。
offsetUnset( offset) :
自 |
1.0.0 |
---|
参数
- offset
mixed
数组偏移量。
响应
void
remove
删除 Registry 值
remove( path) :
自 |
1.6.0 |
---|
参数
- path
string
Registry 路径(例如 joomla.content.showauthor)
响应
mixed
已删除节点的值,如果未设置,则为 null
set
设置 Registry 值。
set( path, value, separator = null) :
自 |
1.0.0 |
---|
参数
- path
string
Registry 路径(例如 joomla.content.showauthor)- value
mixed
条目的值- separator
string
键分隔符。将在版本 4 中删除。
响应
mixed
已设置的值。
toArray
将命名空间转换为数组
toArray() : mixed||string|int
自 |
1.0.0 |
---|
响应
array<string|int, mixed>
包含命名空间数据的关联数组
toFlatten
用于递归地将数据转换为一维数组的方法。
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
将命名空间转换为对象
toObject() :
自 |
1.0.0 |
---|
响应
object
包含命名空间数据的对象
toString
以给定的字符串格式获取命名空间
toString( format = 'JSON', mixed||string|int options = []) :
自 |
1.0.0 |
---|
参数
- format
string
要以其返回字符串的格式- options
array<string|int, mixed>
格式化程序使用的参数,有关更多信息,请参见格式化程序
响应
string
字符串格式的命名空间
属性
data
Registry 对象
自 |
1.0.0 |
---|
类型
stdClass
initialized
Registry 数据对象是否已初始化的标志
自 |
1.5.2 |
---|
类型
bool
separator
路径分隔符
自 |
1.4.0 |
---|
类型
string