属性 | 值 |
---|---|
命名空间 | fize\xml |
类名 | Rss |
- 方法
方法名 | 说明 |
---|---|
__construct() | 构造函数 |
setChannel() | 设置 channel 子节点 |
setChannelCategory() | 设置 channel 子节点 category |
setChannelCloud() | 设置 channel 子节点 cloud |
setChannelImage() | 设置 channel 子节点 image |
setChannelLanguage() | 设置 channel 子节点 language |
addChannelSkipDay() | 添加规定在那些天,聚合器忽略更新 feed |
addChannelSkipHour() | 规定在那些小时,聚合器忽略更新 feed。 |
setChannelTextInput() | 设置 channel 子节点 language,规定应当与 feed 一同显示的文本输入域。 |
addItem() | 添加 item 项 |
fetch() | 返回 RSS 的 XML 为字符串 |
display() | 输出 RSS 的 XML 到浏览器 |
build() | 保存 RSS 到指定文件,注意该文件后缀必须为 xml |
-------------构造函数
public function __construct (
string $title,
string $link,
string $description
)
- 参数
名称 说明 title 定义频道的标题 link 定义指向频道的超链接 description 描述频道
设置 channel 子节点
public function setChannel (
string $key,
mixed $value,
array $attrs = []
)
- 参数
名称 说明 key 子节点名称 value 节点值 attrs 该节点属性
参数 `$value` :
为null时不添加,为DOMElement则插入该节点,为字符串时则写入该字符串
设置 channel 子节点 category
public function setChannelCategory (
string $category,
string $domain = null
)
- 参数
名称 说明 category domain category 的 domain 属性
参数 `$domain` :
字符串或 URL,标识分类的分类法
设置 channel 子节点 cloud
public function setChannelCloud (
array $attrs
)
- 参数
名称 说明 attrs 属性数组
设置 channel 子节点 image
public function setChannelImage (
string $link,
string $url,
string $title,
string $description = null,
int $width = null,
int $height = null
)
- 参数
名称 说明 link 定义提供该频道的网站的超连接 url 定义图像的 URL title 定义当图片不能显示时所显示的替代文本 description 规定图片链接的 HTML 标题属性中的文本 width 定义图像的宽度 height 定义图像的高度
参数 `$width` :
默认是 88。最大值是 144。
参数 `$height` :
默认是 31。最大值是 400。
设置 channel 子节点 language
public function setChannelLanguage (
string $lang
)
- 参数
名称 说明 lang 对应语言简写
添加规定在那些天,聚合器忽略更新 feed
public function addChannelSkipDay (
string $day
)
- 参数
名称 说明 day 哪些天
规定在那些小时,聚合器忽略更新 feed。
public function addChannelSkipHour (
int $hour
)
- 参数
名称 说明 hour 0 表示午夜。
最多可以用24个 <skipHours> 元素。
设置 channel 子节点 language,规定应当与 feed 一同显示的文本输入域。
public function setChannelTextInput (
string $name,
string $title,
string $link,
string $description
)
- 参数
名称 说明 name 定义在文本输入域中的文本对象的名称。 title 定义文本输入域中的提交按钮的标注 (label) link 定义处理文本输入的 CGI 脚本的 URL description 定义对文本输入域的描述
添加 item 项
public function addItem (
string $title,
string $link,
string $description,
mixed $pubDate = null,
array $addns = []
)
- 参数
名称 说明 title link description pubDate 可以是时间戳或者时间字符串 addns 其他属性
返回 RSS 的 XML 为字符串
public function fetch (
bool $format = true
) : string
- 参数
名称 说明 format 是否格式化
输出 RSS 的 XML 到浏览器
public function display (
bool $format = true
)
- 参数
名称 说明 format 是否格式化
保存 RSS 到指定文件,注意该文件后缀必须为 xml
public function build (
string $path,
bool $format = true
)
- 参数
名称 说明 path 要保存的文件路径 format 是否格式化