Search

e_Item:get_item_tags]]''. (RC1) * Added the ''[[reference:SimplePie_Category:start]]'' class which adds new methods to ''[[reference:SimplePie_Item:get_category]]'' and ''[[reference:SimplePie_Item:get_categ... the ability to get an item's parent feed via ''[[reference:SimplePie_Item::get_feed]]''. (RC1) * Improved ... sizing. Defaults to 480x270. (RC1) * Added ''[[reference:SimplePie:subscribe_itunes]]'', which allows for

* [[1.3:start|Other Documentation for 1.3]] * [[reference:start|API Documentation for 1.2]] * [[tutorial:start]] * [[ideas:start]] ===== Enhancements ===== * [[plugins:start]] * [[addons:start]]... [misc:Coding Standards]] * [[misc:Release Notes:start]] * [[misc:Credits]] * [[misc:In The Media]] ===== SimplePie Live! Documentation ===== * [[live:start]]

====== 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]]

rue )); } }</code> ===== See Also ===== * [[reference:SimplePie:start]] * [[reference:SimplePie_Item:start]] * [[reference:SimplePie_Enclosure:start]] * [[reference:SimplePie_Enclosure:native_embed]]

require it in your pages, and use the resulting [[reference:start|API functions]], you can probably skip this prime... in your pages, and can find your way around the [[reference:start|function reference]], you should be fine at this

====== set_item_class() ====== ===== Description ===== <code>class SimplePie { set_item_class ( [string $class = 'SimplePie_Item'] ) }</code> Allows you to add new methods or replace existing methods in the [[reference:SimplePie_Item:start]] class. Learn more about extending classes in PHP: * **PHP 4:** http://php.net/manual/en/keyword.extends.php * **PHP 5:** http://php.net/manual/en/language.oop5.basic.php#language.oop5.basic.extends ===== Availability ===== * Available since SimplePie Beta 3. ===== Parameters ===== ==== class ==== The new class for SimplePie to use. ===== Examples ===== ==== Replace a method and add a method ==== <code php><?php require_once('../simplepie.inc'); // Create a new class that extends an existing class class SimplePie_Item_Extras extends SimplePie_Item { /** This is an example of adding a new method to an existing class. */ // Retrieve the <gd:when startTime="" /> value. function get_gcal_starttime($format = false) { // We want to grab the Google-namespaced <gd:when> tag. // http://simplepie.org/wiki/tutorial/grab_custom_tags_or_attributes $when = $this->get_item_tags('http://schemas.google.com/g/2005', 'when'); // Once we grab the tag, let's grab the startTime attribute $date = $when[0]['attribs']['']['startTime']; if ($format) { // Let's pass it through strtotime() and then format it with date(). This will be the date we display. return date($format, strtotime($date)); } else { // Otherwise we'll return it as-is with no modifications. return $date; } } /** This is an example of modifying an existing method of an existing class. */ function get_id() { return $this->__toString(); } } // Let's do our standard SimplePie thing. $feed = new SimplePie(); $feed->set_feed_url('http://www.google.com/calendar/feeds/eventi%40emmealcubo.com/public/full'); $feed->set_item_class('SimplePie_Item_Extras'); $feed->init(); $feed->handle_content_type(); ?> <html> <body> <?php foreach ($feed->get_items(0,5) as $item): ?> <h4><a href="<?php echo $item->get_permalink()?>"><?php echo $item->get_title()?></a></h4> <p><small><?php echo $item->get_date('j F Y, g:i a')?></small></p> <p><?php echo $item->get_description()?></p> <p>Starts on <?php echo $item->get_gcal_starttime('j F Y')?></p> <p>GUID: <?php echo $item->get_id()?></p> <hr /> <?php endforeach; ?> </body> </html></code> ===== See Also ===== * [[reference:SimplePie:start]] * [[reference:SimplePie_Item:start]]

c'); $feed = new SimplePie('http://simplepie.org/wiki/reference/simplepie/get_all_discovered_feeds'); foreach ($... url . "<br />"; } ?></code> ===== See Also ===== * [[reference:SimplePie:start]] * [[reference:SimplePie:subscribe_url]]

emote server. This value is passed directly to [[reference:SimplePie_File:start]]. ===== Availability ===== * Available since ... agent string for SimplePie to use. Defaults to [[reference:SimplePie:SIMPLEPIE_USERAGENT]]. ===== Examples

It also assumes that you know how to use [[addons:start]] (specifically the [[addons:digg]] Add-on). ===... 'll extend the SimplePie class and override the [[reference:SimplePie:sort_items]] method to sort by number o... raries. Digg Add-on found at http://simplepie.org/wiki/addons/digg require_once('simplepie.inc'); requir

====== 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]]

his with the shorter syntax. http://simplepie.org/wiki/reference/simplepie/start $feed = new SimplePie('http://youtube.com/rss/glo