XML_Feed_Parser
[ class tree: XML_Feed_Parser ] [ index: XML_Feed_Parser ] [ all elements ]
Packages:
XML_Feed_Parser


Classes:
XML_Feed_Parser
XML_Feed_Parser_Atom
XML_Feed_Parser_AtomElement
XML_Feed_Parser_Exception
XML_Feed_Parser_RSS09
XML_Feed_Parser_RSS09Element
XML_Feed_Parser_RSS1
XML_Feed_Parser_RSS1Element
XML_Feed_Parser_RSS2
XML_Feed_Parser_RSS2Element
XML_Feed_Parser_RSS11
XML_Feed_Parser_RSS11Element
XML_Feed_Parser_Type
Files:
accessTypes.php
amp.php
atom.php
Atom.php
atom10.php
atomCompliance.php
AtomElement.php
atomEntryOnly.php
atomValues.php
base.php
cdf.php
convert-tests.php
date.php
encoding.php
errors.php
Exception.php
farsi.php
feedburner.php
http.php
iteration.php
itunes.php
japanese.php
lang.php
namespace.php
Parser.php
rdf.php
rss.php
RSS09.php
RSS09Element.php
rss091Values.php
rss092Values.php
RSS1.php
RSS1Element.php
rss1Values.php
RSS2.php
RSS2Element.php
rss2Values.php
RSS11.php
RSS11Element.php
sanitize.php
tidy.php
Type.php
XML_Feed_Parser_TestCase.php

Class: XML_Feed_Parser

Source Location: /XML_Feed_Parser-1.0.0RC2/Parser.php

Class Overview




This is the core of the XML_Feed_Parser package. It identifies feed types  and abstracts access to them. It is an iterator, allowing for easy access  to the entire feed.




Author(s):






    
        

Version:


    
  
  • Release: @package_version@
    • 









Methods
















Inherited Variables





Inherited Methods














Class Details



[line 45]

This is the core of the XML_Feed_Parser package. It identifies feed types  and abstracts access to them. It is an iterator, allowing for easy access  to the entire feed.









[ Top ]








Method Detail



	
	
__construct (Constructor)   [line 87]

	

    

    

		XML_Feed_Parser __construct(
string
$feed, [bool
$strict = false], [bool
$suppressWarnings = false], [bool
$tidy = false])
    

    


	
		Detects feed types and instantiate appropriate objects.
Our constructor takes care of detecting feed types and instantiating  appropriate classes. For now we're going to treat Atom 0.3 as Atom 1.0  but raise a warning. I do not intend to introduce full support for  Atom 0.3 as it has been deprecated, but others are welcome to.




        
Parameters:

    

    

          

        string  
        $feed  
        —
          XML serialization of the feed
      

          

        bool  
        $strict  
        —
          Whether or not to validate the feed
      

          

        bool  
        $suppressWarnings  
        —
          Trigger errors for deprecated feed types?
      

          

        bool  
        $tidy  
        —
          Whether or not to try and use the tidy library on input
      

        

    


        
[ Top ]

  

  
  
	
	
current   [line 240]

	

    

    

		XML_Feed_Parser_Type current(
)
    

    


	
		Return XML_Feed_Type object for current element


    

  • Return: Object
    • 








        
[ Top ]

  

  
  
	
	
getEntryById   [line 286]

	

    

    

		XML_Feed_Parser_Type|false getEntryById(
string
$id)
    

    


	
		Provides access to entries by ID if one is specified in the source feed.
As well as allowing the items to be iterated over we want to allow  users to be able to access a specific entry. This is one of two ways of  doing that, the other being by offset. This method can be quite slow  if dealing with a large feed that hasn't yet been processed as it  instantiates objects for every entry until it finds the one needed.




        
Parameters:

    

    

          

        string  
        $id  
        —
          Valid ID for the given feed format
      

        

    


        
[ Top ]

  

  
  
	
	
getEntryByOffset   [line 310]

	

    

    

		XML_Feed_Parser_Type|false getEntryByOffset(
int
$offset)
    

    


	
		Retrieve entry by numeric offset, starting from zero.
As well as allowing the items to be iterated over we want to allow  users to be able to access a specific entry. This is one of two ways of  doing that, the other being by ID.




        
Parameters:

    

    

          

        int  
        $offset  
        —
          The position of the entry within the feed, starting from 0
      

        

    


        
[ Top ]

  

  
  
	
	
key   [line 250]

	

    

    

		int key(
)
    

    


	
		For iteration -- returns the key for the current stage in the array.




        
[ Top ]

  

  
  
	
	
next   [line 223]

	

    

    

		void next(
)
    

    


	
		Provides iteration functionality.
Of course we must be able to iterate... This function simply increases  our internal counter.




        
[ Top ]

  

  
  
	
	
rewind   [line 269]

	

    

    

		void rewind(
)
    

    


	
		For iteration -- resets the internal counter to the beginning.




        
[ Top ]

  

  
  
	
	
valid   [line 261]

	

    

    

		bool valid(
)
    

    


	
		For iteration -- tells whether we have reached the  end.




        
[ Top ]

  

  
  
	
	
version   [line 336]

	

    

    

		void version(
)
    

    


	
		Retrieve version details from feed type class.


    

  • Author: James Stewart
    • 








        
[ Top ]

  

  
  
	
	
__call   [line 196]

	

    

    

		void __call(
string
$call, array
$attributes)
    

    


	
		Proxy to allow feed element names to be used as method names
For top-level feed elements we will provide access using methods or  attributes. This function simply passes on a request to the appropriate  feed type object.




        
Parameters:

    

    

          

        string  
        $call  
        —
          - the method being called
      

          

        array  
        $attributes  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
__get   [line 212]

	

    

    

		void __get(
string
$val)
    

    


	
		Proxy to allow feed element names to be used as attribute names
To allow variable-like access to feed-level data we use this  method. It simply passes along to __call() which in turn passes  along to the relevant object.




        
Parameters:

    

    

          

        string  
        $val  
        —
          - the name of the variable required
      

        

    


        
[ Top ]

  

  
  
	
	
__toString   [line 346]

	

    

    

		String __toString(
)
    

    


	
		Returns a string representation of the feed.




        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Thu, 09 Nov 2006 10:32:04 -0500 by phpDocumentor 1.3.0. PEAR Logo Copyright ©  PHP Group 2004.