API Documentation

Zend/Feed/Builder/Entry.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Feed  
Version
$Id: Entry.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Feed_Builder_Entry

Package: Zend\Feed

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

Parent(s)
\ArrayObject
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Methods

methodpublic__construct( string $title, string $link, string $description ) : void

Create a new builder entry

Parameters
Name Type Description
$title string
$link string
$description string

short version of the entry, no html

methodpublic__get( string $name ) : mixed

Read only properties accessor

Parameters
Name Type Description
$name string

property to read

Returns
Type Description
mixed
methodpublic__isset( string $key ) : boolean

Isset accessor

Parameters
Name Type Description
$key string
Returns
Type Description
boolean
methodpublic__set( string $name, mixed $value ) : void

Write properties accessor

Parameters
Name Type Description
$name string

name of the property to set

$value mixed

value to set

methodpublic__unset( string $key ) : void

Unset accessor

Parameters
Name Type Description
$key string
methodpublicaddCategory( array $category ) : \Zend_Feed_Builder_Entry

Add a category to the entry

Parameters
Name Type Description
$category array

see Zend_Feed_Builder_Entry::setCategories() for format

Returns
Type Description
\Zend_Feed_Builder_Entry
Throws
Exception Description
\Zend_Feed_Builder_Exception
methodpublicaddEnclosure( string $url, string $type = '', string $length = '' ) : \Zend_Feed_Builder_Entry

Add an enclosure to the entry

Parameters
Name Type Description
$url string
$type string
$length string
Returns
Type Description
\Zend_Feed_Builder_Entry
methodpublicsetAuthor( string $author ) : \Zend_Feed_Builder_Entry

Sets the author of the entry

Parameters
Name Type Description
$author string
Returns
Type Description
\Zend_Feed_Builder_Entry
methodpublicsetCategories( 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 )

Parameters
Name Type Description
$categories array
Returns
Type Description
\Zend_Feed_Builder_Entry
methodpublicsetCommentsRssUrl( string $commentRss ) : \Zend_Feed_Builder_Entry

Sets the url of the comments feed link

Parameters
Name Type Description
$commentRss string
Returns
Type Description
\Zend_Feed_Builder_Entry
methodpublicsetCommentsUrl( string $comments ) : \Zend_Feed_Builder_Entry

Sets the url of the commented page associated to the entry

Parameters
Name Type Description
$comments string
Returns
Type Description
\Zend_Feed_Builder_Entry
methodpublicsetContent( string $content ) : \Zend_Feed_Builder_Entry

Sets the full html content of the entry

Parameters
Name Type Description
$content string
Returns
Type Description
\Zend_Feed_Builder_Entry
methodpublicsetEnclosures( 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 )

Parameters
Name Type Description
$enclosures array
Returns
Type Description
\Zend_Feed_Builder_Entry
Throws
Exception Description
\Zend_Feed_Builder_Exception
methodpublicsetId( string $id ) : \Zend_Feed_Builder_Entry

Sets the id/guid of the entry

Parameters
Name Type Description
$id string
Returns
Type Description
\Zend_Feed_Builder_Entry
methodpublicsetLastUpdate( int $lastUpdate ) : \Zend_Feed_Builder_Entry

Timestamp of the update date

Parameters
Name Type Description
$lastUpdate int
Returns
Type Description
\Zend_Feed_Builder_Entry
methodpublicsetSource( string $title, string $url ) : \Zend_Feed_Builder_Entry

Defines a reference to the original source

Parameters
Name Type Description
$title string
$url string
Returns
Type Description
\Zend_Feed_Builder_Entry
Documentation was generated by DocBlox 0.15.1.