Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
An entry of a custom build feed
Classes implementing the Zend_Feed_Builder_Interface interface uses this class to describe an entry of a feed

__construct(
string $title, string $link, string $description
)
:
void
Create a new builder entry
Name | Type | Description |
---|---|---|
$title | string | |
$link | string | |
$description | string | short version of the entry, no html |

__get(
string $name
)
:
mixed
Read only properties accessor
Name | Type | Description |
---|---|---|
$name | string | property to read |
Type | Description |
---|---|
mixed |

__isset(
string $key
)
:
boolean
Isset accessor
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
boolean |

__set(
string $name, mixed $value
)
:
void
Write properties accessor
Name | Type | Description |
---|---|---|
$name | string | name of the property to set |
$value | mixed | value to set |

addCategory(
array $category
)
:
\Zend_Feed_Builder_Entry
Add a category to the entry
Name | Type | Description |
---|---|---|
$category | array | see Zend_Feed_Builder_Entry::setCategories() for format |
Type | Description |
---|---|
\Zend_Feed_Builder_Entry |
Exception | Description |
---|---|
\Zend_Feed_Builder_Exception |

addEnclosure(
string $url, string $type
=
'', string $length
=
''
)
:
\Zend_Feed_Builder_Entry
Add an enclosure to the entry
Name | Type | Description |
---|---|---|
$url | string | |
$type | string | |
$length | string |
Type | Description |
---|---|
\Zend_Feed_Builder_Entry |

setCategories(
array $categories
)
:
\Zend_Feed_Builder_Entry
Sets the categories of the entry
Format of the array:
array(
array(
'term' => 'first category label',
'scheme' => 'url that identifies a categorization scheme' // optional
),
// second category and so one
)
Name | Type | Description |
---|---|---|
$categories | array |
Type | Description |
---|---|
\Zend_Feed_Builder_Entry |

setCommentsRssUrl(
string $commentRss
)
:
\Zend_Feed_Builder_Entry
Sets the url of the comments feed link
Name | Type | Description |
---|---|---|
$commentRss | string |
Type | Description |
---|---|
\Zend_Feed_Builder_Entry |

setCommentsUrl(
string $comments
)
:
\Zend_Feed_Builder_Entry
Sets the url of the commented page associated to the entry

setEnclosures(
array $enclosures
)
:
\Zend_Feed_Builder_Entry
Sets the enclosures of the entry
Format of the array:
array(
array(
'url' => 'url of the linked enclosure',
'type' => 'mime type of the enclosure' // optional
'length' => 'length of the linked content in octets' // optional
),
// second enclosure and so one
)
Name | Type | Description |
---|---|---|
$enclosures | array |
Type | Description |
---|---|
\Zend_Feed_Builder_Entry |
Exception | Description |
---|---|
\Zend_Feed_Builder_Exception |

setSource(
string $title, string $url
)
:
\Zend_Feed_Builder_Entry
Defines a reference to the original source
Name | Type | Description |
---|---|---|
$title | string | |
$url | string |
Type | Description |
---|---|
\Zend_Feed_Builder_Entry |