[ Index ]

PHP Cross Reference of phpwcms V1.4.3 _r380 (23.11.09)

title

Body

[close]

/include/inc_ext/SimplePie/ -> simplepie.inc.php (summary)

SimplePie A PHP-Based RSS and Atom Feed Framework. Takes the hard work out of managing a complete RSS/Atom solution.

Author: Ryan Parman
Author: Geoffrey Sneddon
Copyright: 2004-2009 Ryan Parman, Geoffrey Sneddon
License: http://www.opensource.org/licenses/bsd-license.php BSD License
Version: 1.2
File Size: 15001 lines (388 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 28 classes

SimplePie:: (106 methods):
  SimplePie()
  __toString()
  __destruct()
  force_feed()
  set_feed_url()
  set_file()
  set_raw_data()
  set_timeout()
  force_fsockopen()
  enable_xml_dump()
  enable_cache()
  set_cache_duration()
  set_autodiscovery_cache_duration()
  set_cache_location()
  enable_order_by_date()
  set_input_encoding()
  set_autodiscovery_level()
  set_cache_class()
  set_locator_class()
  set_parser_class()
  set_file_class()
  set_sanitize_class()
  set_item_class()
  set_author_class()
  set_category_class()
  set_enclosure_class()
  set_caption_class()
  set_copyright_class()
  set_credit_class()
  set_rating_class()
  set_restriction_class()
  set_content_type_sniffer_class()
  set_source_class()
  set_useragent()
  set_cache_name_function()
  set_javascript()
  set_stupidly_fast()
  set_max_checked_feeds()
  remove_div()
  strip_htmltags()
  encode_instead_of_strip()
  strip_attributes()
  set_output_encoding()
  strip_comments()
  set_url_replacements()
  set_favicon_handler()
  set_image_handler()
  set_item_limit()
  init()
  error()
  get_encoding()
  handle_content_type()
  get_type()
  get_favicon()
  subscribe_url()
  subscribe_feed()
  subscribe_outlook()
  subscribe_podcast()
  subscribe_itunes()
  subscribe_service()
  subscribe_aol()
  subscribe_bloglines()
  subscribe_eskobo()
  subscribe_feedfeeds()
  subscribe_feedster()
  subscribe_google()
  subscribe_gritwire()
  subscribe_msn()
  subscribe_netvibes()
  subscribe_newsburst()
  subscribe_newsgator()
  subscribe_odeo()
  subscribe_podnova()
  subscribe_rojo()
  subscribe_yahoo()
  get_feed_tags()
  get_channel_tags()
  get_image_tags()
  get_base()
  sanitize()
  get_title()
  get_category()
  get_categories()
  get_author()
  get_authors()
  get_contributor()
  get_contributors()
  get_link()
  get_permalink()
  get_links()
  get_all_discovered_feeds()
  get_description()
  get_copyright()
  get_language()
  get_latitude()
  get_longitude()
  get_image_title()
  get_image_url()
  get_image_link()
  get_image_width()
  get_image_height()
  get_item_quantity()
  get_item()
  get_items()
  sort_items()
  merge_items()

SimplePie_Item:: (43 methods):
  SimplePie_Item()
  __toString()
  __destruct()
  get_item_tags()
  get_base()
  sanitize()
  get_feed()
  get_id()
  get_title()
  get_description()
  get_content()
  get_category()
  get_categories()
  get_author()
  get_contributor()
  get_contributors()
  get_authors()
  get_copyright()
  get_date()
  get_local_date()
  get_permalink()
  get_link()
  get_links()
  get_enclosure()
  get_enclosures()
  get_latitude()
  get_longitude()
  get_source()
  add_to_service()
  add_to_blinklist()
  add_to_blogmarks()
  add_to_delicious()
  add_to_digg()
  add_to_furl()
  add_to_magnolia()
  add_to_myweb20()
  add_to_newsvine()
  add_to_reddit()
  add_to_segnalo()
  add_to_simpy()
  add_to_spurl()
  add_to_wists()
  search_technorati()

SimplePie_Source:: (22 methods):
  SimplePie_Source()
  __toString()
  get_source_tags()
  get_base()
  sanitize()
  get_item()
  get_title()
  get_category()
  get_categories()
  get_author()
  get_authors()
  get_contributor()
  get_contributors()
  get_link()
  get_permalink()
  get_links()
  get_description()
  get_copyright()
  get_language()
  get_latitude()
  get_longitude()
  get_image_url()

SimplePie_Author:: (5 methods):
  SimplePie_Author()
  __toString()
  get_name()
  get_link()
  get_email()

SimplePie_Category:: (5 methods):
  SimplePie_Category()
  __toString()
  get_term()
  get_scheme()
  get_label()

SimplePie_Enclosure:: (41 methods):
  SimplePie_Enclosure()
  __toString()
  get_bitrate()
  get_caption()
  get_captions()
  get_category()
  get_categories()
  get_channels()
  get_copyright()
  get_credit()
  get_credits()
  get_description()
  get_duration()
  get_expression()
  get_extension()
  get_framerate()
  get_handler()
  get_hash()
  get_hashes()
  get_height()
  get_language()
  get_keyword()
  get_keywords()
  get_length()
  get_link()
  get_medium()
  get_player()
  get_rating()
  get_ratings()
  get_restriction()
  get_restrictions()
  get_sampling_rate()
  get_size()
  get_thumbnail()
  get_thumbnails()
  get_title()
  get_type()
  get_width()
  native_embed()
  embed()
  get_real_type()

SimplePie_Caption:: (7 methods):
  SimplePie_Caption()
  __toString()
  get_endtime()
  get_language()
  get_starttime()
  get_text()
  get_type()

SimplePie_Credit:: (5 methods):
  SimplePie_Credit()
  __toString()
  get_role()
  get_scheme()
  get_name()

SimplePie_Copyright:: (4 methods):
  SimplePie_Copyright()
  __toString()
  get_url()
  get_attribution()

SimplePie_Rating:: (4 methods):
  SimplePie_Rating()
  __toString()
  get_scheme()
  get_value()

SimplePie_Restriction:: (5 methods):
  SimplePie_Restriction()
  __toString()
  get_relationship()
  get_type()
  get_value()

SimplePie_File:: (1 method):
  SimplePie_File()

SimplePie_HTTP_Parser:: (16 methods):
  SimplePie_HTTP_Parser()
  parse()
  has_data()
  is_linear_whitespace()
  http_version()
  status()
  reason()
  new_line()
  name()
  linear_whitespace()
  value()
  value_char()
  quote()
  quote_char()
  quote_escaped()
  body()

SimplePie_gzdecode:: (3 methods):
  __set()
  SimplePie_gzdecode()
  parse()

SimplePie_Cache:: (2 methods):
  SimplePie_Cache()
  create()

SimplePie_Cache_File:: (6 methods):
  SimplePie_Cache_File()
  save()
  load()
  mtime()
  touch()
  unlink()

SimplePie_Cache_DB:: (1 method):
  prepare_simplepie_object_for_cache()

SimplePie_Cache_MySQL:: (6 methods):
  SimplePie_Cache_MySQL()
  save()
  load()
  mtime()
  touch()
  unlink()

SimplePie_Misc:: (40 methods):
  time_hms()
  absolutize_url()
  remove_dot_segments()
  get_element()
  element_implode()
  error()
  display_cached_file()
  fix_protocol()
  parse_url()
  compress_parse_url()
  normalize_url()
  percent_encoding_normalization()
  utf8_bad_replace()
  windows_1252_to_utf8()
  change_encoding()
  encoding()
  get_curl_version()
  is_subclass_of()
  strip_comments()
  parse_date()
  entities_decode()
  uncomment_rfc822()
  parse_mime()
  htmlspecialchars_decode()
  atom_03_construct_type()
  atom_10_construct_type()
  atom_10_content_construct_type()
  is_isegment_nz_nc()
  space_seperated_tokens()
  array_unique()
  codepoint_to_utf8()
  stripos()
  parse_str()
  xml_encoding()
  output_javascript()
  embed_odeo()
  embed_quicktime()
  embed_flash()
  embed_flv()
  embed_wmedia()

SimplePie_Decode_HTML_Entities:: (6 methods):
  SimplePie_Decode_HTML_Entities()
  parse()
  consume()
  consume_range()
  unconsume()
  entity()

SimplePie_IRI:: (24 methods):
  __toString()
  SimplePie_IRI()
  absolutize()
  parse_iri()
  remove_dot_segments()
  replace_invalid_with_pct_encoding()
  is_valid()
  set_scheme()
  set_authority()
  set_userinfo()
  set_host()
  set_port()
  set_path()
  set_query()
  set_fragment()
  get_iri()
  get_scheme()
  get_authority()
  get_userinfo()
  get_host()
  get_port()
  get_path()
  get_query()
  get_fragment()

SimplePie_Net_IPv6:: (4 methods):
  removeNetmaskSpec()
  Uncompress()
  SplitV64()
  checkIPv6()

SimplePie_Parse_Date:: (10 methods):
  SimplePie_Parse_Date()
  get()
  parse()
  add_callback()
  date_w3cdtf()
  remove_rfc2822_comments()
  date_rfc2822()
  date_rfc850()
  date_asctime()
  date_strtotime()

SimplePie_Content_Type_Sniffer:: (6 methods):
  SimplePie_Content_Type_Sniffer()
  get_type()
  text_or_binary()
  unknown()
  image()
  feed_or_html()

SimplePie_XML_Declaration_Parser:: (15 methods):
  SimplePie_XML_Declaration_Parser()
  parse()
  has_data()
  skip_whitespace()
  get_value()
  before_version_name()
  version_name()
  version_equals()
  version_value()
  encoding_name()
  encoding_equals()
  encoding_value()
  standalone_name()
  standalone_equals()
  standalone_value()

SimplePie_Locator:: (8 methods):
  SimplePie_Locator()
  find()
  is_feed()
  get_base()
  autodiscovery()
  get_links()
  extension()
  body()

SimplePie_Parser:: (11 methods):
  parse()
  get_error_code()
  get_error_string()
  get_current_line()
  get_current_column()
  get_current_byte()
  get_data()
  tag_open()
  cdata()
  tag_close()
  split_ns()

SimplePie_Sanitize:: (13 methods):
  remove_div()
  set_image_handler()
  pass_cache_data()
  pass_file_data()
  strip_htmltags()
  encode_instead_of_strip()
  strip_attributes()
  strip_comments()
  set_output_encoding()
  set_url_replacements()
  sanitize()
  replace_urls()
  do_strip_htmltags()


Class: SimplePie  - X-Ref

SimplePie

SimplePie($feed_url = null, $cache_location = null, $cache_duration = null)   X-Ref
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.

param: string $feed_url This is the URL you want to parse.
param: string $cache_location This is where you want the cache to be stored.
param: int $cache_duration This is the number of seconds that you want to store the cache file for.

__toString()   X-Ref
Used for converting object to a string


__destruct()   X-Ref
Remove items that link back to this before destroying this object


force_feed($enable = false)   X-Ref
Force the given data/URL to be treated as a feed no matter what it
appears like

param: bool $enable Force the given data/URL to be treated as a feed

set_feed_url($url)   X-Ref
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.

param: mixed $url This is the URL (or array of URLs) that you want to parse.

set_file(&$file)   X-Ref
Provides an instance of SimplePie_File to use as a feed

param: object &$file Instance of SimplePie_File (or subclass)
return: bool True on success, false on failure

set_raw_data($data)   X-Ref
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.

param: string $data RSS or Atom data as a string.

set_timeout($timeout = 10)   X-Ref
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.

param: int $timeout The maximum number of seconds to spend waiting to retrieve a feed.

force_fsockopen($enable = false)   X-Ref
Forces SimplePie to use fsockopen() instead of the preferred cURL
functions.

param: bool $enable Force fsockopen() to be used

enable_xml_dump($enable = false)   X-Ref
Outputs the raw XML content of the feed, after it has gone through
SimplePie's filters.

Used only for debugging, this function will output the XML content as
text/xml. When SimplePie reads in a feed, it does a bit of cleaning up
before trying to parse it. Many parts of the feed are re-written in
memory, and in the end, you have a parsable feed. XML dump shows you the
actual XML that SimplePie tries to parse, which may or may not be very
different from the original feed.

param: bool $enable Enable XML dump

enable_cache($enable = true)   X-Ref
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.

param: bool $enable Enable caching

set_cache_duration($seconds = 3600)   X-Ref
Set the length of time (in seconds) that the contents of a feed
will be cached.

param: int $seconds The feed content cache duration.

set_autodiscovery_cache_duration($seconds = 604800)   X-Ref
Set the length of time (in seconds) that the autodiscovered feed
URL will be cached.

param: int $seconds The autodiscovered feed URL cache duration.

set_cache_location($location = './cache')   X-Ref
Set the file system location where the cached files should be stored.

param: string $location The file system location.

enable_order_by_date($enable = true)   X-Ref
Determines whether feed items should be sorted into reverse chronological order.

param: bool $enable Sort as reverse chronological order.

set_input_encoding($encoding = false)   X-Ref
Allows you to override the character encoding reported by the feed.

param: string $encoding Character encoding.

set_autodiscovery_level($level = SIMPLEPIE_LOCATOR_ALL)   X-Ref
Set how much feed autodiscovery to do

param: int $level Feed Autodiscovery Level (level can be a

set_cache_class($class = 'SimplePie_Cache')   X-Ref
Allows you to change which class SimplePie uses for caching.
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_locator_class($class = 'SimplePie_Locator')   X-Ref
Allows you to change which class SimplePie uses for auto-discovery.
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_parser_class($class = 'SimplePie_Parser')   X-Ref
Allows you to change which class SimplePie uses for XML parsing.
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_file_class($class = 'SimplePie_File')   X-Ref
Allows you to change which class SimplePie uses for remote file fetching.
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_sanitize_class($class = 'SimplePie_Sanitize')   X-Ref
Allows you to change which class SimplePie uses for data sanitization.
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_item_class($class = 'SimplePie_Item')   X-Ref
Allows you to change which class SimplePie uses for handling feed items.
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_author_class($class = 'SimplePie_Author')   X-Ref
Allows you to change which class SimplePie uses for handling author data.
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_category_class($class = 'SimplePie_Category')   X-Ref
Allows you to change which class SimplePie uses for handling category data.
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_enclosure_class($class = 'SimplePie_Enclosure')   X-Ref
Allows you to change which class SimplePie uses for feed enclosures.
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_caption_class($class = 'SimplePie_Caption')   X-Ref
Allows you to change which class SimplePie uses for <media:text> captions
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_copyright_class($class = 'SimplePie_Copyright')   X-Ref
Allows you to change which class SimplePie uses for <media:copyright>
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_credit_class($class = 'SimplePie_Credit')   X-Ref
Allows you to change which class SimplePie uses for <media:credit>
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_rating_class($class = 'SimplePie_Rating')   X-Ref
Allows you to change which class SimplePie uses for <media:rating>
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_restriction_class($class = 'SimplePie_Restriction')   X-Ref
Allows you to change which class SimplePie uses for <media:restriction>
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_content_type_sniffer_class($class = 'SimplePie_Content_Type_Sniffer')   X-Ref
Allows you to change which class SimplePie uses for content-type sniffing.
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_source_class($class = 'SimplePie_Source')   X-Ref
Allows you to change which class SimplePie uses item sources.
Useful when you are overloading or extending SimplePie's default classes.

param: string $class Name of custom class.

set_useragent($ua = SIMPLEPIE_USERAGENT)   X-Ref
Allows you to override the default user agent string.

param: string $ua New user agent string.

set_cache_name_function($function = 'md5')   X-Ref
Set callback function to create cache filename with

param: mixed $function Callback function

set_javascript($get = 'js')   X-Ref
Set javascript query string parameter

param: mixed $get Javascript query string parameter

set_stupidly_fast($set = false)   X-Ref
Set options to make SP as fast as possible.  Forgoes a
substantial amount of data sanitization in favor of speed.

param: bool $set Whether to set them or not

set_max_checked_feeds($max = 10)   X-Ref
Set maximum number of feeds to check with autodiscovery

param: int $max Maximum number of feeds to check

remove_div($enable = true)   X-Ref
No description

strip_htmltags($tags = '', $encode = null)   X-Ref
No description

encode_instead_of_strip($enable = true)   X-Ref
No description

strip_attributes($attribs = '')   X-Ref
No description

set_output_encoding($encoding = 'UTF-8')   X-Ref
No description

strip_comments($strip = false)   X-Ref
No description

set_url_replacements($element_attribute = array('a' => 'href', 'area' => 'href', 'blockquote' => 'cite', 'del' => 'cite', 'form' => 'action', 'img' => array('longdesc', 'src')   X-Ref
Set element/attribute key/value pairs of HTML attributes
containing URLs that need to be resolved relative to the feed

param: array $element_attribute Element/attribute key/value pairs

set_favicon_handler($page = false, $qs = 'i')   X-Ref
Set the handler to enable the display of cached favicons.

param: str $page Web-accessible path to the handler_favicon.php file.
param: str $qs The query string that the value should be passed to.

set_image_handler($page = false, $qs = 'i')   X-Ref
Set the handler to enable the display of cached images.

param: str $page Web-accessible path to the handler_image.php file.
param: str $qs The query string that the value should be passed to.

set_item_limit($limit = 0)   X-Ref
Set the limit for items returned per-feed with multifeeds.

param: integer $limit The maximum number of items to return.

init()   X-Ref
No description

error()   X-Ref
Return the error message for the occured error

return: string Error message

get_encoding()   X-Ref
No description

handle_content_type($mime = 'text/html')   X-Ref
No description

get_type()   X-Ref
No description

get_favicon()   X-Ref
Returns the URL for the favicon of the feed's website.


subscribe_url()   X-Ref


subscribe_feed()   X-Ref
No description

subscribe_outlook()   X-Ref
No description

subscribe_podcast()   X-Ref
No description

subscribe_itunes()   X-Ref
No description

subscribe_service($feed_url, $site_url = null)   X-Ref
Creates the subscribe_* methods' return data

param: string $feed_url String to prefix to the feed URL
param: string $site_url String to prefix to the site URL (and
return: mixed URL if feed exists, false otherwise

subscribe_aol()   X-Ref
No description

subscribe_bloglines()   X-Ref
No description

subscribe_eskobo()   X-Ref
No description

subscribe_feedfeeds()   X-Ref
No description

subscribe_feedster()   X-Ref
No description

subscribe_google()   X-Ref
No description

subscribe_gritwire()   X-Ref
No description

subscribe_msn()   X-Ref
No description

subscribe_netvibes()   X-Ref
No description

subscribe_newsburst()   X-Ref
No description

subscribe_newsgator()   X-Ref
No description

subscribe_odeo()   X-Ref
No description

subscribe_podnova()   X-Ref
No description

subscribe_rojo()   X-Ref
No description

subscribe_yahoo()   X-Ref
No description

get_feed_tags($namespace, $tag)   X-Ref
No description

get_channel_tags($namespace, $tag)   X-Ref
No description

get_image_tags($namespace, $tag)   X-Ref
No description

get_base($element = array()   X-Ref
No description

sanitize($data, $type, $base = '')   X-Ref
No description

get_title()   X-Ref
No description

get_category($key = 0)   X-Ref
No description

get_categories()   X-Ref
No description

get_author($key = 0)   X-Ref
No description

get_authors()   X-Ref
No description

get_contributor($key = 0)   X-Ref
No description

get_contributors()   X-Ref
No description

get_link($key = 0, $rel = 'alternate')   X-Ref
No description

get_permalink()   X-Ref
Added for parity between the parent-level and the item/entry-level.


get_links($rel = 'alternate')   X-Ref
No description

get_all_discovered_feeds()   X-Ref
No description

get_description()   X-Ref
No description

get_copyright()   X-Ref
No description

get_language()   X-Ref
No description

get_latitude()   X-Ref
No description

get_longitude()   X-Ref
No description

get_image_title()   X-Ref
No description

get_image_url()   X-Ref
No description

get_image_link()   X-Ref
No description

get_image_width()   X-Ref
No description

get_image_height()   X-Ref
No description

get_item_quantity($max = 0)   X-Ref
No description

get_item($key = 0)   X-Ref
No description

get_items($start = 0, $end = 0)   X-Ref
No description

sort_items($a, $b)   X-Ref


merge_items($urls, $start = 0, $end = 0, $limit = 0)   X-Ref


Class: SimplePie_Item  - X-Ref

SimplePie_Item($feed, $data)   X-Ref
No description

__toString()   X-Ref
No description

__destruct()   X-Ref
Remove items that link back to this before destroying this object


get_item_tags($namespace, $tag)   X-Ref
No description

get_base($element = array()   X-Ref
No description

sanitize($data, $type, $base = '')   X-Ref
No description

get_feed()   X-Ref
No description

get_id($hash = false)   X-Ref
No description

get_title()   X-Ref
No description

get_description($description_only = false)   X-Ref
No description

get_content($content_only = false)   X-Ref
No description

get_category($key = 0)   X-Ref
No description

get_categories()   X-Ref
No description

get_author($key = 0)   X-Ref
No description

get_contributor($key = 0)   X-Ref
No description

get_contributors()   X-Ref
No description

get_authors()   X-Ref
No description

get_copyright()   X-Ref
No description

get_date($date_format = 'j F Y, g:i a')   X-Ref
No description

get_local_date($date_format = '%c')   X-Ref
No description

get_permalink()   X-Ref
No description

get_link($key = 0, $rel = 'alternate')   X-Ref
No description

get_links($rel = 'alternate')   X-Ref
No description

get_enclosure($key = 0, $prefer = null)   X-Ref


get_enclosures()   X-Ref
Grabs all available enclosures (podcasts, etc.)

Supports the <enclosure> RSS tag, as well as Media RSS and iTunes RSS.

At this point, we're pretty much assuming that all enclosures for an item are the same content.  Anything else is too complicated to properly support.


get_latitude()   X-Ref
No description

get_longitude()   X-Ref
No description

get_source()   X-Ref
No description

add_to_service($item_url, $title_url = null, $summary_url = null)   X-Ref
Creates the add_to_* methods' return data

param: string $item_url String to prefix to the item permalink
param: string $title_url String to prefix to the item title
return: mixed URL if feed exists, false otherwise

add_to_blinklist()   X-Ref
No description

add_to_blogmarks()   X-Ref
No description

add_to_delicious()   X-Ref
No description

add_to_digg()   X-Ref
No description

add_to_furl()   X-Ref
No description

add_to_magnolia()   X-Ref
No description

add_to_myweb20()   X-Ref
No description

add_to_newsvine()   X-Ref
No description

add_to_reddit()   X-Ref
No description

add_to_segnalo()   X-Ref
No description

add_to_simpy()   X-Ref
No description

add_to_spurl()   X-Ref
No description

add_to_wists()   X-Ref
No description

search_technorati()   X-Ref
No description

Class: SimplePie_Source  - X-Ref

SimplePie_Source($item, $data)   X-Ref
No description

__toString()   X-Ref
No description

get_source_tags($namespace, $tag)   X-Ref
No description

get_base($element = array()   X-Ref
No description

sanitize($data, $type, $base = '')   X-Ref
No description

get_item()   X-Ref
No description

get_title()   X-Ref
No description

get_category($key = 0)   X-Ref
No description

get_categories()   X-Ref
No description

get_author($key = 0)   X-Ref
No description

get_authors()   X-Ref
No description

get_contributor($key = 0)   X-Ref
No description

get_contributors()   X-Ref
No description

get_link($key = 0, $rel = 'alternate')   X-Ref
No description

get_permalink()   X-Ref
Added for parity between the parent-level and the item/entry-level.


get_links($rel = 'alternate')   X-Ref
No description

get_description()   X-Ref
No description

get_copyright()   X-Ref
No description

get_language()   X-Ref
No description

get_latitude()   X-Ref
No description

get_longitude()   X-Ref
No description

get_image_url()   X-Ref
No description

Class: SimplePie_Author  - X-Ref

SimplePie_Author($name = null, $link = null, $email = null)   X-Ref
No description

__toString()   X-Ref
No description

get_name()   X-Ref
No description

get_link()   X-Ref
No description

get_email()   X-Ref
No description

Class: SimplePie_Category  - X-Ref

SimplePie_Category($term = null, $scheme = null, $label = null)   X-Ref
No description

__toString()   X-Ref
No description

get_term()   X-Ref
No description

get_scheme()   X-Ref
No description

get_label()   X-Ref
No description

Class: SimplePie_Enclosure  - X-Ref

SimplePie_Enclosure($link = null, $type = null, $length = null, $javascript = null, $bitrate = null, $captions = null, $categories = null, $channels = null, $copyright = null, $credits = null, $description = null, $duration = null, $expression = null, $framerate = null, $hashes = null, $height = null, $keywords = null, $lang = null, $medium = null, $player = null, $ratings = null, $restrictions = null, $samplingrate = null, $thumbnails = null, $title = null, $width = null)   X-Ref
No description

__toString()   X-Ref
No description

get_bitrate()   X-Ref
No description

get_caption($key = 0)   X-Ref
No description

get_captions()   X-Ref
No description

get_category($key = 0)   X-Ref
No description

get_categories()   X-Ref
No description

get_channels()   X-Ref
No description

get_copyright()   X-Ref
No description

get_credit($key = 0)   X-Ref
No description

get_credits()   X-Ref
No description

get_description()   X-Ref
No description

get_duration($convert = false)   X-Ref
No description

get_expression()   X-Ref
No description

get_extension()   X-Ref
No description

get_framerate()   X-Ref
No description

get_handler()   X-Ref
No description

get_hash($key = 0)   X-Ref
No description

get_hashes()   X-Ref
No description

get_height()   X-Ref
No description

get_language()   X-Ref
No description

get_keyword($key = 0)   X-Ref
No description

get_keywords()   X-Ref
No description

get_length()   X-Ref
No description

get_link()   X-Ref
No description

get_medium()   X-Ref
No description

get_player()   X-Ref
No description

get_rating($key = 0)   X-Ref
No description

get_ratings()   X-Ref
No description

get_restriction($key = 0)   X-Ref
No description

get_restrictions()   X-Ref
No description

get_sampling_rate()   X-Ref
No description

get_size()   X-Ref
No description

get_thumbnail($key = 0)   X-Ref
No description

get_thumbnails()   X-Ref
No description

get_title()   X-Ref
No description

get_type()   X-Ref
No description

get_width()   X-Ref
No description

native_embed($options='')   X-Ref
No description

embed($options = '', $native = false)   X-Ref


get_real_type($find_handler = false)   X-Ref
No description

Class: SimplePie_Caption  - X-Ref

SimplePie_Caption($type = null, $lang = null, $startTime = null, $endTime = null, $text = null)   X-Ref
No description

__toString()   X-Ref
No description

get_endtime()   X-Ref
No description

get_language()   X-Ref
No description

get_starttime()   X-Ref
No description

get_text()   X-Ref
No description

get_type()   X-Ref
No description

Class: SimplePie_Credit  - X-Ref

SimplePie_Credit($role = null, $scheme = null, $name = null)   X-Ref
No description

__toString()   X-Ref
No description

get_role()   X-Ref
No description

get_scheme()   X-Ref
No description

get_name()   X-Ref
No description

Class: SimplePie_Copyright  - X-Ref

SimplePie_Copyright($url = null, $label = null)   X-Ref
No description

__toString()   X-Ref
No description

get_url()   X-Ref
No description

get_attribution()   X-Ref
No description

Class: SimplePie_Rating  - X-Ref

SimplePie_Rating($scheme = null, $value = null)   X-Ref
No description

__toString()   X-Ref
No description

get_scheme()   X-Ref
No description

get_value()   X-Ref
No description

Class: SimplePie_Restriction  - X-Ref

SimplePie_Restriction($relationship = null, $type = null, $value = null)   X-Ref
No description

__toString()   X-Ref
No description

get_relationship()   X-Ref
No description

get_type()   X-Ref
No description

get_value()   X-Ref
No description

Class: SimplePie_File  - X-Ref


SimplePie_File($url, $timeout = 10, $redirects = 5, $headers = null, $useragent = null, $force_fsockopen = false)   X-Ref
No description

Class: SimplePie_HTTP_Parser  - X-Ref

HTTP Response Parser

SimplePie_HTTP_Parser($data)   X-Ref
Create an instance of the class with the input data

param: string $data Input data

parse()   X-Ref
Parse the input data

return: bool true on success, false on failure

has_data()   X-Ref
Check whether there is data beyond the pointer

return: bool true if there is further data, false if not

is_linear_whitespace()   X-Ref
See if the next character is LWS

return: bool true if the next character is LWS, false if not

http_version()   X-Ref
Parse the HTTP version


status()   X-Ref
Parse the status code


reason()   X-Ref
Parse the reason phrase


new_line()   X-Ref
Deal with a new line, shifting data around as needed


name()   X-Ref
Parse a header name


linear_whitespace()   X-Ref
Parse LWS, replacing consecutive LWS characters with a single space


value()   X-Ref
See what state to move to while within non-quoted header values


value_char()   X-Ref
Parse a header value while outside quotes


quote()   X-Ref
See what state to move to while within quoted header values


quote_char()   X-Ref
Parse a header value while within quotes


quote_escaped()   X-Ref
Parse an escaped character within quotes


body()   X-Ref
Parse the body


Class: SimplePie_gzdecode  - X-Ref

gzdecode

__set($name, $value)   X-Ref
Don't allow anything to be set


SimplePie_gzdecode($data)   X-Ref
Set the compressed string and related properties


parse()   X-Ref
Decode the GZIP stream


Class: SimplePie_Cache  - X-Ref

SimplePie_Cache()   X-Ref
Don't call the constructor. Please.


create($location, $filename, $extension)   X-Ref
Create a new SimplePie_Cache object


Class: SimplePie_Cache_File  - X-Ref

SimplePie_Cache_File($location, $filename, $extension)   X-Ref
No description

save($data)   X-Ref
No description

load()   X-Ref
No description

mtime()   X-Ref
No description

touch()   X-Ref
No description

unlink()   X-Ref
No description

Class: SimplePie_Cache_DB  - X-Ref

Class: SimplePie_Cache_MySQL  - X-Ref

SimplePie_Cache_MySQL($mysql_location, $name, $extension)   X-Ref
No description

save($data)   X-Ref
No description

load()   X-Ref
No description

mtime()   X-Ref
No description

touch()   X-Ref
No description

unlink()   X-Ref
No description

Class: SimplePie_Misc  - X-Ref

time_hms($seconds)   X-Ref
No description

absolutize_url($relative, $base)   X-Ref
No description

remove_dot_segments($input)   X-Ref
No description

get_element($realname, $string)   X-Ref
No description

element_implode($element)   X-Ref
No description

error($message, $level, $file, $line)   X-Ref
No description

display_cached_file($identifier_url, $cache_location = './cache', $cache_extension = 'spc', $cache_class = 'SimplePie_Cache', $cache_name_function = 'md5')   X-Ref
If a file has been cached, retrieve and display it.

This is most useful for caching images (get_favicon(), etc.),
however it works for all cached files.  This WILL NOT display ANY
file/image/page/whatever, but rather only display what has already
been cached by SimplePie.

param: str $identifier_url URL that is used to identify the content.
param: str $cache_location Location of SimplePie's cache.  Defaults
param: str $cache_extension The file extension that the file was
param: str $cache_class Name of the cache-handling class being used
param: str $cache_name_function Obsolete. Exists for backwards

fix_protocol($url, $http = 1)   X-Ref
No description

parse_url($url)   X-Ref
No description

compress_parse_url($scheme = '', $authority = '', $path = '', $query = '', $fragment = '')   X-Ref
No description

normalize_url($url)   X-Ref
No description

percent_encoding_normalization($match)   X-Ref
No description

utf8_bad_replace($str)   X-Ref
Remove bad UTF-8 bytes

PCRE Pattern to locate bad bytes in a UTF-8 string comes from W3C
FAQ: Multilingual Forms (modified to include full ASCII range)

author: Geoffrey Sneddon
param: string $str String to remove bad UTF-8 bytes from
return: string UTF-8 string

windows_1252_to_utf8($string)   X-Ref
Converts a Windows-1252 encoded string to a UTF-8 encoded string

param: string $string Windows-1252 encoded string
return: string UTF-8 encoded string

change_encoding($data, $input, $output)   X-Ref
No description

encoding($charset)   X-Ref
No description

get_curl_version()   X-Ref
No description

is_subclass_of($class1, $class2)   X-Ref
No description

strip_comments($data)   X-Ref
Strip HTML comments

param: string $data Data to strip comments from
return: string Comment stripped string

parse_date($dt)   X-Ref
No description

entities_decode($data)   X-Ref
Decode HTML entities

param: string $data Input data
return: string Output data

uncomment_rfc822($string)   X-Ref
Remove RFC822 comments

param: string $data Data to strip comments from
return: string Comment stripped string

parse_mime($mime)   X-Ref
No description

htmlspecialchars_decode($string, $quote_style)   X-Ref
No description

atom_03_construct_type($attribs)   X-Ref
No description

atom_10_construct_type($attribs)   X-Ref
No description

atom_10_content_construct_type($attribs)   X-Ref
No description

is_isegment_nz_nc($string)   X-Ref
No description

space_seperated_tokens($string)   X-Ref
No description

array_unique($array)   X-Ref
No description

codepoint_to_utf8($codepoint)   X-Ref
Converts a unicode codepoint to a UTF-8 character

param: int $codepoint Unicode codepoint
return: string UTF-8 character

stripos($haystack, $needle, $offset = 0)   X-Ref
Re-implementation of PHP 5's stripos()

Returns the numeric position of the first occurrence of needle in the
haystack string.

param: object $haystack
param: string $needle Note that the needle may be a string of one or more
param: int $offset The optional offset parameter allows you to specify which
return: bool If needle is not found, stripos() will return boolean false.

parse_str($str)   X-Ref
Similar to parse_str()

Returns an associative array of name/value pairs, where the value is an
array of values that have used the same name

param: string $str The input string.
return: array

xml_encoding($data)   X-Ref
Detect XML encoding, as per XML 1.0 Appendix F.1

param: string $data XML data
return: array Possible encodings

output_javascript()   X-Ref
No description

embed_odeo(link)   X-Ref
No description

embed_quicktime(type, bgcolor, width, height, link, placeholder, loop)   X-Ref
No description

embed_flash(bgcolor, width, height, link, loop, type)   X-Ref
No description

embed_flv(width, height, link, placeholder, loop, player)   X-Ref
No description

embed_wmedia(width, height, link)   X-Ref
No description

Class: SimplePie_Decode_HTML_Entities  - X-Ref

Decode HTML Entities

This implements HTML5 as of revision 967 (2007-06-28)

SimplePie_Decode_HTML_Entities($data)   X-Ref
Create an instance of the class with the input data

param: string $data Input data

parse()   X-Ref
Parse the input data

return: string Output data

consume()   X-Ref
Consume the next byte

return: mixed The next byte, or false, if there is no more data

consume_range($chars)   X-Ref
Consume a range of characters

param: string $chars Characters to consume
return: mixed A series of characters that match the range, or false

unconsume()   X-Ref
Unconsume one byte


entity()   X-Ref
Decode an entity


Class: SimplePie_IRI  - X-Ref

IRI parser/serialiser

__toString()   X-Ref
Return the entire IRI when you try and read the object as a string

return: string

SimplePie_IRI($iri)   X-Ref
Create a new IRI object, from a specified string

param: string $iri
return: SimplePie_IRI

absolutize($base, $relative)   X-Ref
Create a new IRI object by resolving a relative IRI

param: SimplePie_IRI $base Base IRI
param: string $relative Relative IRI
return: SimplePie_IRI

parse_iri($iri)   X-Ref
Parse an IRI into scheme/authority/path/query/fragment segments

param: string $iri
return: array

remove_dot_segments($input)   X-Ref
Remove dot segments from a path

param: string $input
return: string

replace_invalid_with_pct_encoding($string, $valid_chars, $case = SIMPLEPIE_SAME_CASE)   X-Ref
Replace invalid character with percent encoding

param: string $string Input string
param: string $valid_chars Valid characters
param: int $case Normalise case
return: string

is_valid()   X-Ref
Check if the object represents a valid IRI

return: bool

set_scheme($scheme)   X-Ref
Set the scheme. Returns true on success, false on failure (if there are
any invalid characters).

param: string $scheme
return: bool

set_authority($authority)   X-Ref
Set the authority. Returns true on success, false on failure (if there are
any invalid characters).

param: string $authority
return: bool

set_userinfo($userinfo)   X-Ref
Set the userinfo.

param: string $userinfo
return: bool

set_host($host)   X-Ref
Set the host. Returns true on success, false on failure (if there are
any invalid characters).

param: string $host
return: bool

set_port($port)   X-Ref
Set the port. Returns true on success, false on failure (if there are
any invalid characters).

param: string $port
return: bool

set_path($path)   X-Ref
Set the path.

param: string $path
return: bool

set_query($query)   X-Ref
Set the query.

param: string $query
return: bool

set_fragment($fragment)   X-Ref
Set the fragment.

param: string $fragment
return: bool

get_iri()   X-Ref
Get the complete IRI

return: string

get_scheme()   X-Ref
Get the scheme

return: string

get_authority()   X-Ref
Get the complete authority

return: string

get_userinfo()   X-Ref
Get the user information

return: string

get_host()   X-Ref
Get the host

return: string

get_port()   X-Ref
Get the port

return: string

get_path()   X-Ref
Get the path

return: string

get_query()   X-Ref
Get the query

return: string

get_fragment()   X-Ref
Get the fragment

return: string

Class: SimplePie_Net_IPv6  - X-Ref

Class to validate and to work with IPv6 addresses.

removeNetmaskSpec($ip)   X-Ref
Removes a possible existing netmask specification of an IP address.

param: string $ip the (compressed) IP as Hex representation
return: string the IP the without netmask

Uncompress($ip)   X-Ref
Uncompresses an IPv6 address

RFC 2373 allows you to compress zeros in an address to '::'. This
function expects an valid IPv6 address and expands the '::' to
the required zeros.

Example:     FF01::101    ->    FF01:0:0:0:0:0:0:101
::1        ->    0:0:0:0:0:0:0:1

param: string $ip a valid IPv6-address (hex format)
return: string the uncompressed IPv6-address (hex format)

SplitV64($ip)   X-Ref
Splits an IPv6 address into the IPv6 and a possible IPv4 part

RFC 2373 allows you to note the last two parts of an IPv6 address as
an IPv4 compatible address

Example:     0:0:0:0:0:0:13.1.68.3
0:0:0:0:0:FFFF:129.144.52.38

param: string $ip a valid IPv6-address (hex format)
return: array [0] contains the IPv6 part, [1] the IPv4 part (hex format)

checkIPv6($ip)   X-Ref
Checks an IPv6 address

Checks if the given IP is IPv6-compatible

param: string $ip a valid IPv6-address
return: bool true if $ip is an IPv6 address

Class: SimplePie_Parse_Date  - X-Ref

Date Parser

SimplePie_Parse_Date()   X-Ref
Create new SimplePie_Parse_Date object, and set self::day_pcre,
self::month_pcre, and self::built_in


get()   X-Ref
Get the object


parse($date)   X-Ref
Parse a date

param: string $date Date to parse
return: int Timestamp corresponding to date string, or false on failure

add_callback($callback)   X-Ref
Add a callback method to parse a date

param: callback $callback

date_w3cdtf($date)   X-Ref
Parse a superset of W3C-DTF (allows hyphens and colons to be omitted, as
well as allowing any of upper or lower case "T", horizontal tabs, or
spaces to be used as the time seperator (including more than one))

return: int Timestamp

remove_rfc2822_comments($string)   X-Ref
Remove RFC822 comments

param: string $data Data to strip comments from
return: string Comment stripped string

date_rfc2822($date)   X-Ref
Parse RFC2822's date format

return: int Timestamp

date_rfc850($date)   X-Ref
Parse RFC850's date format

return: int Timestamp

date_asctime($date)   X-Ref
Parse C99's asctime()'s date format

return: int Timestamp

date_strtotime($date)   X-Ref
Parse dates using strtotime()

return: int Timestamp

Class: SimplePie_Content_Type_Sniffer  - X-Ref

Content-type sniffing

SimplePie_Content_Type_Sniffer($file)   X-Ref
Create an instance of the class with the input file

param: SimplePie_Content_Type_Sniffer $file Input file

get_type()   X-Ref
Get the Content-Type of the specified file

return: string Actual Content-Type

text_or_binary()   X-Ref
Sniff text or binary

return: string Actual Content-Type

unknown()   X-Ref
Sniff unknown

return: string Actual Content-Type

image()   X-Ref
Sniff images

return: string Actual Content-Type

feed_or_html()   X-Ref
Sniff HTML

return: string Actual Content-Type

Class: SimplePie_XML_Declaration_Parser  - X-Ref

Parses the XML Declaration

SimplePie_XML_Declaration_Parser($data)   X-Ref
Create an instance of the class with the input data

param: string $data Input data

parse()   X-Ref
Parse the input data

return: bool true on success, false on failure

has_data()   X-Ref
Check whether there is data beyond the pointer

return: bool true if there is further data, false if not

skip_whitespace()   X-Ref
Advance past any whitespace

return: int Number of whitespace characters passed

get_value()   X-Ref
Read value


before_version_name()   X-Ref
No description

version_name()   X-Ref
No description

version_equals()   X-Ref
No description

version_value()   X-Ref
No description

encoding_name()   X-Ref
No description

encoding_equals()   X-Ref
No description

encoding_value()   X-Ref
No description

standalone_name()   X-Ref
No description

standalone_equals()   X-Ref
No description

standalone_value()   X-Ref
No description

Class: SimplePie_Locator  - X-Ref

SimplePie_Locator(&$file, $timeout = 10, $useragent = null, $file_class = 'SimplePie_File', $max_checked_feeds = 10, $content_type_sniffer_class = 'SimplePie_Content_Type_Sniffer')   X-Ref
No description

find($type = SIMPLEPIE_LOCATOR_ALL, &$working)   X-Ref
No description

is_feed(&$file)   X-Ref
No description

get_base()   X-Ref
No description

autodiscovery()   X-Ref
No description

get_links()   X-Ref
No description

extension(&$array)   X-Ref
No description

body(&$array)   X-Ref
No description

Class: SimplePie_Parser  - X-Ref

parse(&$data, $encoding)   X-Ref
No description

get_error_code()   X-Ref
No description

get_error_string()   X-Ref
No description

get_current_line()   X-Ref
No description

get_current_column()   X-Ref
No description

get_current_byte()   X-Ref
No description

get_data()   X-Ref
No description

tag_open($parser, $tag, $attributes)   X-Ref
No description

cdata($parser, $cdata)   X-Ref
No description

tag_close($parser, $tag)   X-Ref
No description

split_ns($string)   X-Ref
No description

Class: SimplePie_Sanitize  - X-Ref


remove_div($enable = true)   X-Ref
No description

set_image_handler($page = false)   X-Ref
No description

pass_cache_data($enable_cache = true, $cache_location = './cache', $cache_name_function = 'md5', $cache_class = 'SimplePie_Cache')   X-Ref
No description

pass_file_data($file_class = 'SimplePie_File', $timeout = 10, $useragent = '', $force_fsockopen = false)   X-Ref
No description

strip_htmltags($tags = array('base', 'blink', 'body', 'doctype', 'embed', 'font', 'form', 'frame', 'frameset', 'html', 'iframe', 'input', 'marquee', 'meta', 'noscript', 'object', 'param', 'script', 'style')   X-Ref
No description

encode_instead_of_strip($encode = false)   X-Ref
No description

strip_attributes($attribs = array('bgsound', 'class', 'expr', 'id', 'style', 'onclick', 'onerror', 'onfinish', 'onmouseover', 'onmouseout', 'onfocus', 'onblur', 'lowsrc', 'dynsrc')   X-Ref
No description

strip_comments($strip = false)   X-Ref
No description

set_output_encoding($encoding = 'UTF-8')   X-Ref
No description

set_url_replacements($element_attribute = array('a' => 'href', 'area' => 'href', 'blockquote' => 'cite', 'del' => 'cite', 'form' => 'action', 'img' => array('longdesc', 'src')   X-Ref
Set element/attribute key/value pairs of HTML attributes
containing URLs that need to be resolved relative to the feed

param: array $element_attribute Element/attribute key/value pairs

sanitize($data, $type, $base = '')   X-Ref
No description

replace_urls($data, $tag, $attributes)   X-Ref
No description

do_strip_htmltags($match)   X-Ref
No description



Generated: Wed Dec 30 05:55:15 2009 Cross-referenced by PHPXref 0.7