Feed
实现 ArrayAccess,Countable用于封装 Joomla 平台提要的类。
自 |
3.1.4 |
---|---|
包 |
Joomla CMS |
方法
__get
用于返回提要属性值的魔术方法。
__get( name) :
自 |
3.1.4 |
---|
参数
- 名称
string
属性的名称。
响应
混合
__set
用于设置提要属性值的魔术方法。
__set( name, value) :
自 |
3.1.4 |
---|
参数
- 名称
string
属性的名称。- 值
mixed
要为属性设置的值。
响应
空
addCategory
用于向提要对象添加类别的的方法。
addCategory( name, uri = '') : \Joomla\CMS\Feed\Feed
addContributor
用于向提要对象添加贡献者的方法。
addContributor( name, email, uri = null, type = null) : \Joomla\CMS\Feed\Feed
自 |
3.1.4 |
---|
参数
- 名称
string
要添加的人员的完整名称。- 电子邮件
string
要添加的人员的电子邮件地址。- uri
string
要添加的人员的可选 URI。- 类型
string
要添加的人员的可选类型。
响应
addEntry
用于向提要对象添加条目的方法。
addEntry(\Joomla\CMS\Feed\FeedEntry entry) : \Joomla\CMS\Feed\Feed
count
返回提要中条目数量的计数。
count() :
此方法用于实现 Countable 接口。您可以通过执行 count($feed) 而不是 $feed->count(); 来调用它。
响应
int
提要中的条目数。
offsetExists
偏移量是否存在。当在实现 ArrayAccess 的对象上使用 isset() 或 empty() 时,将执行此方法。
offsetExists( offset) :
参见 | ArrayAccess::offsetExists() |
---|---|
自 |
3.1.4 |
参数
- 偏移量
mixed
要检查的偏移量。
响应
布尔值
offsetGet
返回指定偏移量处的值。
offsetGet( offset) :
参见 | ArrayAccess::offsetGet() |
---|---|
自 |
3.1.4 |
参数
- 偏移量
mixed
要检索的偏移量。
响应
mixed
偏移量处的值。
offsetSet
将值分配给指定的偏移量。
offsetSet( offset, \Joomla\CMS\Feed\FeedEntry value) :
参见 | ArrayAccess::offsetSet() |
---|---|
自 |
3.1.4 |
抛出 |
|
参数
- 偏移量
mixed
要向其分配值的偏移量。- 值
FeedEntry
要设置的 JFeedEntry。
响应
空
offsetUnset
取消设置偏移量。
offsetUnset( offset) :
参见 | ArrayAccess::offsetUnset() |
---|---|
自 |
3.1.4 |
参数
- 偏移量
mixed
要取消设置的偏移量。
响应
空
removeCategory
用于从提要对象中删除类别的的方法。
removeCategory( name) : \Joomla\CMS\Feed\Feed
removeContributor
用于从提要对象中删除贡献者的方法。
removeContributor(\Joomla\CMS\Feed\FeedPerson contributor) : \Joomla\CMS\Feed\Feed
removeEntry
用于从提要对象中删除条目的方法。
removeEntry(\Joomla\CMS\Feed\FeedEntry entry) : \Joomla\CMS\Feed\Feed
setAuthor
用于设置提要对象作者的快捷方法。
setAuthor( name, email, uri = null, type = null) : \Joomla\CMS\Feed\Feed
自 |
3.1.4 |
---|
参数
- 名称
string
要设置的人员的完整名称。- 电子邮件
string
要设置的人员的电子邮件地址。- uri
string
要设置的人员的可选 URI。- 类型
string
要设置的人员的可选类型。
响应
属性
作者
类别
提要所属的类别。
类型
array<string|int, mixed>
贡献者
为提要内容做出贡献的人员。
类型
array<string|int, mixed>
版权
有关提要中和提要上的权利(例如版权)的信息。
类型
字符串
描述
描述提要的短语或句子。
类型
字符串
生成器
指示用于生成提要的程序的字符串。
类型
字符串
图像
发布日期
标题
提要的人类可读标题。
类型
字符串
更新日期
uri
提要的通用永久标识符。
类型
字符串
属性
条目属性。
自 |
3.1.4 |
---|
类型
array<string|int, mixed>
条目
提要条目对象列表。
自 |
3.1.4 |
---|
类型
array<string|int, mixed>