core/model/modx/xmlrss/magpierss.class.php

Show:

inherited

Constants
- ATOM
- CASE_LOWER
- CASE_UPPER
- RSS
Functions
- array_change_key_case
- map_attrs
Classes
- \MagpieRSS

Table of Contents

Constants

 
                RSS
                = 'RSS'

Project: MagpieRSS: a simple RSS integration tool File: rss_parse.inc - parse an RSS or Atom feed return as a simple object.

Handles RSS 0.9x, RSS 2.0, RSS 1.0, and Atom 0.3

The lastest version of MagpieRSS can be obtained from: http://magpierss.sourceforge.net

For questions, help, comments, discussion, etc., please join the Magpie mailing list: [email protected]

Author: Kellan Elliott-McCrea
License: GPL
Version: 0.7a

 
                ATOM
                = 'Atom'

 
                CASE_UPPER
                = 1

 
                CASE_LOWER
                = 0

Functions

array_change_key_case(
           $array,  $case
              =
              CASE_LOWER
          )
        
        :
          void

Parameters

Name	Type	Description
$array
$case

map_attrs(
           $k,  $v
          )
        
        :
          void

Parameters

Name	Type	Description
$k
$v

\MagpieRSS
jump to top

Package: Default

Hybrid parser, and object, takes RSS as a string and returns a simple object.

see: magpierss.class.php for a simpler interface with integrated caching support

Properties


                 $ERROR= '""'

Default value""Details

Type: n/a


                 $WARNING= '""'

Default value""Details

Type: n/a


                 $_CONTENT_CONSTRUCTS= 'array('content', 'summary', 'info', 'title', 'tagline', 'copyright')'

Default valuearray('content', 'summary', 'info', 'title', 'tagline', 'copyright')Details

Type: n/a


                 $_KNOWN_ENCODINGS= 'array('UTF-8', 'US-ASCII', 'ISO-8859-1')'

Default valuearray('UTF-8', 'US-ASCII', 'ISO-8859-1')Details

Type: n/a


                 $_source_encoding= ''''

Default value''Details

Type: n/a


                 $channel= 'array()'

Default valuearray()Details

Type: n/a


                 $current_item= 'array()'

Default valuearray()Details

Type: n/a


                 $current_namespace= 'false'

Default valuefalseDetails

Type: n/a


                 $encoding= ''''

Default value''Details

Type: n/a


                 $feed_type= ''

Details

Type: n/a


                 $feed_version= ''

Details

Type: n/a


                 $image= 'array()'

Default valuearray()Details

Type: n/a


                 $inchannel= 'false'

Default valuefalseDetails

Type: n/a


                 $incontent= 'false'

Default valuefalseDetails

Type: n/a


                 $inimage= 'false'

Default valuefalseDetails

Type: n/a


                 $initem= 'false'

Default valuefalseDetails

Type: n/a


                 $intextinput= 'false'

Default valuefalseDetails

Type: n/a


                 $items= 'array()'

Default valuearray()Details

Type: n/a


                 $parser= ''

Details

Type: n/a


                 $stack= 'array()'

Default valuearray()Details

Type: n/a


                 $textinput= 'array()'

Default valuearray()Details

Type: n/a

Methods

__construct(
           $source, string $output_encoding
              =
              'ISO-8859-1', string $input_encoding
              =
              null, bool $detect_encoding
              =
              true
          )
        
        :
          void

Set up XML parser, parse source, and return populated RSS object..

@param string $source string containing the RSS to be parsed

NOTE: Probably a good idea to leave the encoding options alone unless you know what you're doing as PHP's character set support is a little weird.

NOTE: A lot of this is unnecessary but harmless with PHP5

Parameters

Name	Type	Description
$source
$output_encoding	string	output the parsed RSS in this character set defaults to ISO-8859-1 as this is PHP's default. NOTE: might be changed to UTF-8 in future versions.
$input_encoding	string	the character set of the incoming RSS source. Leave blank and Magpie will try to figure it out.
$detect_encoding	bool	if false Magpie won't attempt to detect source encoding. (caveat emptor)

append(
           $el,  $text
          )
        
        :
          void

Parameters

Name	Type	Description
$el
$text

append_content(
           $text
          )
        
        :
          void

Parameters

Name	Type	Description
$text

concat(
           $str1,  $str2
              =
              ""
          )
        
        :
          void

Parameters

Name	Type	Description
$str1
$str2

create_parser(
           $source,  $out_enc,  $in_enc,  $detect
          )
        
        :
          void

return XML parser, and possibly re-encoded source

Parameters

Name	Type	Description
$source
$out_enc
$in_enc
$detect

error(
           $errormsg,  $lvl
              =
              E_USER_WARNING
          )
        
        :
          void

Parameters

Name	Type	Description
$errormsg
$lvl

feed_cdata(
           $p,  $text
          )
        
        :
          void

Parameters

Name	Type	Description
$p
$text

feed_end_element(
           $p,  $el
          )
        
        :
          void

Parameters

Name	Type	Description
$p
$el

feed_start_element(
           $p,  $element,  $attrs
          )
        
        :
          void

Parameters

Name	Type	Description
$p
$element
$attrs

is_atom(
          
          )
        
        :
          void

is_rss(
          
          )
        
        :
          void

known_encoding(
           $enc
          )
        
        :
          void

Parameters

Name	Type	Description
$enc

normalize(
          
          )
        
        :
          void

php4_create_parser(
           $source,  $in_enc,  $detect
          )
        
        :
          void

Instaniate an XML parser under PHP4

Unfortunately PHP4's support for character encodings and especially XML and character encodings sucks. As long as the documents you parse only contain characters from the ISO-8859-1 character set (a superset of ASCII, and a subset of UTF-8) you're fine. However once you step out of that comfy little world things get mad, bad, and dangerous to know.

The following code is based on SJM's work with FoF

Parameters

Name	Type	Description
$source
$in_enc
$detect

Details

See: \http://minutillo.com/steve/weblog/2004/6/17/php-xml-and-character-encodings-a-tale-of-sadness-rage-and-data-loss

php5_create_parser(
           $in_enc,  $detect
          )
        
        :
          void

Instantiate an XML parser under PHP5

PHP5 will do a fine job of detecting input encoding if passed an empty string as the encoding.

All hail libxml2!

Parameters

Name	Type	Description
$in_enc
$detect

core/model/modx/xmlrss/magpierss.class.php

Constants

Functions

\MagpieRSSjump to top

Properties

Methods

\MagpieRSS
jump to top