CMSObject
扩展 stdClassJoomla 平台对象类
此类允许使用 get 和 set 方法以及内部错误处理程序来创建简单但智能的对象。
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.3 将在 6.0 中移除，请改用 \stdClass 或 \Joomla\Registry\Registry。示例：new \Joomla\Registry\Registry(); |
| 包 |
Joomla CMS |
方法
__construct
类构造函数，在子类中被覆盖。
__construct( properties = null) :
| 自 |
1.7.0 |
|---|
参数
- properties
mixed关联数组或其他对象，用于设置对象的初始属性。
响应
mixed
__toString
将对象优雅地转换为字符串的魔术方法。
__toString() :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.3 将在 6.0 中移除，类应该提供自己的 __toString() 实现。 |
响应
string类名。
def
如果尚未分配，则设置默认值
def( property, default = null) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.3.0 将在 6.0 中移除，不再使用动态属性定义 |
参数
- 属性
string属性名称。- 默认
mixed默认值。
响应
mixed
get
返回对象的属性，如果未设置属性，则返回默认值。
get( property, default = null) :
| 自 |
1.7.0 |
|---|---|
| 参见 | CMSObject::getProperties() |
| 已弃用 |
4.3.0 将在 6.0 中移除，为属性创建合适的 getter 函数 |
参数
- 属性
string属性名称。- 默认
mixed默认值。
响应
mixed属性值。
getError
获取最新的错误消息。
getError( i = null, toString = true) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
3.1.4 将在 6.0 中移除，将被移除，不会替换，请改为捕获抛出的异常，而不是使用 getError |
参数
- i
int可选错误索引。- toString
bool指示 Exception 对象是否应返回其错误消息。
响应
string错误消息
getErrors
返回所有错误（如果有）。
getErrors() : mixed||string|int
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
3.1.4 将在 6.0 中移除，将被移除，不会替换，请改为捕获抛出的异常，而不是使用 getErrors |
响应
array<string|int, mixed>错误消息数组。
getProperties
返回对象属性的关联数组。
getProperties( public = true) : mixed||string|int
| 自 |
1.7.0 |
|---|---|
| 参见 | CMSObject::get() |
| 已弃用 |
4.3.0 将在 6.0 中移除，为属性创建合适的 getter 函数 |
参数
- public
bool如果为 true，则仅返回公共属性。
响应
array<string|int, mixed>
set
修改对象的一个属性，如果属性不存在则创建它。
set( property, value = null) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
4.3.0 将在 6.0 中移除，为属性创建合适的 setter 函数 |
参数
- 属性
string属性名称。- value
mixed要设置的属性值。
响应
mixed属性的先前值。
setError
添加错误消息。
setError( error) :
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
3.1.4 将在 6.0 中移除，将被移除，不会替换，请改为抛出异常，而不是使用 setError |
参数
- error
string错误消息。
响应
void
setProperties
根据命名数组/哈希设置对象属性。
setProperties( properties) :
| 自 |
1.7.0 |
|---|---|
| 参见 | CMSObject::set() |
| 已弃用 |
4.3.0 将在 6.0 中移除，为属性创建合适的 setter 函数 |
参数
- properties
mixed关联数组或其他对象。
响应
bool
属性
_errors
错误消息或 Exception 对象的数组。
| 自 |
1.7.0 |
|---|---|
| 已弃用 |
3.1.4 JError 已弃用 |
类型
array<string|int, mixed>