SimplePie Class Reference

Inheritance diagram for SimplePie:

Public Member Functions
	__construct ()
	__toString ()
	__destruct ()
	force_feed ($enable=false)
	set_feed_url ($url)
	set_file (&$file)
	set_raw_data ($data)
	set_timeout ($timeout=10)
	force_fsockopen ($enable=false)
	enable_cache ($enable=true)
	set_cache_duration ($seconds=3600)
	set_autodiscovery_cache_duration ($seconds=604800)
	set_cache_location ($location= './cache')
	enable_order_by_date ($enable=true)
	set_input_encoding ($encoding=false)
	set_autodiscovery_level ($level=SIMPLEPIE_LOCATOR_ALL)
&	get_registry ()
	set_cache_class ($class= 'SimplePie_Cache')
	set_locator_class ($class= 'SimplePie_Locator')
	set_parser_class ($class= 'SimplePie_Parser')
	set_file_class ($class= 'SimplePie_File')
	set_sanitize_class ($class= 'SimplePie_Sanitize')
	set_item_class ($class= 'SimplePie_Item')
	set_author_class ($class= 'SimplePie_Author')
	set_category_class ($class= 'SimplePie_Category')
	set_enclosure_class ($class= 'SimplePie_Enclosure')
	set_caption_class ($class= 'SimplePie_Caption')
	set_copyright_class ($class= 'SimplePie_Copyright')
	set_credit_class ($class= 'SimplePie_Credit')
	set_rating_class ($class= 'SimplePie_Rating')
	set_restriction_class ($class= 'SimplePie_Restriction')
	set_content_type_sniffer_class ($class= 'SimplePie_Content_Type_Sniffer')
	set_source_class ($class= 'SimplePie_Source')
	set_useragent ($ua=SIMPLEPIE_USERAGENT)
	set_cache_name_function ($function= 'md5')
	set_stupidly_fast ($set=false)
	set_max_checked_feeds ($max=10)
	remove_div ($enable=true)
	strip_htmltags ($tags= '', $encode=null)
	encode_instead_of_strip ($enable=true)
	strip_attributes ($attribs= '')
	set_output_encoding ($encoding= 'UTF-8')
	strip_comments ($strip=false)
	set_url_replacements ($element_attribute=null)
	set_image_handler ($page=false, $qs= 'i')
	set_item_limit ($limit=0)
	init ()
	error ()
	get_raw_data ()
	get_encoding ()
	handle_content_type ($mime= 'text/html')
	get_type ()
	subscribe_url ()
	get_feed_tags ($namespace, $tag)
	get_channel_tags ($namespace, $tag)
	get_image_tags ($namespace, $tag)
	get_base ($element=array())
	sanitize ($data, $type, $base= '')
	get_title ()
	get_category ($key=0)
	get_categories ()
	get_author ($key=0)
	get_authors ()
	get_contributor ($key=0)
	get_contributors ()
	get_link ($key=0, $rel= 'alternate')
	get_permalink ()
	get_links ($rel= 'alternate')
	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 ($max=0)
	get_item ($key=0)
	get_items ($start=0, $end=0)
	set_favicon_handler ($page=false, $qs= 'i')
	get_favicon ()
	__call ($method, $args)

Static Public Member Functions
static	sort_items ($a, $b)
static	merge_items ($urls, $start=0, $end=0, $limit=0)

Data Fields
	$data = array()
	$error
	$sanitize
	$useragent = SIMPLEPIE_USERAGENT
	$feed_url
	$file
	$raw_data
	$timeout = 10
	$force_fsockopen = false
	$force_feed = false
	$cache = true
	$cache_duration = 3600
	$autodiscovery_cache_duration = 604800
	$cache_location = './cache'
	$cache_name_function = 'md5'
	$order_by_date = true
	$input_encoding = false
	$autodiscovery = SIMPLEPIE_LOCATOR_ALL
	$registry
	$max_checked_feeds = 10
	$all_discovered_feeds = array()
	$image_handler = ''
	$multifeed_url = array()
	$multifeed_objects = array()
	$config_settings = null
	$item_limit = 0
	$strip_attributes = array('bgsound', 'class', 'expr', 'id', 'style', 'onclick', 'onerror', 'onfinish', 'onmouseover', 'onmouseout', 'onfocus', 'onblur', 'lowsrc', 'dynsrc')
	$strip_htmltags = array('base', 'blink', 'body', 'doctype', 'embed', 'font', 'form', 'frame', 'frameset', 'html', 'iframe', 'input', 'marquee', 'meta', 'noscript', 'object', 'param', 'script', 'style')

Protected Member Functions
	fetch_data (&$cache)

Detailed Description

Definition at line 118 of file Simplepie.php.

Constructor & Destructor Documentation

__construct

(

)

Definition at line 177 of file Simplepie.php.

__destruct

(

)

Definition at line 209 of file Simplepie.php.

Member Function Documentation

__call	(		$method,
			$args
	)

Definition at line 1810 of file Simplepie.php.

__toString

(

)

Definition at line 204 of file Simplepie.php.

enable_cache

(

$enable = true

)

Definition at line 279 of file Simplepie.php.

enable_order_by_date

(

$enable = true

)

Definition at line 299 of file Simplepie.php.

encode_instead_of_strip

(

$enable = true

)

Definition at line 454 of file Simplepie.php.

error

(

)

Definition at line 809 of file Simplepie.php.

fetch_data ( &  $cache )

protected

Definition at line 661 of file Simplepie.php.

force_feed

(

$enable = false

)

Definition at line 232 of file Simplepie.php.

force_fsockopen

(

$enable = false

)

Definition at line 274 of file Simplepie.php.

get_all_discovered_feeds

(

)

Definition at line 1406 of file Simplepie.php.

get_author

(

$key = 0

)

Definition at line 1166 of file Simplepie.php.

get_authors

(

)

Definition at line 1179 of file Simplepie.php.

get_base

(

$element = array()

)

Definition at line 1041 of file Simplepie.php.

get_categories

(

)

Definition at line 1111 of file Simplepie.php.

get_category

(

$key = 0

)

Definition at line 1098 of file Simplepie.php.

get_channel_tags	(		$namespace,
			$tag
	)

Definition at line 962 of file Simplepie.php.

get_contributor

(

$key = 0

)

Definition at line 1248 of file Simplepie.php.

get_contributors

(

)

Definition at line 1261 of file Simplepie.php.

get_copyright

(

)

Definition at line 1455 of file Simplepie.php.

get_description

(

)

Definition at line 1411 of file Simplepie.php.

get_encoding

(

)

Definition at line 819 of file Simplepie.php.

get_favicon

(

)

Definition at line 1799 of file Simplepie.php.

get_feed_tags	(		$namespace,
			$tag
	)

Definition at line 928 of file Simplepie.php.

get_image_height

(

)

Definition at line 1651 of file Simplepie.php.

get_image_link

(

)

Definition at line 1615 of file Simplepie.php.

get_image_tags	(		$namespace,
			$tag
	)

Definition at line 1005 of file Simplepie.php.

get_image_title

(

)

Definition at line 1555 of file Simplepie.php.

get_image_url

(

)

Definition at line 1583 of file Simplepie.php.

get_image_width

(

)

Definition at line 1635 of file Simplepie.php.

get_item

(

$key = 0

)

Definition at line 1681 of file Simplepie.php.

get_item_quantity

(

$max = 0

)

Definition at line 1667 of file Simplepie.php.

get_items	(		$start = 0,
			$end = 0
	)

Definition at line 1694 of file Simplepie.php.

get_language

(

)

Definition at line 1483 of file Simplepie.php.

get_latitude

(

)

Definition at line 1519 of file Simplepie.php.

get_link	(		$key = 0,
			$rel = 'alternate'
	)

Definition at line 1318 of file Simplepie.php.

get_links

(

$rel = 'alternate'

)

Definition at line 1336 of file Simplepie.php.

get_longitude

(

)

Definition at line 1535 of file Simplepie.php.

get_permalink

(

)

Definition at line 1331 of file Simplepie.php.

get_raw_data

(

)

Definition at line 814 of file Simplepie.php.

& get_registry

(

)

Definition at line 321 of file Simplepie.php.

get_title

(

)

Definition at line 1062 of file Simplepie.php.

get_type

(

)

Definition at line 841 of file Simplepie.php.

handle_content_type

(

$mime = 'text/html'

)

Definition at line 824 of file Simplepie.php.

init

(

)

Definition at line 498 of file Simplepie.php.

static merge_items (   $urls,   $start = 0,   $end = 0,   $limit = 0  )

static

Definition at line 1836 of file Simplepie.php.

remove_div

(

$enable = true

)

Definition at line 438 of file Simplepie.php.

sanitize	(		$data,
			$type,
			$base = ''
	)

Definition at line 1057 of file Simplepie.php.

set_author_class

(

$class = 'SimplePie_Author'

)

Definition at line 357 of file Simplepie.php.

set_autodiscovery_cache_duration

(

$seconds = 604800

)

Definition at line 289 of file Simplepie.php.

set_autodiscovery_level

(

$level = SIMPLEPIE_LOCATOR_ALL

)

Definition at line 316 of file Simplepie.php.

set_cache_class

(

$class = 'SimplePie_Cache'

)

Definition at line 327 of file Simplepie.php.

set_cache_duration

(

$seconds = 3600

)

Definition at line 284 of file Simplepie.php.

set_cache_location

(

$location = './cache'

)

Definition at line 294 of file Simplepie.php.

set_cache_name_function

(

$function = 'md5'

)

Definition at line 413 of file Simplepie.php.

set_caption_class

(

$class = 'SimplePie_Caption'

)

Definition at line 372 of file Simplepie.php.

set_category_class

(

$class = 'SimplePie_Category'

)

Definition at line 362 of file Simplepie.php.

set_content_type_sniffer_class

(

$class = 'SimplePie_Content_Type_Sniffer'

)

Definition at line 397 of file Simplepie.php.

set_copyright_class

(

$class = 'SimplePie_Copyright'

)

Definition at line 377 of file Simplepie.php.

set_credit_class

(

$class = 'SimplePie_Credit'

)

Definition at line 382 of file Simplepie.php.

set_enclosure_class

(

$class = 'SimplePie_Enclosure'

)

Definition at line 367 of file Simplepie.php.

set_favicon_handler	(		$page = false,
			$qs = 'i'
	)

Definition at line 1792 of file Simplepie.php.

set_feed_url

(

$url

)

Definition at line 237 of file Simplepie.php.

set_file

(

&

$file

)

Definition at line 253 of file Simplepie.php.

set_file_class

(

$class = 'SimplePie_File'

)

Definition at line 342 of file Simplepie.php.

set_image_handler	(		$page = false,
			$qs = 'i'
	)

Definition at line 481 of file Simplepie.php.

set_input_encoding

(

$encoding = false

)

Definition at line 304 of file Simplepie.php.

set_item_class

(

$class = 'SimplePie_Item'

)

Definition at line 352 of file Simplepie.php.

set_item_limit

(

$limit = 0

)

Definition at line 493 of file Simplepie.php.

set_locator_class

(

$class = 'SimplePie_Locator'

)

Definition at line 332 of file Simplepie.php.

set_max_checked_feeds

(

$max = 10

)

Definition at line 434 of file Simplepie.php.

set_output_encoding

(

$encoding = 'UTF-8'

)

Definition at line 467 of file Simplepie.php.

set_parser_class

(

$class = 'SimplePie_Parser'

)

Definition at line 337 of file Simplepie.php.

set_rating_class

(

$class = 'SimplePie_Rating'

)

Definition at line 387 of file Simplepie.php.

set_raw_data

(

$data

)

Definition at line 264 of file Simplepie.php.

set_restriction_class

(

$class = 'SimplePie_Restriction'

)

Definition at line 392 of file Simplepie.php.

set_sanitize_class

(

$class = 'SimplePie_Sanitize'

)

Definition at line 347 of file Simplepie.php.

set_source_class

(

$class = 'SimplePie_Source'

)

Definition at line 402 of file Simplepie.php.

set_stupidly_fast

(

$set = false

)

Definition at line 421 of file Simplepie.php.

set_timeout

(

$timeout = 10

)

Definition at line 269 of file Simplepie.php.

set_url_replacements

(

$element_attribute = null

)

Definition at line 476 of file Simplepie.php.

set_useragent

(

$ua = SIMPLEPIE_USERAGENT

)

Definition at line 408 of file Simplepie.php.

static sort_items (   $a,   $b  )

static

Definition at line 1831 of file Simplepie.php.

strip_attributes

(

$attribs = ''

)

Definition at line 458 of file Simplepie.php.

strip_comments

(

$strip = false

)

Definition at line 471 of file Simplepie.php.

strip_htmltags	(		$tags = '',
			$encode = null
	)

Definition at line 442 of file Simplepie.php.

subscribe_url

(

)

Definition at line 916 of file Simplepie.php.

Field Documentation

$all_discovered_feeds = array()

Definition at line 161 of file Simplepie.php.

$autodiscovery = SIMPLEPIE_LOCATOR_ALL

Definition at line 155 of file Simplepie.php.

$autodiscovery_cache_duration = 604800

Definition at line 145 of file Simplepie.php.

$cache = true

Definition at line 141 of file Simplepie.php.

$cache_duration = 3600

Definition at line 143 of file Simplepie.php.

$cache_location = './cache'

Definition at line 147 of file Simplepie.php.

$cache_name_function = 'md5'

Definition at line 149 of file Simplepie.php.

$config_settings = null

Definition at line 169 of file Simplepie.php.

$data = array()

Definition at line 121 of file Simplepie.php.

$error

Definition at line 123 of file Simplepie.php.

$feed_url

Definition at line 129 of file Simplepie.php.

$file

Definition at line 131 of file Simplepie.php.

$force_feed = false

Definition at line 139 of file Simplepie.php.

$force_fsockopen = false

Definition at line 137 of file Simplepie.php.

$image_handler = ''

Definition at line 163 of file Simplepie.php.

$input_encoding = false

Definition at line 153 of file Simplepie.php.

$item_limit = 0

Definition at line 171 of file Simplepie.php.

$max_checked_feeds = 10

Definition at line 159 of file Simplepie.php.

$multifeed_objects = array()

Definition at line 167 of file Simplepie.php.

$multifeed_url = array()

Definition at line 165 of file Simplepie.php.

$order_by_date = true

Definition at line 151 of file Simplepie.php.

$raw_data

Definition at line 133 of file Simplepie.php.

$registry

Definition at line 157 of file Simplepie.php.

$sanitize

Definition at line 125 of file Simplepie.php.

$strip_attributes = array('bgsound', 'class', 'expr', 'id', 'style', 'onclick', 'onerror', 'onfinish', 'onmouseover', 'onmouseout', 'onfocus', 'onblur', 'lowsrc', 'dynsrc')

Definition at line 173 of file Simplepie.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 175 of file Simplepie.php.

$timeout = 10

Definition at line 135 of file Simplepie.php.

$useragent = SIMPLEPIE_USERAGENT

Definition at line 127 of file Simplepie.php.

---

The documentation for this class was generated from the following file:

• lib/class/Simplepie.php