SimplePie 1.5 is now available!

SimplePie Documentation.  Learn how to use this thing.  It's way better than going to school.

You are here: Documentation

Search

You can find the results of your search below. If you didn't find what you were looking for, you can create or edit the page named after your query with the appropriate button.

Results


Matching pagenames:

 
Formatting Syntax: 24 Hits
ditional [[pagename|link text]]. [[doku>pagename|Wiki pagenames]] are converted to lowercase automatica... s is a link to Wikipedia's page about Wikis: [[wp>Wiki]]. DokuWiki supports [[doku>Interwiki]] links.... s is a link to Wikipedia's page about Wikis: [[wp>Wiki]]. ==== Windows Shares ==== Windows shares lik... (see below) like this: [[http://www.php.net|{{wiki:dokuwiki-128.png}}]] [[http://www.php.net|{{wiki
Documentation: 13 Hits
p you along. We decided to move everything into a wiki so that people can add their own notes, clarifica... ials and such, but please follow existing uses of wiki links and the [[http://simplepie.org/api/|API doc... ==== Frequently Asked Questions ===== * **[[faq:start]]** * [[faq:Typical Multifeed Gotchas]] * [[f... server-writable?]] ===== Setup ===== * [[setup:start]] * [[setup:sample_page]] * [[setup:upgrade]]
SimplePie Plugin for Mediawiki: 10 Hits
lternatively, there are other [[plugins:mediawiki:start]] plugins that you can use instead of this one. ... ediawiki that allows you to display feeds in your wiki. ===== Installation ===== ==== Upgrading from an... ume that you have installed MediaWiki to ''http://wiki.example.com'', which would mean that the MediaWiki extensions folder lives at ''http://wiki.example.com/extensions/'', and that your MediaWiki settin
SimplePie Plugins and Integration: 7 Hits
tays well-organized. :!: Also check out [[addons:start|SimplePie Add-ons]] for enhancements to the core ... ver software as of the [[http://www.bitweaver.org/wiki/RSSPackage|BitWeaver R2 release]]. Uses the Simpl... ilt into the DokuWiki software as of the [[http://wiki.splitbrain.org/wiki:rss|DokuWiki 2006-11-06 relea... e [[http://dev.joomla.org/component/option,com_jd-wiki/Itemid,/id,references:3pd-libraries/|Joomla! 1.5
Setup and Getting Started: 6 Hits
re other instructions available for the [[plugins:start]]. ===== How the Instructions Work ===== SimpleP... in your pages, and use the resulting [[reference:start|API functions]], you can probably skip this prime... ===== The Instructions ===== ==== Step 1 ==== **//Start by launching your FTP program, and accessing the ... w. Many webhosts also have a knowledge base or a wiki of some sort that you can consult if you're not s
native_embed(): 5 Hits
====== native_embed() ====== ===== Description ===== <code>class SimplePie_Enclosure { native_embed ( [(array) $options] ) }</code> Embeds the enclosure into the webpage using the HTML ''<embed>'' tag. This will use ''[[reference:SimplePie_Enclosure:get_real_type]]'' to determine which handler should be used to embed the content into the page. SimplePie supports QuickTime, Windows Media, Flash, Flash Media, and the Odeo Player for Odeo feeds. Because of the fallout from the [[http://en.wikipedia.org/wiki/Eolas|Eolas lawsuit against Microsoft]] and the [[http://blogs.msdn.com/ie/archive/2006/04/11/573479.aspx|changes that were recently made to Internet Explorer]] as a result, we generate and include a [[http://msdn.microsoft.com/library/default.asp?url=/workshop/author/dhtml/overview/activating_activex.asp|JavaScript library containing functions]] that allow us to embed the multimedia content. This function is identical to ''[[reference:SimplePie_Enclosure:embed]]'' except that, whereas ''[[reference:SimplePie_Enclosure:embed]]'' uses JavaScript to dynamically create the ''<embed>'' object, this function writes the ''<embed>'' tag directly to your pages, so that JavaScript is not required. It also works better for free webhosts that insert advertisements into everything. On the flip-side, //pages using this function WILL NOT [[http://validator.w3.org|VALIDATE]] as HTML or XHTML, because the ''<embed>'' tag is invalid.// ===== Availability ===== * Available since SimplePie Beta 3. ===== Parameters ===== ==== options ==== ''options'' is an array of multiple options that can all be passed into the [[reference:SimplePie_Enclosure:embed]] method. They are as follows: * ''alt'' (string)\\ Alternate content for when an end-user does not have the appropriate handler installed or when a file type is unsupported. Can be any text or HTML. Defaults to blank. * ''altclass'' (string)\\ If a file type is unsupported, the end-user will see the alt text (above) linked directly to the content. That link will have this value as its class name. Defaults to blank. * ''audio'' (string)\\ This is an image that should be used as a placeholder for audio files before they're loaded (QuickTime-only). Can be any relative or absolute URL. Defaults to blank. * ''bgcolor'' (string)\\ The background color for the media, if not already transparent. Defaults to ''#ffffff''. * ''height'' (integer)\\ The height of the embedded media. Accepts any numeric pixel value (such as ''360'') or ''auto''. Defaults to ''auto'', and it is recommended that you use this default. * ''loop'' (boolean)\\ Do you want the media to loop when its done? Defaults to ''false''. * ''mediaplayer'' (string)\\ The location of the included ''mediaplayer.swf'' file. This allows for the playback of Flash Video (''.flv'') files, and is the default handler for non-Odeo MP3's. Defaults to blank. * ''video'' (string)\\ This is an image that should be used as a placeholder for video files before they're loaded (QuickTime-only). Can be any relative or absolute URL. Defaults to blank. * ''width'' (integer)\\ The width of the embedded media. Accepts any numeric pixel value (such as ''480'') or ''auto''. Defaults to ''auto'', and it is recommended that you use this default. * ''widescreen'' (boolean)\\ Is the enclosure widescreen or standard? This applies only to video enclosures, and will automatically resize the content appropriately. Defaults to ''false'', implying 4:3 mode. **NOTE:** Non-widescreen (4:3) mode with ''width'' and ''height'' set to ''auto'' will default to 480x360 video resolution. Widescreen (16:9) mode with ''width'' and ''height'' set to ''auto'' will default to 480x270 video resolution. ===== Examples ===== <code php>$feed = new SimplePie(); $feed->set_feed_url('http://youtube.com/rss/global/top_favorites.rss'); $feed->init(); $feed->handle_content_type(); foreach ($feed->get_items() as $item) { if ($enclosure = $item->get_enclosure()) { echo $enclosure->native_embed(array( 'alt' => 'Download this enclosure!', 'audio' => './for_the_demo/place_audio.png', 'video' => './for_the_demo/place_video.png', 'mediaplayer' => './for_the_demo/mediaplayer.swf', 'widescreen' => true )); } }</code> ===== See Also ===== * [[reference:SimplePie:start]] * [[reference:SimplePie_Item:start]] * [[reference:SimplePie_Enclosure:start]] * [[reference:SimplePie_Enclosure:embed]]
embed(): 5 Hits
of the fallout from the [[http://en.wikipedia.org/wiki/Eolas|Eolas lawsuit against Microsoft]] and the [... > ===== See Also ===== * [[reference:SimplePie:start]] * [[reference:SimplePie_Item:start]] * [[reference:SimplePie_Enclosure:start]] * [[reference:SimplePie_Enclosure:native_embed]]
set_item_class(): 5 Hits
xisting methods in the [[reference:SimplePie_Item:start]] class. Learn more about extending classes in P... mespaced <gd:when> tag. // http://simplepie.org/wiki/tutorial/grab_custom_tags_or_attributes $when =... ml></code> ===== See Also ===== * [[reference:SimplePie:start]] * [[reference:SimplePie_Item:start]]
Getting Started: 4 Hits
[plugins:wordpress:simplepie_plugin_for_wordpress:start|Overview]] | [[plugins:wordpress:simplepie_plugin... troubleshooting]] | ===== The Basics ===== Let's start with something basic: <code php> <?php echo Simpl... gs to your sidebar is documented in the WordPress wiki in an article called [[http://codex.wordpress.org... [plugins:wordpress:simplepie_plugin_for_wordpress:start#what_do_i_need_to_know|"What do I need to know"]]
Goals for SimplePie 2: 3 Hits
written. Please mark your contributions with "~~ wiki-username" so that we know who to ask if we need c... us RSS/Atom data types, [[http://microformats.org/wiki/hatom|hAtom]], and should include all supported d... cts and methods/properties. SimplePie is a toolkit for PHP developers. It needs to start acting like one.
Sorting by custom criteria instead of date: 3 Hits
It also assumes that you know how to use [[addons:start]] (specifically the [[addons:digg]] Add-on). ===... raries. Digg Add-on found at http://simplepie.org/wiki/addons/digg require_once('simplepie.inc'); requir
get_all_discovered_feeds(): 3 Hits
c'); $feed = new SimplePie('http://simplepie.org/wiki/reference/simplepie/get_all_discovered_feeds'); ... </code> ===== See Also ===== * [[reference:SimplePie:start]] * [[reference:SimplePie:subscribe_url]]
sanitize(): 3 Hits
====== sanitize() ====== ===== Description ===== <code>class SimplePie { sanitize ( mixed $data, integer $type, [ string $base = '' ] ) }</code> Sanitizes the incoming data to ensure that it matches the type of data expected. Also absolutizes relative URLs, and a few other things to ensure the data is of the best quality. ===== Availability ===== * Available since SimplePie 1.0. ===== Parameters ===== ==== data ==== The data that needs to be sanitized. ==== type ==== The type of data that it's supposed to be. * ''SIMPLEPIE_CONSTRUCT_NONE''\\ No construct (:?: This could use a better description) * ''SIMPLEPIE_CONSTRUCT_TEXT''\\ Plain text content * ''SIMPLEPIE_CONSTRUCT_HTML''\\ HTML content * ''SIMPLEPIE_CONSTRUCT_XHTML''\\ XHTML content * ''SIMPLEPIE_CONSTRUCT_BASE64''\\ Base64 content * ''SIMPLEPIE_CONSTRUCT_IRI''\\ IRI content (e.g. URLs, URIs, etc.) * ''SIMPLEPIE_CONSTRUCT_MAYBE_HTML''\\ Might be HTML, so let's treat it as such. * ''SIMPLEPIE_CONSTRUCT_ALL''\\ All types of content ==== base ==== The ''xml:base'' value to use when converting relative URLs to absolute ones. ===== Examples ===== ==== Sanitize the data as a URL ==== <code php>$data = $feed->sanitize('http://simplepie.org/wiki/', SIMPLEPIE_CONSTRUCT_IRI);</code> ===== See Also ===== * [[reference:SimplePie:start]]
SimplePie 1.0 "Razzleberry": 3 Hits
1) * Added the ''[[reference:SimplePie_Category:start]]'' class which adds new methods to ''[[reference... d the efficiency of the [[http://en.wikipedia.org/wiki/Internationalized_domain_name|IDN]] code. (RC1)