Registry

实现 JsonSerializable, ArrayAccess, IteratorAggregate, Countable

Registry 类

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

stringRegistry 路径(例如 joomla.content.showauthor)

响应

bool

extract

用于从路径提取子 Registry 的方法

extract( path) : \Joomla\Registry\Registry

1.2.0

2.0.0

参数

path

stringRegistry 路径(例如 joomla.content.showauthor)

响应

RegistryRegistry 对象(如果不存在数据,则为空)

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

stringRegistry 路径(例如 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) : 

1.0.0

2.0.0

参数

source

Registry要合并的源 Registry 对象。

recursive

bool如果要支持递归地合并子级值,则为 True。

响应

$this

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

stringRegistry 路径(例如 joomla.content.showauthor)

响应

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

set

设置 Registry 值。

set( path,  value,  separator = null) : 

1.0.0

参数

path

stringRegistry 路径(例如 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