Actions

API16

JFactory/getXMLParser

From Joomla! Documentation

< API16:JFactory
Revision as of 17:47, 22 March 2010 by Doxiki (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

Get an XML document

[Edit Descripton]

Description:JFactory/getXMLParser

Syntax

static getXMLParser($type= '', $options=array())
Parameter Name Default Value Description
$type The type of xml parser needed 'DOM', 'RSS' or 'Simple'
$options array() string ['rssUrl'] the rss url to parse when using "RSS" string ['cache_time'] with 'RSS' - feed cache time. If not defined defaults to 3600 sec

Returns

object Parsed XML document object

Defined in

libraries/joomla/factory.php

Importing

jimport( 'joomla.factory' );

Source Body

public static function getXMLParser($type = '', $options = array())
{
        $doc = null;
 
        switch (strtolower($type))
        {
                case 'rss' :
                case 'atom' :
                        {
                                $cache_time = isset($options['cache_time']) ? $options['cache_time'] : 0;
                                $doc = JFactory::getFeedParser($options['rssUrl'], $cache_time);
                        }       break;
 
                case 'simple':
                        // JError::raiseWarning('SOME_ERROR_CODE', 'JSimpleXML is deprecated. Use JFactory::getXML instead');
                        jimport('joomla.utilities.simplexml');
                        $doc = new JSimpleXML();
                        break;
 
                case 'dom':
                        JError::raiseWarning('SOME_ERROR_CODE', 'DommitDocument is deprecated.  Use DomDocument instead');
                        $doc = null;
                        break;
 
                        throw new JException('DommitDocument is deprecated.  Use DomDocument instead');
                default :
                        $doc = null;
        }
 
        return $doc;
}

[Edit See Also] SeeAlso:JFactory/getXMLParser

Examples

<CodeExamplesForm />