Login   Register  
PHP Classes
elePHPant
Icontem

File: Abs_Xml_Rss/AbsAtomReader10/class.AbsAtomReader10.php

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Classes of Costin Trifan  >  Abs_Xml_Rss  >  Abs_Xml_Rss/AbsAtomReader10/class.AbsAtomReader10.php  >  Download  
File: Abs_Xml_Rss/AbsAtomReader10/class.AbsAtomReader10.php
Role: Class source
Content type: text/plain
Description: The base class
Class: Abs_Xml_Rss
Read and write RSS and Atom feeds
Author: By
Last change:
Date: 5 years ago
Size: 5,227 bytes
 

Contents

Class file image Download
<?php
/**
* class AbsAtomReader10
*
* Parse an ATOM 1.0 xml feed and retrieve the result as an associative array.
*
* @package    Abs_Xml_Rss
* @category   XML, RSS
* @author     Costin Trifan <costintrifan@yahoo.com>
* @copyright  2009 Costin Trifan
* @licence    http://en.wikipedia.org/wiki/MIT_License   MIT License
* @version    1.0

* Copyright (c) 2009 Costin Trifan <http://june-js.com/>

* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:

* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.

* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
class AbsAtomReader10
{
    private function 
__clone(){}

    
// constructor
    
public function __construct(){}


    
/**
    * Holds the reference to the instance of the DOMDocument class
    * @type object
    */
    
protected static $_doc null;

    
/**
    * Whether or not the xml document has been loaded.
    * @type bool
    * @access private
    */
    
protected static $_loaded FALSE;



    
/**
    * Load the xml document
    * @param string $filePath  The path to the xml document
    * @return void
    */
    
final public function Load$filePath )
    {
        if (
is_null($filePath) or strlen($filePath) < 1)
            exit(
"Error in ".__CLASS__.'::'.__FUNCTION__.'<br/>The path to the rss file is missing!');

        
// LOAD XML DOCUMENT
        
self::$_doc = new DOMDocument();
        if (@
self::$_doc->load($filePath))
            
self::$_loaded TRUE;
        else exit(
"Error: The rss file could not be opened!");
    }

    
/**
    * Get the feed's base tags as an associative array
    * @return array
    */
    
final public function GetBaseTags()
    {
        
$result = array();
        if ( ! 
self::$_loaded) return $result;

        
$title self::$_doc->getElementsByTagName('title')->item(0);
        if ( ! 
is_null($title))
            
$result[$title->tagName] = $title->nodeValue;

        
$subtitle self::$_doc->getElementsByTagName('subtitle')->item(0);
        if ( ! 
is_null($subtitle))
            
$result[$subtitle->tagName] = $subtitle->nodeValue;

        
$link self::$_doc->getElementsByTagName('link')->item(0);
        if ( ! 
is_null($link))
        {
            
$result[$link->tagName] = $link->nodeValue;

            
$result[$link->tagName] = array();
            
$result[$link->tagName]['href'] = $link->getAttribute('href');
            
$result[$link->tagName]['rel'] = $link->getAttribute('rel');
        }

        
$updated self::$_doc->getElementsByTagName('updated')->item(0);
        if ( ! 
is_null($updated))
            
$result[$updated->tagName] = $updated->nodeValue;

        
$author self::$_doc->getElementsByTagName('author')->item(0);
        if ( ! 
is_null($author))
        {
            
$result[$author->tagName] = array();

            if ( ! 
is_null($author->getElementsByTagName('name')->item(0)))
                
$result[$author->tagName]['name'] = $author->getElementsByTagName('name')->item(0)->nodeValue;

            if ( ! 
is_null($author->getElementsByTagName('email')->item(0)))
                
$result[$author->tagName]['email'] = $author->getElementsByTagName('email')->item(0)->nodeValue;
        }

        
$id self::$_doc->getElementsByTagName('id')->item(0);
        if ( ! 
is_null($id))
            
$result[$id->tagName] = $id->nodeValue;

        return 
$result;
    }

    
/**
    * Get the feed's entries as an associative array
    *
    * @param int $maxLimit  The maximum number of items to retrieve from the document.
    * If $maxLimit = 0 all records will be retrieved.
    * @return array
    */
    
final public function GetEntries$maxLimit )
    {
        
$result = array();
        if ( ! 
self::$_loaded) return $result;

        
$i 0;
        foreach (
self::$_doc->getElementsByTagName('entry') as $entry)
        {
            
$result['entry_'.$i] = array();
            foreach (
$entry->getElementsByTagName('*') as $tag)
                
$result['entry_'.$i][$tag->tagName] = html_entity_decode($tag->nodeValueENT_QUOTES'UTF-8') ;

            if ( ! 
is_null($entry->getElementsByTagName('link')->item(0)))
                
$result['entry_'.$i]['link'] = $entry->getElementsByTagName('link')->item(0)->getAttribute('href');

            
$i++;
            if (
$maxLimit == $i) break;
        }
        return 
$result;
    }

    
/**
    * Get all data from the rss feed as an associative array
    * @return array
    */
    
final public function GetAll()
    {
        
$result = array();
        if ( ! 
self::$_loaded) return $result;

        
$baseTags $this->GetBaseTags();
        
$atomEntries $this->GetEntries();

        
$result array_merge($baseTags$atomEntries);

        return 
$result;
    }

}
// >> END
?>