API Documentation

Feed/Builder/Entry.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Feed
version
$Id: Entry.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Feed_Builder_Entry

Description

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.

Zend_Feed_Builder_Entry
jump to top

Extends from
ArrayObject
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Feed
Methods
__construct
__get
__set
__isset
__unset
setAuthor
setId
setContent
setLastUpdate
setCommentsUrl
setCommentsRssUrl
setSource
setCategories
addCategory
setEnclosures
addEnclosure

Description

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

Methods

__construct
jump to class

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

Create a new builder entry

Arguments
$title
string
$link
string
$description
string
short version of the entry, no html
Details
visibility
public
final
false
static
false

__get
jump to class

__get( string $name ) : mixed

Read only properties accessor

Arguments
$name
string
property to read
Output
mixed
Details
visibility
public
final
false
static
false

__isset
jump to class

__isset( string $key ) : boolean

Isset accessor

Arguments
$key
string
Output
boolean
Details
visibility
public
final
false
static
false

__set
jump to class

__set( string $name, mixed $value ) : void

Write properties accessor

Arguments
$name
string
name of the property to set
$value
mixed
value to set
Details
visibility
public
final
false
static
false

__unset
jump to class

__unset( string $key ) : void

Unset accessor

Arguments
$key
string
Details
visibility
public
final
false
static
false

addCategory
jump to class

addCategory( array $category ) : Zend_Feed_Builder_Entry

Add a category to the entry

Arguments
$category
array
see Zend_Feed_Builder_Entry::setCategories() for format
Output
Zend_Feed_Builder_Entry
Details
visibility
public
final
false
static
false
throws

addEnclosure
jump to class

addEnclosure( string $url, string $type, string $length ) : Zend_Feed_Builder_Entry

Add an enclosure to the entry

Arguments
$url
string
$type
string
$length
string
Output
Zend_Feed_Builder_Entry
Details
visibility
public
final
false
static
false

setAuthor
jump to class

setAuthor( string $author ) : Zend_Feed_Builder_Entry

Sets the author of the entry

Arguments
$author
string
Output
Zend_Feed_Builder_Entry
Details
visibility
public
final
false
static
false

setCategories
jump to class

setCategories( array $categories ) : Zend_Feed_Builder_Entry

Sets the categories of the entry Format of the array: <code> array( array( 'term' => 'first category label', 'scheme' => 'url that identifies a categorization scheme' // optional ), // second category and so one ) </code>

Arguments
$categories
array
Output
Zend_Feed_Builder_Entry
Details
visibility
public
final
false
static
false

setCommentsRssUrl
jump to class

setCommentsRssUrl( string $commentRss ) : Zend_Feed_Builder_Entry

Sets the url of the comments feed link

Arguments
$commentRss
string
Output
Zend_Feed_Builder_Entry
Details
visibility
public
final
false
static
false

setCommentsUrl
jump to class

setCommentsUrl( string $comments ) : Zend_Feed_Builder_Entry

Sets the url of the commented page associated to the entry

Arguments
$comments
string
Output
Zend_Feed_Builder_Entry
Details
visibility
public
final
false
static
false

setContent
jump to class

setContent( string $content ) : Zend_Feed_Builder_Entry

Sets the full html content of the entry

Arguments
$content
string
Output
Zend_Feed_Builder_Entry
Details
visibility
public
final
false
static
false

setEnclosures
jump to class

setEnclosures( array $enclosures ) : Zend_Feed_Builder_Entry

Sets the enclosures of the entry Format of the array: <code> 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 ) </code>

Arguments
$enclosures
array
Output
Zend_Feed_Builder_Entry
Details
visibility
public
final
false
static
false
throws

setId
jump to class

setId( string $id ) : Zend_Feed_Builder_Entry

Sets the id/guid of the entry

Arguments
$id
string
Output
Zend_Feed_Builder_Entry
Details
visibility
public
final
false
static
false

setLastUpdate
jump to class

setLastUpdate( int $lastUpdate ) : Zend_Feed_Builder_Entry

Timestamp of the update date

Arguments
$lastUpdate
int
Output
Zend_Feed_Builder_Entry
Details
visibility
public
final
false
static
false

setSource
jump to class

setSource( string $title, string $url ) : Zend_Feed_Builder_Entry

Defines a reference to the original source

Arguments
$title
string
$url
string
Output
Zend_Feed_Builder_Entry
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.