|
Moodle
2.2.1
http://www.collinsharper.com
|

Definition at line 416 of file simplepie.class.php.
| __construct | ( | ) |
The SimplePie class contains feed level data and options
There are two ways that you can create a new SimplePie object. The first is by passing a feed URL as a parameter to the SimplePie constructor (as well as optionally setting the cache location and cache expiry). This will initialise the whole feed with all of the default settings, and you can begin accessing methods and properties immediately.
The second way is to create the SimplePie object with no parameters at all. This will enable you to set configuration options. After setting them, you must initialise the feed using $feed->init(). At that point the object's methods and properties will be available to you. This format is what is used throughout this documentation.
public
Definition at line 745 of file simplepie.class.php.


| __destruct | ( | ) |
Remove items that link back to this before destroying this object
Definition at line 773 of file simplepie.class.php.
| __toString | ( | ) |
Used for converting object to a string
Definition at line 765 of file simplepie.class.php.
| enable_cache | ( | $ | enable = true | ) |
Enables/disables caching in SimplePie.
This option allows you to disable caching all-together in SimplePie. However, disabling the cache can lead to longer load times.
public
| bool | $enable | Enable caching |
Definition at line 914 of file simplepie.class.php.
| enable_order_by_date | ( | $ | enable = true | ) |
Determines whether feed items should be sorted into reverse chronological order.
public
| bool | $enable | Sort as reverse chronological order. |
Definition at line 960 of file simplepie.class.php.

| encode_instead_of_strip | ( | $ | enable = true | ) |
| error | ( | ) |
Return the error message for the occured error
public
Definition at line 1786 of file simplepie.class.php.

| force_feed | ( | $ | enable = false | ) |
Force the given data/URL to be treated as a feed no matter what it appears like
public
| bool | $enable | Force the given data/URL to be treated as a feed |
Definition at line 804 of file simplepie.class.php.

| force_fsockopen | ( | $ | enable = false | ) |
Forces SimplePie to use fsockopen() instead of the preferred cURL functions.
public
| bool | $enable | Force fsockopen() to be used |
Definition at line 899 of file simplepie.class.php.

Definition at line 2399 of file simplepie.class.php.
| get_author | ( | $ | key = 0 | ) |
| get_authors | ( | ) |
Definition at line 2163 of file simplepie.class.php.


Definition at line 2023 of file simplepie.class.php.


| get_categories | ( | ) |
Definition at line 2093 of file simplepie.class.php.


| get_category | ( | $ | key = 0 | ) |
| get_channel_tags | ( | $ | namespace, |
| $ | tag | ||
| ) |
Definition at line 1944 of file simplepie.class.php.


| get_contributor | ( | $ | key = 0 | ) |
| get_contributors | ( | ) |
Definition at line 2246 of file simplepie.class.php.


| get_copyright | ( | ) |
| get_description | ( | ) |
| get_encoding | ( | ) |
Definition at line 1791 of file simplepie.class.php.


| get_feed_tags | ( | $ | namespace, |
| $ | tag | ||
| ) |
Definition at line 1910 of file simplepie.class.php.


| get_image_height | ( | ) |
| get_image_link | ( | ) |
| get_image_tags | ( | $ | namespace, |
| $ | tag | ||
| ) |
Definition at line 1987 of file simplepie.class.php.


| get_image_title | ( | ) |
| get_image_url | ( | ) |
| get_image_width | ( | ) |
| get_item | ( | $ | key = 0 | ) |
| get_item_quantity | ( | $ | max = 0 | ) |
| get_items | ( | $ | start = 0, |
| $ | end = 0 |
||
| ) |
Definition at line 2688 of file simplepie.class.php.


| get_language | ( | ) |
| get_latitude | ( | ) |
| get_link | ( | $ | key = 0, |
| $ | rel = 'alternate' |
||
| ) |
Definition at line 2304 of file simplepie.class.php.


| get_links | ( | $ | rel = 'alternate' | ) |
Definition at line 2325 of file simplepie.class.php.


| get_longitude | ( | ) |
| get_permalink | ( | ) |
Added for parity between the parent-level and the item/entry-level.
Definition at line 2320 of file simplepie.class.php.

| get_title | ( | ) |
| get_type | ( | ) |
| handle_content_type | ( | $ | mime = 'text/html' | ) |
| init | ( | ) |
Definition at line 1449 of file simplepie.class.php.


| merge_items | ( | $ | urls, |
| $ | start = 0, |
||
| $ | end = 0, |
||
| $ | limit = 0 |
||
| ) | [static] |
| remove_div | ( | $ | enable = true | ) |
Definition at line 1364 of file simplepie.class.php.


| sanitize | ( | $ | data, |
| $ | type, | ||
| $ | base = '' |
||
| ) |
| set_author_class | ( | $ | class = 'SimplePie_Author' | ) |
Allows you to change which class SimplePie uses for handling author data. Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1118 of file simplepie.class.php.

| set_autodiscovery_cache_duration | ( | $ | seconds = 604800 | ) |
Set the length of time (in seconds) that the autodiscovered feed URL will be cached.
public
| int | $seconds | The autodiscovered feed URL cache duration. |
Definition at line 938 of file simplepie.class.php.
| set_autodiscovery_level | ( | $ | level = SIMPLEPIE_LOCATOR_ALL | ) |
Set how much feed autodiscovery to do
public
| int | $level | Feed Autodiscovery Level (level can be a combination of the above constants, see bitwise OR operator) |
Definition at line 997 of file simplepie.class.php.
| set_cache_class | ( | $ | class = 'SimplePie_Cache' | ) |
Allows you to change which class SimplePie uses for caching. Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1010 of file simplepie.class.php.

| set_cache_duration | ( | $ | seconds = 3600 | ) |
Set the length of time (in seconds) that the contents of a feed will be cached.
public
| int | $seconds | The feed content cache duration. |
Definition at line 926 of file simplepie.class.php.

| set_cache_location | ( | $ | location = './cache' | ) |
Set the file system location where the cached files should be stored.
public
| string | $location | The file system location. |
Definition at line 949 of file simplepie.class.php.

| set_cache_name_function | ( | $ | function = 'md5' | ) |
Set callback function to create cache filename with
public
| mixed | $function | Callback function |
Definition at line 1307 of file simplepie.class.php.
| set_caption_class | ( | $ | class = 'SimplePie_Caption' | ) |
Allows you to change which class SimplePie uses for <media:text> captions Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1172 of file simplepie.class.php.

| set_category_class | ( | $ | class = 'SimplePie_Category' | ) |
Allows you to change which class SimplePie uses for handling category data. Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1136 of file simplepie.class.php.

| set_content_type_sniffer_class | ( | $ | class = 'SimplePie_Content_Type_Sniffer' | ) |
Allows you to change which class SimplePie uses for content-type sniffing. Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1262 of file simplepie.class.php.

| set_copyright_class | ( | $ | class = 'SimplePie_Copyright' | ) |
Allows you to change which class SimplePie uses for <media:copyright> Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1190 of file simplepie.class.php.

| set_credit_class | ( | $ | class = 'SimplePie_Credit' | ) |
Allows you to change which class SimplePie uses for <media:credit> Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1208 of file simplepie.class.php.

| set_enclosure_class | ( | $ | class = 'SimplePie_Enclosure' | ) |
Allows you to change which class SimplePie uses for feed enclosures. Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1154 of file simplepie.class.php.

| set_feed_url | ( | $ | url | ) |
This is the URL of the feed you want to parse.
This allows you to enter the URL of the feed you want to parse, or the website you want to try to use auto-discovery on. This takes priority over any set raw data.
You can set multiple feeds to mash together by passing an array instead of a string for the $url. Remember that with each additional feed comes additional processing and resources.
public
| mixed | $url | This is the URL (or array of URLs) that you want to parse. |
Definition at line 825 of file simplepie.class.php.


| set_file | ( | &$ | file | ) |
Provides an instance of SimplePie_File to use as a feed
public
| object | &$file | Instance of SimplePie_File (or subclass) |
Definition at line 848 of file simplepie.class.php.
| set_file_class | ( | $ | class = 'SimplePie_File' | ) |
Allows you to change which class SimplePie uses for remote file fetching. Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1064 of file simplepie.class.php.

| set_image_handler | ( | $ | page = false, |
| $ | qs = 'i' |
||
| ) |
Set the handler to enable the display of cached images.
public
| str | $page | Web-accessible path to the handler_image.php file. |
| str | $qs | The query string that the value should be passed to. |
Definition at line 1426 of file simplepie.class.php.


| set_input_encoding | ( | $ | encoding = false | ) |
Allows you to override the character encoding reported by the feed.
public
| string | $encoding | Character encoding. |
Definition at line 971 of file simplepie.class.php.
| set_item_class | ( | $ | class = 'SimplePie_Item' | ) |
Allows you to change which class SimplePie uses for handling feed items. Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1100 of file simplepie.class.php.

| set_item_limit | ( | $ | limit = 0 | ) |
Set the limit for items returned per-feed with multifeeds.
public
| integer | $limit | The maximum number of items to return. |
Definition at line 1444 of file simplepie.class.php.
| set_javascript | ( | $ | get = 'js' | ) |
Set javascript query string parameter
public
| mixed | $get | Javascript query string parameter |
Definition at line 1321 of file simplepie.class.php.
| set_locator_class | ( | $ | class = 'SimplePie_Locator' | ) |
Allows you to change which class SimplePie uses for auto-discovery. Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1028 of file simplepie.class.php.

| set_max_checked_feeds | ( | $ | max = 10 | ) |
Set maximum number of feeds to check with autodiscovery
public
| int | $max | Maximum number of feeds to check |
Definition at line 1359 of file simplepie.class.php.
| set_output_encoding | ( | $ | encoding = 'UTF-8' | ) |
Definition at line 1396 of file simplepie.class.php.


| set_parser_class | ( | $ | class = 'SimplePie_Parser' | ) |
Allows you to change which class SimplePie uses for XML parsing. Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1046 of file simplepie.class.php.

| set_rating_class | ( | $ | class = 'SimplePie_Rating' | ) |
Allows you to change which class SimplePie uses for <media:rating> Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1226 of file simplepie.class.php.

| set_raw_data | ( | $ | data | ) |
Allows you to use a string of RSS/Atom data instead of a remote feed.
If you have a feed available as a string in PHP, you can tell SimplePie to parse that data string instead of a remote feed. Any set feed URL takes precedence.
public
| string | $data | RSS or Atom data as a string. |
Definition at line 871 of file simplepie.class.php.
| set_restriction_class | ( | $ | class = 'SimplePie_Restriction' | ) |
Allows you to change which class SimplePie uses for <media:restriction> Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1244 of file simplepie.class.php.

| set_sanitize_class | ( | $ | class = 'SimplePie_Sanitize' | ) |
Allows you to change which class SimplePie uses for data sanitization. Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1082 of file simplepie.class.php.

| set_source_class | ( | $ | class = 'SimplePie_Source' | ) |
Allows you to change which class SimplePie uses item sources. Useful when you are overloading or extending SimplePie's default classes.
public
| string | $class | Name of custom class. PHP5 extends documentation |
Definition at line 1280 of file simplepie.class.php.

| set_stupidly_fast | ( | $ | set = false | ) |
Set options to make SP as fast as possible. Forgoes a substantial amount of data sanitization in favor of speed.
public
| bool | $set | Whether to set them or not |
Definition at line 1340 of file simplepie.class.php.

| set_timeout | ( | $ | timeout = 10 | ) |
Allows you to override the default timeout for fetching remote feeds.
This allows you to change the maximum time the feed's server to respond and send the feed back.
public
| int | $timeout | The maximum number of seconds to spend waiting to retrieve a feed. |
Definition at line 886 of file simplepie.class.php.

| set_url_replacements | ( | $ | element_attribute = array('a' => 'href', 'area' => 'href', 'blockquote' => 'cite', 'del' => 'cite', 'form' => 'action', 'img' => array('longdesc', 'src'), 'input' => 'src', 'ins' => 'cite', 'q' => 'cite') | ) |
Set element/attribute key/value pairs of HTML attributes containing URLs that need to be resolved relative to the feed
public
| array | $element_attribute | Element/attribute key/value pairs |
Definition at line 1414 of file simplepie.class.php.

| set_useragent | ( | $ | ua = SIMPLEPIE_USERAGENT | ) |
Allows you to override the default user agent string.
public
| string | $ua | New user agent string. |
Definition at line 1296 of file simplepie.class.php.
| sort_items | ( | $ | a, |
| $ | b | ||
| ) | [static] |
Definition at line 2791 of file simplepie.class.php.
| array Stores the default attributes to be stripped by strip_attributes | ( | $ | attribs = '' | ) |
Definition at line 1387 of file simplepie.class.php.


| strip_comments | ( | $ | strip = false | ) |
Definition at line 1401 of file simplepie.class.php.


| array Stores the default tags to be stripped by strip_htmltags | ( | $ | tags = '', |
| $ | encode = null |
||
| ) |
Definition at line 1369 of file simplepie.class.php.


| subscribe_url | ( | ) |
If we have a perm redirect we should return the new URL
When we make the above change, let's support <itunes:new-feed-url> as well
Also, |atom:link|=self
Definition at line 1898 of file simplepie.class.php.


| $all_discovered_feeds = array() |
Definition at line 677 of file simplepie.class.php.
| $author_class = 'SimplePie_Author' |
Definition at line 592 of file simplepie.class.php.
| $autodiscovery = SIMPLEPIE_LOCATOR_ALL |
Definition at line 550 of file simplepie.class.php.
| $autodiscovery_cache_duration = 604800 |
Definition at line 514 of file simplepie.class.php.
| $cache = true |
Definition at line 500 of file simplepie.class.php.
| $cache_class = 'SimplePie_Cache' |
Definition at line 557 of file simplepie.class.php.
| $cache_duration = 3600 |
Definition at line 507 of file simplepie.class.php.
| $cache_location = './cache' |
Definition at line 521 of file simplepie.class.php.
| $cache_name_function = 'md5' |
Definition at line 528 of file simplepie.class.php.
| $caption_class = 'SimplePie_Caption' |
Definition at line 613 of file simplepie.class.php.
| $category_class = 'SimplePie_Category' |
Definition at line 599 of file simplepie.class.php.
| $config_settings = null |
Definition at line 704 of file simplepie.class.php.
| $content_type_sniffer_class = 'SimplePie_Content_Type_Sniffer' |
Definition at line 648 of file simplepie.class.php.
| $copyright_class = 'SimplePie_Copyright' |
Definition at line 620 of file simplepie.class.php.
| $credit_class = 'SimplePie_Credit' |
Definition at line 627 of file simplepie.class.php.
Definition at line 422 of file simplepie.class.php.
| $enclosure_class = 'SimplePie_Enclosure' |
Definition at line 606 of file simplepie.class.php.
Definition at line 428 of file simplepie.class.php.
| $feed_url |
Definition at line 449 of file simplepie.class.php.
| $file |
Definition at line 456 of file simplepie.class.php.
| $file_class = 'SimplePie_File' |
Definition at line 578 of file simplepie.class.php.
| $force_feed = false |
Definition at line 486 of file simplepie.class.php.
| $force_fsockopen = false |
Definition at line 478 of file simplepie.class.php.
| $image_handler = '' |
Definition at line 684 of file simplepie.class.php.
| $input_encoding = false |
Definition at line 543 of file simplepie.class.php.
| $item_class = 'SimplePie_Item' |
Definition at line 585 of file simplepie.class.php.
| $item_limit = 0 |
Definition at line 711 of file simplepie.class.php.
| $javascript = 'js' |
Definition at line 663 of file simplepie.class.php.
| $locator_class = 'SimplePie_Locator' |
Definition at line 564 of file simplepie.class.php.
| $max_checked_feeds = 10 |
Definition at line 670 of file simplepie.class.php.
| $multifeed_objects = array() |
Definition at line 697 of file simplepie.class.php.
| $multifeed_url = array() |
Definition at line 691 of file simplepie.class.php.
| $order_by_date = true |
Definition at line 535 of file simplepie.class.php.
| $parser_class = 'SimplePie_Parser' |
Definition at line 571 of file simplepie.class.php.
| $rating_class = 'SimplePie_Rating' |
Definition at line 634 of file simplepie.class.php.
| $raw_data |
Definition at line 463 of file simplepie.class.php.
| $restriction_class = 'SimplePie_Restriction' |
Definition at line 641 of file simplepie.class.php.
Definition at line 435 of file simplepie.class.php.
| $source_class = 'SimplePie_Source' |
Definition at line 655 of file simplepie.class.php.
| $strip_attributes = array('bgsound', 'class', 'expr', 'id', 'style', 'onclick', 'onerror', 'onfinish', 'onmouseover', 'onmouseout', 'onfocus', 'onblur', 'lowsrc', 'dynsrc') |
Definition at line 718 of file simplepie.class.php.
| $strip_htmltags = array('base', 'blink', 'body', 'doctype', 'embed', 'font', 'form', 'frame', 'frameset', 'html', 'iframe', 'input', 'marquee', 'meta', 'noscript', 'object', 'param', 'script', 'style') |
Definition at line 725 of file simplepie.class.php.
| $timeout = 10 |
Definition at line 470 of file simplepie.class.php.
| $useragent = SIMPLEPIE_USERAGENT |
Definition at line 442 of file simplepie.class.php.
| $xml_dump = false |
Definition at line 493 of file simplepie.class.php.