CINXE.COM

<!DOCTYPE html> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="generator" content="ApiGen 2.6.1" /> <title>SimplePie 1.3 API Documentation</title> <script type="text/javascript" src="resources/combined.js"></script> <script type="text/javascript" src="elementlist.js"></script>  <link rel="stylesheet" href="http://simplepie.org/css/simplepie.css" media="screen, projector" /> <link rel="stylesheet" type="text/css" media="all" href="resources/style.css?200447365" /> <link rel="stylesheet" type="text/css" media="all" href="resources/simplepie.css?1731886122" /> </head> <body id="apidocs"> <div id="header"> <div id="headerInner"> <div id="logoContainer"> <div id="logoContainerInner"> <div id="logo"><a href="/"><img src="/images/logo_simplepie_horizontal.png" alt="SimplePie: PHP-based RSS and Atom feed handling" title="SimplePie: PHP-based RSS and Atom feed handling" border="0" /></a></div> <div id="feed"><form action="http://www.google.com/search" method="get"><input type="text" name="q" id="q" value="" class="text" /><input type="hidden" name="as_sitesearch" value="simplepie.org" /> <input type="submit" value="Search" class="button" /></form></div> <div class="clearLeft"></div> </div> </div> <div id="menu"> <table cellpadding="0" cellspacing="0" border="0"><tbody><tr><td> <ul> <li id="overview"><a href="/">Overview</a></li> <li id="demo"><a href="/demo/">Demo</a></li> <li id="blog"><a href="/blog/">Blog</a></li> <li id="downloads"><a href="/downloads/">Download</a></li> <li id="docs"><a href="/wiki/">Documentation</a></li> <li id="api"><a href="/api/">API Docs</a></li> <li id="support"><a href="/support/">Support</a></li> <li id="bugs"><a href="http://github.com/simplepie/simplepie/issues">Issue Tracker</a></li> <li id="faq"><a href="/wiki/faq/start">FAQ</a></li> </ul> <div class="clearLeft"></div> </td></tr></tbody></table> </div> </div> </div> <div id="site"> <div id="bodycontent"> <form id="search" class="api-content"> <input type="hidden" name="cx" value="" /> <input type="hidden" name="ie" value="UTF-8" /> <input type="text" name="q" class="text" autofocus /> <input type="submit" value="Search" /> </form> <div id="navigation" class="api-content"> <ul> <li class="active"> <span>Overview</span> </li> <li> <span>Package</span> </li> <li> <span>Class</span> </li> </ul> <ul> <li> <a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a> </li> <li> <a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a> </li> </ul> <ul> </ul> </div> <div id="left" class="api-content"> <div id="api-menu"> <div id="groups"> <h3>Packages</h3> <ul> <li class="main"><a href="package-SimplePie.html">SimplePie<span></span></a> <ul> <li class="main"><a href="package-SimplePie.API.html">API</a> </li> <li class="main"><a href="package-SimplePie.Caching.html">Caching</a> </li> <li class="main"><a href="package-SimplePie.HTTP.html">HTTP</a> </li> <li class="main"><a href="package-SimplePie.Parsing.html">Parsing</a> </li> </ul></li> </ul> </div> <hr /> <div id="elements"> <h3>Classes</h3> <ul> <li><a href="class-SimplePie.html">SimplePie</a></li> <li><a href="class-SimplePie_Author.html">SimplePie_Author</a></li> <li><a href="class-SimplePie_Cache.html">SimplePie_Cache</a></li> <li><a href="class-SimplePie_Cache_DB.html">SimplePie_Cache_DB</a></li> <li><a href="class-SimplePie_Cache_File.html">SimplePie_Cache_File</a></li> <li><a href="class-SimplePie_Cache_Memcache.html">SimplePie_Cache_Memcache</a></li> <li><a href="class-SimplePie_Cache_MySQL.html">SimplePie_Cache_MySQL</a></li> <li><a href="class-SimplePie_Caption.html">SimplePie_Caption</a></li> <li><a href="class-SimplePie_Category.html">SimplePie_Category</a></li> <li><a href="class-SimplePie_Content_Type_Sniffer.html">SimplePie_Content_Type_Sniffer</a></li> <li><a href="class-SimplePie_Copyright.html">SimplePie_Copyright</a></li> <li><a href="class-SimplePie_Core.html" class="deprecated">SimplePie_Core</a></li> <li><a href="class-SimplePie_Credit.html">SimplePie_Credit</a></li> <li><a href="class-SimplePie_Decode_HTML_Entities.html" class="deprecated">SimplePie_Decode_HTML_Entities</a></li> <li><a href="class-SimplePie_Enclosure.html">SimplePie_Enclosure</a></li> <li><a href="class-SimplePie_File.html">SimplePie_File</a></li> <li><a href="class-SimplePie_gzdecode.html">SimplePie_gzdecode</a></li> <li><a href="class-SimplePie_HTTP_Parser.html">SimplePie_HTTP_Parser</a></li> <li><a href="class-SimplePie_IRI.html">SimplePie_IRI</a></li> <li><a href="class-SimplePie_Item.html">SimplePie_Item</a></li> <li><a href="class-SimplePie_Locator.html">SimplePie_Locator</a></li> <li><a href="class-SimplePie_Misc.html">SimplePie_Misc</a></li> <li><a href="class-SimplePie_Net_IPv6.html">SimplePie_Net_IPv6</a></li> <li><a href="class-SimplePie_Parse_Date.html">SimplePie_Parse_Date</a></li> <li><a href="class-SimplePie_Parser.html">SimplePie_Parser</a></li> <li><a href="class-SimplePie_Rating.html">SimplePie_Rating</a></li> <li><a href="class-SimplePie_Registry.html">SimplePie_Registry</a></li> <li><a href="class-SimplePie_Restriction.html">SimplePie_Restriction</a></li> <li><a href="class-SimplePie_Sanitize.html">SimplePie_Sanitize</a></li> <li><a href="class-SimplePie_Source.html">SimplePie_Source</a></li> <li><a href="class-SimplePie_XML_Declaration_Parser.html">SimplePie_XML_Declaration_Parser</a></li> </ul> <h3>Interfaces</h3> <ul> <li><a href="class-SimplePie_Cache_Base.html">SimplePie_Cache_Base</a></li> </ul> </div> </div> </div> <div id="right" class="api-content"> <div id="rightInner"> <div id="content"> <h1>SimplePie 1.3 API Documentation</h1> <p>This is the automatically generated API documentation for SimplePie. For human-based documentation, check out the <a href="http://simplepie.org/wiki/">wiki</a>.</p> <table class="summary" id="packages"> <caption>Packages summary</caption> <tr> <td class="name"><a href="package-SimplePie.html">SimplePie</a></td> </tr> <tr> <td class="name"><a href="package-SimplePie.API.html">SimplePie\API</a></td> </tr> <tr> <td class="name"><a href="package-SimplePie.Caching.html">SimplePie\Caching</a></td> </tr> <tr> <td class="name"><a href="package-SimplePie.HTTP.html">SimplePie\HTTP</a></td> </tr> <tr> <td class="name"><a href="package-SimplePie.Parsing.html">SimplePie\Parsing</a></td> </tr> </table> <table class="summary" id="classes"> <caption>Classes summary</caption> <tr> <td class="name"><a href="class-SimplePie.html">SimplePie</a></td> <td>SimplePie </td> </tr> <tr> <td class="name"><a href="class-SimplePie_Author.html">SimplePie_Author</a></td> <td>Manages all author-related data</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Cache.html">SimplePie_Cache</a></td> <td>Used to create cache objects</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Cache_DB.html">SimplePie_Cache_DB</a></td> <td>Base class for database-based caches</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Cache_File.html">SimplePie_Cache_File</a></td> <td>Caches data to the filesystem</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Cache_Memcache.html">SimplePie_Cache_Memcache</a></td> <td>Caches data to memcache</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Cache_MySQL.html">SimplePie_Cache_MySQL</a></td> <td>Caches data to a MySQL database</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Caption.html">SimplePie_Caption</a></td> <td>Handles <code><media:text></code> captions as defined in Media RSS.</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Category.html">SimplePie_Category</a></td> <td>Manages all category-related data</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Content_Type_Sniffer.html">SimplePie_Content_Type_Sniffer</a></td> <td>Content-type sniffing</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Copyright.html">SimplePie_Copyright</a></td> <td>Manages <code><media:copyright></code> copyright tags as defined in Media RSS</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Core.html" class="deprecated">SimplePie_Core</a></td> <td>SimplePie class.</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Credit.html">SimplePie_Credit</a></td> <td>Handles <code><media:credit></code> as defined in Media RSS</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Decode_HTML_Entities.html" class="deprecated">SimplePie_Decode_HTML_Entities</a></td> <td>Decode HTML Entities</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Enclosure.html">SimplePie_Enclosure</a></td> <td>Handles everything related to enclosures (including Media RSS and iTunes RSS)</td> </tr> <tr> <td class="name"><a href="class-SimplePie_File.html">SimplePie_File</a></td> <td>Used for fetching remote files and reading local files</td> </tr> <tr> <td class="name"><a href="class-SimplePie_gzdecode.html">SimplePie_gzdecode</a></td> <td>Decode 'gzip' encoded HTTP data</td> </tr> <tr> <td class="name"><a href="class-SimplePie_HTTP_Parser.html">SimplePie_HTTP_Parser</a></td> <td>HTTP Response Parser</td> </tr> <tr> <td class="name"><a href="class-SimplePie_IRI.html">SimplePie_IRI</a></td> <td>IRI parser/serialiser/normaliser</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Item.html">SimplePie_Item</a></td> <td>Manages all item-related data</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Locator.html">SimplePie_Locator</a></td> <td>Used for feed auto-discovery</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Misc.html">SimplePie_Misc</a></td> <td>Miscellanous utilities</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Net_IPv6.html">SimplePie_Net_IPv6</a></td> <td>Class to validate and to work with IPv6 addresses.</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Parse_Date.html">SimplePie_Parse_Date</a></td> <td>Date Parser</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Parser.html">SimplePie_Parser</a></td> <td>Parses XML into something sane</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Rating.html">SimplePie_Rating</a></td> <td>Handles <code><media:rating></code> or <code><itunes:explicit></code> tags as defined in Media RSS and iTunes RSS respectively</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Registry.html">SimplePie_Registry</a></td> <td>Handles creating objects and calling methods</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Restriction.html">SimplePie_Restriction</a></td> <td>Handles <code><media:restriction></code> as defined in Media RSS</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Sanitize.html">SimplePie_Sanitize</a></td> <td>Used for data cleanup and post-processing</td> </tr> <tr> <td class="name"><a href="class-SimplePie_Source.html">SimplePie_Source</a></td> <td>Handles <code><atom:source></code></td> </tr> <tr> <td class="name"><a href="class-SimplePie_XML_Declaration_Parser.html">SimplePie_XML_Declaration_Parser</a></td> <td>Parses the XML Declaration</td> </tr> </table> <table class="summary" id="interfaces"> <caption>Interfaces summary</caption> <tr> <td class="name"><a href="class-SimplePie_Cache_Base.html">SimplePie_Cache_Base</a></td> <td>Base for cache objects</td> </tr> </table> </div> </div> </div> <div class="clearBoth"></div> <div id="footer"> <p class="highlight" style="background-color:#ffc; border-bottom:1px solid #ccc;"><strong>Show some love!</strong> Wishlists for <a href="http://www.amazon.co.uk/gp/registry/wishlist/2ASV4RHBSM16H/026-9090951-0551667">Geoffrey</a>, <a href="http://www.amazon.com/gp/registry/wishlist/KAFYR57E8R81/">Ryan P.</a>, and <a href="http://www.amazon.com/gp/registry/wishlist/2P9RS76SG0UHL/">Ryan M.</a></p> <p class="footnote">SimplePie is © 2004–2012 <a href="http://ryanparman.com">Ryan Parman</a>, <a href="http://gsnedders.com/">Geoffrey Sneddon</a>, <a href="http://ryanmccue.info/">Ryan McCue</a> and contributors. Licensed under the <a href="http://www.opensource.org/licenses/bsd-license.php">BSD License</a>. Hosted thanks to <a href="http://ma.tt/">Matt Mullenweg</a>, API documentation generated by <a href="http://apigen.org">ApiGen 2.6.1</a>. Variation on the Feed Icon by <a href="http://www.bartelme.at/journal/archive/feed_icon_template">Wolfgang Bartelme</a>.</p> <div class="spacer"></div> </div> </div> </body> </html>