Joomla! API

下载
启动

CategoryNode

实现 NodeInterface

用于加载分类树的辅助类

自

1.6
包

Joomla CMS

方法

__construct

类构造函数

__construct(mixed||string|int category = null, \Joomla\CMS\Categories\Categories constructor = null) :
自

1.6

参数

category

array<string|int, mixed>分类数据。

constructor

Categories树构造函数。

响应

mixed

__serialize

序列化节点。

__serialize() :
自

4.3.2

响应

mixed

__unserialize

反序列化节点。

__unserialize(mixed||string|int data) :
自

4.3.2

参数

data

array<string|int, mixed>

响应

mixed

addChild

向此节点添加子节点

addChild(\Joomla\CMS\Tree\NodeInterface child) :
继承

如果子节点已存在父节点，则取消链接

自

4.0.0

参数

child

NodeInterface要添加的子节点。

响应

void

def

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

def( property,  default = null) :
继承 已弃用
自

1.7.0
已弃用

4.3.0 将在 6.0 中删除，不再定义动态属性

参数

property

string属性名称。

default

mixed默认值。

响应

mixed

get

返回对象的属性，如果未设置属性，则返回默认值。

get( property,  default = null) :
继承 已弃用
自

1.7.0
参见 CMSObject::getProperties()
已弃用

4.3.0 将在 6.0 中删除，为属性创建合适的 getter 函数

参数

property

string属性名称。

default

mixed默认值。

响应

mixed属性的值。

getAuthor

返回创建分类的用户

getAuthor( modifiedUser = false) : \Joomla\CMS\User\User
自

1.6

参数

modifiedUser

bool如果设置为 true，则返回 modified_user

响应

User包含用户 ID 的用户对象

getChildren

获取此节点的子节点

getChildren( recursive = false) : \Joomla\CMS\Categories\CategoryNode||string|int
自

1.6

参数

recursive

bool默认情况下为 False

响应

array<string|int, CategoryNode>子节点

getError

获取最新的错误消息。

getError( i = null,  toString = true) :
继承 已弃用
自

1.7.0
已弃用

3.1.4 将在 6.0 中删除，不会进行替换，改为捕获抛出的异常，而不是 getError

参数

i

int可选错误索引。

toString

bool指示异常对象是否应返回其错误消息。

响应

string错误消息

getErrors

返回所有错误（如果有）。

getErrors() : mixed||string|int
继承 已弃用
自

1.7.0
已弃用

3.1.4 将在 6.0 中删除，不会进行替换，改为捕获抛出的异常，而不是 getErrors

响应

array<string|int, mixed>错误消息数组。

getMetadata

返回分类元数据

getMetadata() : \Joomla\Registry\Registry
自

1.6

响应

Registry包含元数据的 Registry 对象

getNumItems

返回项目数量。

getNumItems( recursive = false) :
自

1.6

参数

recursive

bool如果为 false，则表示子节点数量，如果为 true，则表示后代数量

响应

int子节点或后代数量

getParams

返回分类参数

getParams() : \Joomla\Registry\Registry
自

1.6

响应

Registry

getPath

返回到根分类的分类路径

getPath() : mixed||string|int
自

1.6

响应

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>

getSibling

返回分类的右或左兄弟节点

getSibling( right = true) : \Joomla\CMS\Categories\CategoryNode|null
自

1.6

参数

right

bool如果设置为 false，则返回左兄弟节点

响应

CategoryNode|null包含兄弟节点信息的 CategoryNode 对象，如果该侧没有兄弟节点，则为 null。

removeChild

删除特定子节点

removeChild(\Joomla\CMS\Tree\NodeInterface child) :
继承
自

4.0.0

参数

child

NodeInterface要删除的子节点

响应

void

set

修改对象的属性，如果属性不存在，则创建它。

set( property,  value = null) :
继承 已弃用
自

1.7.0
已弃用

4.3.0 将在 6.0 中删除，为属性创建合适的 setter 函数

参数

property

string属性名称。

value

mixed要设置的属性的值。

响应

mixed属性的先前值。

setAllLoaded

设置为加载所有子节点

setAllLoaded() :
自

1.6

响应

void

setError

添加错误消息。

setError( error) :
继承 已弃用
自

1.7.0
已弃用

3.1.4 将在 6.0 中删除，不会进行替换，改为抛出异常，而不是使用 setError

参数

error

string错误消息。

响应

void

setParent

设置此分类的父节点

setParent(\Joomla\CMS\Tree\NodeInterface parent) :

如果分类已存在父节点，则取消链接

自

1.6

参数

parent

NodeInterface要设置的 CategoryNode 或 null

响应

void

setProperties

根据命名数组/哈希设置对象属性。

setProperties( properties) :
继承 已弃用
自

1.7.0
参见 CMSObject::set()
已弃用

4.3.0 将在 6.0 中删除，为属性创建合适的 setter 函数

参数

properties

mixed关联数组或其他对象。

响应

bool

setSibling

用于设置节点的左或右兄弟节点的函数

setSibling(\Joomla\CMS\Tree\NodeInterface sibling,  right = true) :
继承
自

4.0.0

参数

sibling

NodeInterface兄弟节点的 NodeInterface 对象

right

bool如果设置为 false，则兄弟节点为左边的节点

响应

void

属性

_errors

错误消息或异常对象的数组。

继承 已弃用
自

1.7.0
已弃用

3.1.4 JError 已弃用

类型

array<string|int, mixed>

id

主键

自

1.6

类型

int

asset_id

分类在资产表中的 ID

自

1.6

类型

int

parent_id

分类在资产表中的父级 ID，根分类为 0

自

1.6

类型

int

lft

分类在分类树中的 lft 值

自

1.6

类型

int

rgt

分类在分类树中的 rgt 值

自

1.6

类型

int

level

分类在分类树中的深度

自

1.6

类型

int

extension

分类关联的扩展

自

1.6

类型

int

title

分类的菜单标题（简短名称）

自

1.6

类型

string

alias

分类的别名

自

1.6

类型

string

description

分类的描述。

自

1.6

类型

string

published

分类的发布状态

自

1.6

类型

bool

checked_out

分类是否已签出

自

1.6

类型

bool

checked_out_time

签出分类的时间

自

1.6

类型

string

access

分类的访问级别

自

1.6

类型

int

params

参数的 JSON 字符串

自

1.6

类型

string

metadesc

元数据描述

自

1.6

类型

string

metakey

元数据的关键字

自

1.6

类型

string

metadata

其他元数据的 JSON 字符串

自

1.6

类型

string

created_user_id

创建分类的用户的 ID

自

1.6

类型

int

created_time

创建分类的时间

自

1.6

类型

string

modified_user_id

最后修改分类的用户的 ID

自

1.6

类型

int

modified_time

修改分类的时间

自

1.6

类型

string

hits

查看分类的次数

自

1.6

类型

int

language

分类的语言，格式为 xx-XX

自

1.6

类型

string

numitems

此分类或此分类后代的项目数量

自

1.6

类型

int

slug

分类的标识（用于 URL）

自

1.6

类型

string

assets

资产数组

自

1.6

类型

array<string|int, mixed>

_path

从根到此分类的路径

自

1.6

类型

array<string|int, mixed>

_allChildrenloaded

是否已加载所有子节点的标志

自

1.6

类型

bool

_constructor

此树的构造函数

自

1.6

类型

Categories
  • \ Joomla
  • \ CMS
  • \ Categories
  • \ CategoryNode