SimplePie
[ class tree: SimplePie ] [ index: SimplePie ] [ all elements ]

Class: SimplePie_Misc

Source Location: /simplepie.inc

Class Overview




Methods



Class Details

[line 8740]


[ Top ]


Class Methods


static method codepoint_to_utf8 [line 10835]

static string codepoint_to_utf8( int $codepoint)

Converts a unicode codepoint to a UTF-8 character



Tags:

return:  UTF-8 character
access:  public


Parameters:

int   $codepoint   Unicode codepoint

[ Top ]

static method entities_decode [line 10581]

static string entities_decode( string $data)

Decode HTML entities



Tags:

return:  Output data
access:  public


Parameters:

string   $data   Input data

[ Top ]

static method parse_str [line 10924]

static array parse_str( string $str)

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




Parameters:

string   $str   The input string.

[ Top ]

static method stripos [line 10887]

static bool stripos( object $haystack, string $needle, [int $offset = 0])

Re-implementation of PHP 5's stripos()

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




Tags:

return:  If needle is not found, stripos() will return boolean false.


Parameters:

object   $haystack  
string   $needle   Note that the needle may be a string of one or more characters. If needle is not a string, it is converted to an integer and applied as the ordinal value of a character.
int   $offset   The optional offset parameter allows you to specify which character in haystack to start searching. The position returned is still relative to the beginning of haystack.

[ Top ]

static method windows_1252_to_utf8 [line 9099]

static string windows_1252_to_utf8( string $string)

Converts a Windows-1252 encoded string to a UTF-8 encoded string



Tags:

return:  UTF-8 encoded string
access:  public


Parameters:

string   $string   Windows-1252 encoded string

[ Top ]

method absolutize_url [line 8770]

void absolutize_url( $relative, $base)



Parameters:

   $relative  
   $base  

[ Top ]

method array_unique [line 10785]

void array_unique( $array)



Parameters:

   $array  

[ Top ]

method atom_03_construct_type [line 10672]

void atom_03_construct_type( $attribs)



Parameters:

   $attribs  

[ Top ]

method atom_10_construct_type [line 10708]

void atom_10_construct_type( $attribs)



Parameters:

   $attribs  

[ Top ]

method atom_10_content_construct_type [line 10730]

void atom_10_content_construct_type( $attribs)



Parameters:

   $attribs  

[ Top ]

method change_encoding [line 9106]

void change_encoding( $data, $input, $output)



Parameters:

   $data  
   $input  
   $output  

[ Top ]

method compress_parse_url [line 9004]

void compress_parse_url( [ $scheme = ''], [ $authority = ''], [ $path = ''], [ $query = ''], [ $fragment = ''])



Parameters:

   $scheme  
   $authority  
   $path  
   $query  
   $fragment  

[ Top ]

method display_cached_file [line 8929]

void display_cached_file( str $identifier_url, [str $cache_location = './cache'], [str $cache_extension = 'spc'], [str $cache_class = 'SimplePie_Cache'], [str $cache_name_function = 'md5'])

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.




Tags:

see:  SimplePie::get_favicon()
access:  public


Parameters:

str   $identifier_url   URL that is used to identify the content. This may or may not be the actual URL of the live content.
str   $cache_location   Location of SimplePie's cache. Defaults to './cache'.
str   $cache_extension   The file extension that the file was cached with. Defaults to 'spc'.
str   $cache_class   Name of the cache-handling class being used in SimplePie. Defaults to 'SimplePie_Cache', and should be left as-is unless you've overloaded the class.
str   $cache_name_function   Obsolete. Exists for backwards compatibility reasons only.

[ Top ]

method element_implode [line 8867]

void element_implode( $element)



Parameters:

   $element  

[ Top ]

method encoding [line 9144]

void encoding( $charset)



Parameters:

   $charset  

[ Top ]

method error [line 8886]

void error( $message, $level, $file, $line)



Parameters:

   $message  
   $level  
   $file  
   $line  

[ Top ]

method fix_protocol [line 8951]

void fix_protocol( $url, [ $http = 1])



Parameters:

   $url  
   $http  

[ Top ]

method get_curl_version [line 10487]

void get_curl_version( )



[ Top ]

method get_element [line 8830]

void get_element( $realname, $string)



Parameters:

   $realname  
   $string  

[ Top ]

method htmlspecialchars_decode [line 10660]

void htmlspecialchars_decode( $string, $quote_style)



Parameters:

   $string  
   $quote_style  

[ Top ]

method is_isegment_nz_nc [line 10761]

void is_isegment_nz_nc( $string)



Parameters:

   $string  

[ Top ]

method is_subclass_of [line 10508]

void is_subclass_of( $class1, $class2)



Parameters:

   $class1  
   $class2  

[ Top ]

method normalize_url [line 9030]

void normalize_url( $url)



Parameters:

   $url  

[ Top ]

method parse_date [line 10567]

void parse_date( $dt)



Parameters:

   $dt  

[ Top ]

method parse_mime [line 10648]

void parse_mime( $mime)



Parameters:

   $mime  

[ Top ]

method parse_url [line 8983]

void parse_url( $url)



Parameters:

   $url  

[ Top ]

method percent_encoding_normalization [line 9043]

void percent_encoding_normalization( $match)



Parameters:

   $match  

[ Top ]

method remove_dot_segments [line 8776]

void remove_dot_segments( $input)



Parameters:

   $input  

[ Top ]

method space_seperated_tokens [line 10766]

void space_seperated_tokens( $string)



Parameters:

   $string  

[ Top ]

method strip_comments [line 10549]

string strip_comments( string $data)

Strip HTML comments



Tags:

return:  Comment stripped string
access:  public


Parameters:

string   $data   Data to strip comments from

[ Top ]

method time_hms [line 8742]

void time_hms( $seconds)



Parameters:

   $seconds  

[ Top ]

method uncomment_rfc822 [line 10594]

string uncomment_rfc822( $string, string $data)

Remove RFC822 comments



Tags:

return:  Comment stripped string
access:  public


Parameters:

string   $data   Data to strip comments from
   $string  

[ Top ]

method utf8_bad_replace [line 9067]

string utf8_bad_replace( string $str)

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)




Tags:

return:  UTF-8 string
see:  http://www.w3.org/International/questions/qa-forms-utf-8
author:  Geoffrey Sneddon


Parameters:

string   $str   String to remove bad UTF-8 bytes from

[ Top ]

method xml_encoding [line 10952]

array xml_encoding( string $data)

Detect XML encoding, as per XML 1.0 Appendix F.1



Tags:

return:  Possible encodings
todo:  Add support for EBCDIC


Parameters:

string   $data   XML data

[ Top ]


Documentation generated on Fri, 06 Jun 2008 10:22:12 -0700 by phpDocumentor 1.3.1