SimplePie_Sanitize Class Reference

Public Member Functions
	remove_div ($enable=true)
	set_image_handler ($page=false)
	pass_cache_data ($enable_cache=true, $cache_location= './cache', $cache_name_function= 'md5', $cache_class= 'SimplePie_Cache')
	pass_file_data ($file_class= 'SimplePie_File', $timeout=10, $useragent= '', $force_fsockopen=false)
	strip_htmltags ($tags=array('base', 'blink', 'body', 'doctype', 'embed', 'font', 'form', 'frame', 'frameset', 'html', 'iframe', 'input', 'marquee', 'meta', 'noscript', 'object', 'param', 'script', 'style'))
	encode_instead_of_strip ($encode=false)
	strip_attributes ($attribs=array('bgsound', 'class', 'expr', 'id', 'style', 'onclick', 'onerror', 'onfinish', 'onmouseover', 'onmouseout', 'onfocus', 'onblur', 'lowsrc', 'dynsrc'))
	strip_comments ($strip=false)
	set_output_encoding ($encoding= 'UTF-8')
	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'))
	sanitize ($data, $type, $base= '')
	replace_urls ($data, $tag, $attributes)
	do_strip_htmltags ($match)
Data Fields
	$base
	$remove_div = true
	$image_handler = ''
	$strip_htmltags = array('base', 'blink', 'body', 'doctype', 'embed', 'font', 'form', 'frame', 'frameset', 'html', 'iframe', 'input', 'marquee', 'meta', 'noscript', 'object', 'param', 'script', 'style')
	$encode_instead_of_strip = false
	$strip_attributes = array('bgsound', 'class', 'expr', 'id', 'style', 'onclick', 'onerror', 'onfinish', 'onmouseover', 'onmouseout', 'onfocus', 'onblur', 'lowsrc', 'dynsrc')
	$strip_comments = false
	$output_encoding = 'UTF-8'
	$enable_cache = true
	$cache_location = './cache'
	$cache_name_function = 'md5'
	$cache_class = 'SimplePie_Cache'
	$file_class = 'SimplePie_File'
	$timeout = 10
	$useragent = ''
	$force_fsockopen = false
	$replace_url_attributes

---

Detailed Description

Todo:

Move to using an actual HTML parser (this will allow tags to be properly stripped, and to switch between HTML and XHTML), this will also make it easier to shorten a string while preserving HTML tags

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

---

Member Function Documentation

do_strip_htmltags

(

$

match

)

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

encode_instead_of_strip

(

$

encode = false

)

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

pass_cache_data	(	$	enable_cache = true,
		$	cache_location = './cache',
		$	cache_name_function = 'md5',
		$	cache_class = 'SimplePie_Cache'
	)

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

pass_file_data	(	$	file_class = 'SimplePie_File',
		$	timeout = 10,
		$	useragent = '',
		$	force_fsockopen = false
	)

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

remove_div

(

$

enable = true

)

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

replace_urls	(	$	data,
		$	tag,
		$	attributes
	)

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

Here is the call graph for this function:

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

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

Here is the call graph for this function:

set_image_handler

(

$

page = false

)

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

set_output_encoding

(

$

encoding = 'UTF-8'

)

Definition at line 14333 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

Since:

1.0

Parameters:

array

$element_attribute

Element/attribute key/value pairs

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

strip_attributes

(

$

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

)

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

strip_comments

(

$

strip = false

)

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

strip_htmltags

(

$

tags = array('base', 'blink', 'body', 'doctype', 'embed', 'font', 'form', 'frame', 'frameset', 'html', 'iframe', 'input', 'marquee', 'meta', 'noscript', 'object', 'param', 'script', 'style')

)

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

---

Field Documentation

$base

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

$cache_class = 'SimplePie_Cache'

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

$cache_location = './cache'

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

$cache_name_function = 'md5'

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

$enable_cache = true

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

$encode_instead_of_strip = false

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

$file_class = 'SimplePie_File'

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

$force_fsockopen = false

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

$image_handler = ''

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

$output_encoding = 'UTF-8'

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

$remove_div = true

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

$replace_url_attributes

Initial value:

 array(
                'a' => 'href',
                'area' => 'href',
                'blockquote' => 'cite',
                'del' => 'cite',
                'form' => 'action',
                'img' => array('longdesc', 'src'),
                'input' => 'src',
                'ins' => 'cite',
                'q' => 'cite'
        )

Definition at line 14210 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 14198 of file simplepie.class.php.

$strip_comments = false

Definition at line 14199 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 14196 of file simplepie.class.php.

$timeout = 10

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

$useragent = ''

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

---

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

• C:/xampp/htdocs/moodle/lib/simplepie/simplepie.class.php