RssParser Class Reference

Class to parse RSS files. More...

Public Member Functions
	__construct ($db)
	Constructor. More...
	getFormat ()
	getFormat More...
	getUrlRss ()
	getUrlRss More...
	getLanguage ()
	getLanguage More...
	getGenerator ()
	getGenerator More...
	getCopyright ()
	getCopyright More...
	getLastBuildDate ()
	getLastBuildDate More...
	getImageUrl ()
	getImageUrl More...
	getLink ()
	getLink More...
	getTitle ()
	getTitle More...
	getDescription ()
	getDescription More...
	getLastFetchDate ()
	getLastFetchDate More...
	getItems ()
	getItems More...
	parser ($urlRSS, $maxNb=0, $cachedelay=60, $cachedir= '')
	Parse rss URL. More...
	feed_start_element ($p, $element, &$attrs)
	Triggered when opened tag is found. More...
	feed_cdata ($p, $text)
	Triggered when CDATA is found. More...
	feed_end_element ($p, $el)
	Triggered when closed tag is found. More...
	concat (&$str1, $str2="")
	To concat 2 string with no warning if an operand is not defined. More...
	append_content ($text)
	Enter description here ... More...
	append ($el, $text)
	smart append - field and namespace aware More...

Private Member Functions
	getAtomItemDescription (array $item, $maxlength=500)
	Return a description/summary for one item from a ATOM feed. More...
	getAtomImageUrl (array $feed)
	Return a URL to a image of the given ATOM feed. More...

Detailed Description

Class to parse RSS files.

Definition at line 27 of file rssparser.class.php.

Constructor & Destructor Documentation

RssParser::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 62 of file rssparser.class.php.

References db.

Member Function Documentation

RssParser::append	(		$el,
			$text
	)

smart append - field and namespace aware

Parameters

string	$el	El
string	$text	Text

Returns

void

Definition at line 677 of file rssparser.class.php.

References concat().

Referenced by feed_cdata(), and feed_start_element().

RssParser::append_content

(

$text

)

Enter description here ...

Parameters

string

$text

Text

Returns

void

Definition at line 660 of file rssparser.class.php.

References concat().

Referenced by feed_cdata(), feed_end_element(), and feed_start_element().

RssParser::concat	(	&	$str1,
			$str2 = ""
	)

To concat 2 string with no warning if an operand is not defined.

Parameters

string	$str1	Str1
string	$str2	Str2

Returns

string String cancatenated

Definition at line 645 of file rssparser.class.php.

Referenced by append(), and append_content().

RssParser::feed_cdata	(		$p,
			$text
	)

Triggered when CDATA is found.

Parameters

string	$p	P
string	$text	Tag

Returns

void

Definition at line 577 of file rssparser.class.php.

References append(), and append_content().

RssParser::feed_end_element	(		$p,
			$el
	)

Triggered when closed tag is found.

Parameters

string	$p	P
string	$el	Tag

Returns

void

Definition at line 597 of file rssparser.class.php.

References append_content().

RssParser::feed_start_element	(		$p,
			$element,
		&	$attrs
	)

Triggered when opened tag is found.

Parameters

string	$p	Start
string	$element	Tag
array	$attrs	Attributes of tags

Returns

void

Definition at line 461 of file rssparser.class.php.

References append(), and append_content().

RssParser::getAtomImageUrl ( array  $feed )

private

Return a URL to a image of the given ATOM feed.

Parameters

array

$feed

The ATOM feed that possible contain a link to a logo or icon

Returns

string A URL to a image from a ATOM feed when found, otherwise a empty string

Definition at line 746 of file rssparser.class.php.

Referenced by parser().

RssParser::getAtomItemDescription ( array  $item,   $maxlength = 500  )

private

Return a description/summary for one item from a ATOM feed.

Parameters

array	$item	A parsed item of a ATOM feed
int	$maxlength	(optional) The maximum length for the description

Returns

string A summary description

Definition at line 713 of file rssparser.class.php.

Referenced by parser().

RssParser::getCopyright

(

)

getCopyright

Returns

string

Definition at line 109 of file rssparser.class.php.

RssParser::getDescription

(

)

getDescription

Returns

string

Definition at line 154 of file rssparser.class.php.

RssParser::getFormat

(

)

getFormat

Returns

string

Definition at line 72 of file rssparser.class.php.

RssParser::getGenerator

(

)

getGenerator

Returns

string

Definition at line 100 of file rssparser.class.php.

RssParser::getImageUrl

(

)

getImageUrl

Returns

string

Definition at line 127 of file rssparser.class.php.

RssParser::getItems

(

)

getItems

Returns

string

Definition at line 172 of file rssparser.class.php.

RssParser::getLanguage

(

)

getLanguage

Returns

string

Definition at line 91 of file rssparser.class.php.

RssParser::getLastBuildDate

(

)

getLastBuildDate

Returns

string

Definition at line 118 of file rssparser.class.php.

RssParser::getLastFetchDate

(

)

getLastFetchDate

Returns

string

Definition at line 163 of file rssparser.class.php.

RssParser::getLink

(

)

getLink

Returns

string

Definition at line 136 of file rssparser.class.php.

RssParser::getTitle

(

)

getTitle

Returns

string

Definition at line 145 of file rssparser.class.php.

RssParser::getUrlRss

(

)

getUrlRss

Returns

string

Definition at line 82 of file rssparser.class.php.

RssParser::parser	(		$urlRSS,
			$maxNb = 0,
			$cachedelay = 60,
			$cachedir = ''
	)

Parse rss URL.

Parameters

string	$urlRSS	Url to parse
int	$maxNb	Max nb of records to get (0 for no limit)
int	$cachedelay	0=No cache, nb of seconds we accept cache files (cachedir must also be defined)
string	$cachedir	Directory where to save cache file

Returns

int <0 if KO, >0 if OK

Definition at line 187 of file rssparser.class.php.

References dol_filemtime(), dol_hash(), dol_is_dir(), dol_is_url(), dol_mkdir(), dol_now(), dol_syslog(), getAtomImageUrl(), getAtomItemDescription(), if, print, and xml2php().

---

The documentation for this class was generated from the following file:

• htdocs/core/class/rssparser.class.php