Feed/Builder/Entry.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Feed
- Version
- $Id$
\Zend_Feed_Builder_Entry
Package: Zend_FeedAn entry of a custom build feed
Classes implementing the Zend_Feed_Builder_Interface interface
uses this class to describe an entry of a feed
- Parent(s)
- \ArrayObject
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods
__construct(string $title, string $link, string $description) : voidCreate a new builder entry
Parameters| Name | Type | Description |
|---|
| $title | string | |
|---|
| $link | string | |
|---|
| $description | string | short version of the entry, no html |
|---|
__get(string $name) : mixedRead only properties accessor
Parameters| Name | Type | Description |
|---|
| $name | string | property to read |
|---|
Returns __set(string $name, mixed $value) : voidWrite properties accessor
Parameters| Name | Type | Description |
|---|
| $name | string | name of the property to set |
|---|
| $value | mixed | value to set |
|---|
addCategory(array $category) : \Zend_Feed_Builder_EntryAdd a category to the entry
Parameters| Name | Type | Description |
|---|
| $category | array | see Zend_Feed_Builder_Entry::setCategories() for format |
|---|
ReturnsThrows addEnclosure(string $url, string $type = '', string $length = '') : \Zend_Feed_Builder_EntryAdd an enclosure to the entry
Parameters| Name | Type | Description |
|---|
| $url | string | |
|---|
| $type | string | |
|---|
| $length | string | |
|---|
Returns setAuthor(string $author) : \Zend_Feed_Builder_EntrySets the author of the entry
Parameters| Name | Type | Description |
|---|
| $author | string | |
|---|
Returns setCategories(array $categories) : \Zend_Feed_Builder_EntrySets 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
)
Parameters| Name | Type | Description |
|---|
| $categories | array | |
|---|
Returns setCommentsRssUrl(string $commentRss) : \Zend_Feed_Builder_EntrySets the url of the comments feed link
Parameters| Name | Type | Description |
|---|
| $commentRss | string | |
|---|
Returns setCommentsUrl(string $comments) : \Zend_Feed_Builder_EntrySets the url of the commented page associated to the entry
Parameters| Name | Type | Description |
|---|
| $comments | string | |
|---|
Returns setContent(string $content) : \Zend_Feed_Builder_EntrySets the full html content of the entry
Parameters| Name | Type | Description |
|---|
| $content | string | |
|---|
Returns setEnclosures(array $enclosures) : \Zend_Feed_Builder_EntrySets 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
)
Parameters| Name | Type | Description |
|---|
| $enclosures | array | |
|---|
ReturnsThrows setLastUpdate(int $lastUpdate) : \Zend_Feed_Builder_EntryTimestamp of the update date
Parameters| Name | Type | Description |
|---|
| $lastUpdate | int | |
|---|
Returns setSource(string $title, string $url) : \Zend_Feed_Builder_EntryDefines a reference to the original source
Parameters| Name | Type | Description |
|---|
| $title | string | |
|---|
| $url | string | |
|---|
Returns 
inherited
Classes