API16

Difference between revisions of "JFactory/getXMLParser"

From Joomla! Documentation

< API16:JFactory
(New page: ===Description=== Get an XML document <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki> </sp...)
 
m (removing red link to edit, no existant pages)
Line 3: Line 3:
  
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JFactory/getXMLParser|Edit Descripton]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
  
{{Description:JFactory/getXMLParser}}
+
<! removed transcluded page call, red link never existed >
  
 
===Syntax===
 
===Syntax===
Line 70: Line 70:
  
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JFactory/getXMLParser|Edit See Also]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
{{SeeAlso:JFactory/getXMLParser}}
+
<! removed transcluded page call, red link never existed >
  
 
===Examples===
 
===Examples===
Line 85: Line 85:
 
  format= ,,,
 
  format= ,,,
 
</dpl>
 
</dpl>
 +
[[Category:Archived pages API16]]

Revision as of 00:06, 13 May 2013

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

Get an XML document

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax[edit]

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[edit]

object Parsed XML document object

Defined in[edit]

libraries/joomla/factory.php

Importing[edit]

jimport( 'joomla.factory' );

Source Body[edit]

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;
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples[edit]

<CodeExamplesForm />