SAFOX

Packages:

SAFOX

Files:

safox.cls.php

SAFOX_G
safox_g.cls.php

SAFOX_P
safox_p.cls.php

SAFOX_RSS
safox_g_rss.cls.php
safox_p_rss.cls.php

Classes:

SAFOX

SAFOX_G
xmlDoc
xmlNode

SAFOX_RSS
RSSDoc
RSSItem
RSSParser

SAFOX_P
xmlParser

Class: RSSItem

Source Location: /safox_g_rss.cls.php

Class RSSItem

Class Overview

RSSItem is class representing the item nodes of an RSS channel

The current version of the SAFOX RSS Generation API allows generation of valid RSS 2.0 code. However, it does not yet support the optional channel properties (sub-elements): cloud, skipHours,skipDays, textInput Also, the current version does not check for standard compliancy, that is it does not check if CData provided for subelements is valid according to the specifications (e.g. if a required email is valid or an url provided etc) The RSSItem also does not yet check for validity of supplied information. Instances of the RSSItem class are returned by the getItem-methods of the RSSDoc class (getNextItem(), getLastItem() ...) and may be used to set and edit the item properties/subtags Changes History : See File Information for changes

Located in /safox_g_rss.cls.php [line 512]

Author(s):

CVH, cpi-service; cvh@cpi-service.com

Information Tags:

License:	GNU
Version:	0.1

Properties

Methods

[ Top ]

Property Summary

mixed	$rssDoc
mixed	$self

[ Top ]

Method Summary

RSSItem	RSSItem()	constructor of the RSSItem Class
string	getAuthor()	method returns the value of the author tag of the Item
string	getCategory()	method returns the value of the category tag of the Item
string	getComments()	method returns the value of the comments tag of the Item
string	getDescription()	method returns the value of the description tag of the Item
string	getLink()	method returns the value of the link tag of the Item
timestamp	getPubDate()	method returns the value of the pubDate tag of the Item
string	getSource()	method returns the value of the source tag of the Item
string	getTitle()	method returns the value of the title tag of the Item
void	setAuthor()	method sets/changes the optional author tag of the Item
void	setCategory()	method sets/changes the optional category tag of the Item
void	setComments()	method sets/changes the optional comments tag of the Item
void	setDescription()	method sets/changes the description tag of the Item
void	setEnclosure()	method sets/changes the optional enclosure tag of the Item
void	setGuid()	method sets/changes the optional guid tag of the Item
void	setLink()	method sets/changes the link tag of the Item
void	setPubDate()	method sets/changes the optional PubDate tag of the Item
void	setSource()	method sets/changes the optional source tag of the Item
void	setTitle()	method sets/changes the title tag of the Item

[ Top ]

Properties

mixed $rssDoc = null [line 513]

[ Top ]

mixed $self = null [line 514]

[ Top ]

Methods

Constructor RSSItem [line 522]

RSSItem RSSItem(
RSSDoc
&$rssDoc, string
$title, string
$link, string
$description 
)

constructor of the RSSItem Class

Parameters:

RSSDoc	&$rssDoc:	Instance of parent RSS document
string	$title:	title
string	$link:	link
string	$description:	description

[ Top ]

getAuthor [line 663]

string getAuthor(
)

method returns the value of the author tag of the Item

[ Top ]

getCategory [line 673]

string getCategory(
)

method returns the value of the category tag of the Item

[ Top ]

getComments [line 683]

string getComments(
)

method returns the value of the comments tag of the Item

[ Top ]

getDescription [line 653]

string getDescription(
)

method returns the value of the description tag of the Item

[ Top ]

getLink [line 643]

string getLink(
)

method returns the value of the link tag of the Item

[ Top ]

getPubDate [line 694]

timestamp getPubDate(
[boolean
$asTimeStamp = true] 
)

method returns the value of the pubDate tag of the Item

Parameters:

boolean

$asTimeStamp:

returnAsTimeStamp

API Tags:

Return:

or string or boolean false

[ Top ]

getSource [line 709]

string getSource(
)

method returns the value of the source tag of the Item

[ Top ]

getTitle [line 633]

string getTitle(
)

method returns the value of the title tag of the Item

[ Top ]

setAuthor [line 571]

void setAuthor(
mixed
$string 
)

method sets/changes the optional author tag of the Item

[ Top ]

setCategory [line 603]

void setCategory(
mixed
$string 
)

method sets/changes the optional category tag of the Item

[ Top ]

setComments [line 622]

void setComments(
mixed
$stringURl 
)

method sets/changes the optional comments tag of the Item

[ Top ]

setDescription [line 553]

void setDescription(
mixed
$strValue 
)

method sets/changes the description tag of the Item

[ Top ]

setEnclosure [line 580]

void setEnclosure(
mixed
$url, mixed
$bytelength, mixed
$mimetype 
)

method sets/changes the optional enclosure tag of the Item

[ Top ]

setGuid [line 591]

void setGuid(
mixed
$string, [mixed
$isPermaLink = false] 
)

method sets/changes the optional guid tag of the Item

[ Top ]

setLink [line 544]

void setLink(
mixed
$strValue 
)

method sets/changes the link tag of the Item

[ Top ]

setPubDate [line 562]

void setPubDate(
mixed
$timestamp, [mixed
$format = "r"] 
)

method sets/changes the optional PubDate tag of the Item

[ Top ]

setSource [line 612]

void setSource(
mixed
$string, mixed
$url 
)

method sets/changes the optional source tag of the Item

[ Top ]

setTitle [line 535]

void setTitle(
mixed
$strValue 
)

method sets/changes the title tag of the Item

[ Top ]

Documentation generated on Thu, 9 Feb 2006 13:55:14 +0100 by phpDocumentor 1.3.0RC3

	SAFOX SAFOX_RSS

[ class tree: SAFOX ] [ index: SAFOX ] [ all elements ]