PHP Class FeedWriter\Item

Item class - Used as feed element in Feed class
See link: http://www.ajaxray.com/projects/rss
Author: Anis uddin Ahmad ([email protected])
Show file Open project: mibe/feedwriter Class Usage Examples

Public Methods

Method Description
__construct ( string $version = Feed::RSS2 ) Constructor
addElement ( string $elementName, string $content, array $attributes = null, boolean $overwrite = FALSE, boolean $allowMultiple = FALSE ) : self Add an element to elements array
addElementArray ( array $elementArray ) : self Set multiple feed elements from an array.
addEnclosure ( string $url, integer $length, string $type, boolean $multiple = TRUE ) : self Attach a external media to the feed item.
getElements ( ) : array Return the collection of elements in this feed item
getVersion ( ) : string Return the type of this feed item
setAuthor ( string $author, string | null $email = null, string | null $uri = null ) : self Set the 'author' element of feed item.
setContent ( string $content ) : self Set the 'content' element of the feed item For ATOM feeds only
setDate ( DateTim\DateTime | integer | string $date ) : self Set the 'date' element of the feed item.
setDescription ( string $description ) : self Set the 'description' element of feed item
setId ( string $id, boolean $permaLink = false ) : self Set the unique identifier of the feed item
setLink ( string $link ) : self Set the 'link' element of feed item
setTitle ( string $title ) : self Set the 'title' element of feed item

Private Methods

Method Description
cpt ( ) : integer Return an unique number

Method Details

__construct() public method

Constructor
public __construct ( string $version = Feed::RSS2 )
$version string constant (RSS1/RSS2/ATOM) RSS2 is default.

addElement() public method

Add an element to elements array
public addElement ( string $elementName, string $content, array $attributes = null, boolean $overwrite = FALSE, boolean $allowMultiple = FALSE ) : self
$elementName string The tag name of an element
$content string The content of tag
$attributes array Attributes (if any) in 'attrName' => 'attrValue' format
$overwrite boolean Specifies if an already existing element is overwritten.
$allowMultiple boolean Specifies if multiple elements of the same name are allowed.
return self

addElementArray() public method

Elements which have attributes cannot be added by this method
public addElementArray ( array $elementArray ) : self
$elementArray array
return self

addEnclosure() public method

Not supported in RSS 1.0 feeds. See RFC 4288 for syntactical correct MIME types. Note that you should avoid the use of more than one enclosure in one item, since some RSS aggregators don't support it.
See link: https://tools.ietf.org/html/rfc4288
public addEnclosure ( string $url, integer $length, string $type, boolean $multiple = TRUE ) : self
$url string The URL of the media.
$length integer The length of the media.
$type string The MIME type attribute of the media.
$multiple boolean Specifies if multiple enclosures are allowed
return self

getElements() public method

Return the collection of elements in this feed item
public getElements ( ) : array
return array All elements of this item.

getVersion() public method

Return the type of this feed item
public getVersion ( ) : string
return string The feed type, as defined in Feed.php

setAuthor() public method

Not supported in RSS 1.0 feeds.
public setAuthor ( string $author, string | null $email = null, string | null $uri = null ) : self
$author string The author of this item
$email string | null Optional email address of the author
$uri string | null Optional URI related to the author
return self

setContent() public method

Set the 'content' element of the feed item For ATOM feeds only
public setContent ( string $content ) : self
$content string Content for the item (i.e., the body of a blog post).
return self

setDate() public method

The value of the date parameter can be either an instance of the DateTime class, an integer containing a UNIX timestamp or a string which is parseable by PHP's 'strtotime' function.
public setDate ( DateTim\DateTime | integer | string $date ) : self
$date DateTim\DateTime | integer | string Date which should be used.
return self

setDescription() public method

Set the 'description' element of feed item
public setDescription ( string $description ) : self
$description string The content of the 'description' or 'summary' element
return self

setId() public method

On ATOM feeds, the identifier must begin with an valid URI scheme.
public setId ( string $id, boolean $permaLink = false ) : self
$id string The unique identifier of this item
$permaLink boolean The value of the 'isPermaLink' attribute in RSS 2 feeds.
return self

setTitle() public method

Set the 'title' element of feed item
public setTitle ( string $title ) : self
$title string The content of 'title' element
return self