Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
RSS_Feed_Reader Class Reference

Public Member Functions

 __construct ()
 
 setInputFile ($file='')
 
 setInputString ($xml)
 
 parse ()
 
 getRssType ()
 
 getItems ()
 
 getTextInput ()
 
 getChannelInfo ()
 
 getImageInfo ()
 
 getUnrecognisedElements ()
 
 startElementHandler ($xp, $name, $attributes)
 
 endElementHandler ($xp, $name)
 
 characterHandler ($xp, $data, $attributes=FALSE)
 
 _issetFile ()
 

Data Fields

 $open_tags = Array()
 
 $parent_tags = Array()
 
 $item = Array()
 
 $image = Array()
 
 $channel = Array()
 
 $textinput = Array()
 
 $attributes = Array()
 
 $unrecognised = Array()
 
 $element = ''
 
 $fp = NULL
 
 $parser
 
 $type = ''
 
 $parsed = FALSE
 

Detailed Description

Definition at line 29 of file rss_feed_reader.inc.

Constructor & Destructor Documentation

__construct ( )

Constructor

Definition at line 128 of file rss_feed_reader.inc.

Member Function Documentation

_issetFile ( )

Checks if the file pointer is set or not

Returns
boolean public

Definition at line 602 of file rss_feed_reader.inc.

characterHandler (   $xp,
  $data,
  $attributes = FALSE 
)

Handles the data

Parameters
object$xpthe xml parser
string$datadata inside the element
boolean$attributesdefault of false but becomes true when we are calling this to assign attributes
Returns
void public

Definition at line 455 of file rss_feed_reader.inc.

endElementHandler (   $xp,
  $name 
)

Handles the end of an element

Parameters
object$xpthe xml parser
string$namename of the element
Returns
void public

Definition at line 417 of file rss_feed_reader.inc.

getChannelInfo ( )

returns the array ofchannel info

Returns
array public

Definition at line 318 of file rss_feed_reader.inc.

getImageInfo ( )

Returns the array of image info

Returns
array public

Definition at line 331 of file rss_feed_reader.inc.

getItems ( )

Returns the array of all of the items

Returns
array public

Definition at line 292 of file rss_feed_reader.inc.

getRssType ( )

Returns a string of the type of the RSS as e.g. rss_1.0/ rss_2.0

Returns
array public

Definition at line 279 of file rss_feed_reader.inc.

getTextInput ( )

Returns the array of textinput elements of the RSS

Returns
array public

Definition at line 305 of file rss_feed_reader.inc.

getUnrecognisedElements ( )

Returns the array of all of the unrecognised elements

Returns
array public

Definition at line 344 of file rss_feed_reader.inc.

parse ( )

Parsers the file

Returns error message on error, TRUE on success.

Returns
boolean|string public

Definition at line 215 of file rss_feed_reader.inc.

setInputFile (   $file = '')

Accepts the path of the file to be parsed and sets the file pointer

Parameters
string$filethe path of the file to be parsed
Returns
boolean public

Definition at line 147 of file rss_feed_reader.inc.

setInputString (   $xml)

Set the file pointer

Parameters
int$xmlthe pointer to the xml file
Returns
boolean public

Definition at line 191 of file rss_feed_reader.inc.

startElementHandler (   $xp,
  $name,
  $attributes 
)

Handles the start if an element

Parameters
object$xpthe xml parser
string$namename of the element
array$attributesthe attributes
Returns
void public

Definition at line 367 of file rss_feed_reader.inc.


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