Inheritances
Files
Overview
FRAMES
NO FRAMES

Class SimplePie_IRI

SimplePie
|- class SimplePie_IRI
IRI parser/serialiser
PackageSimplePie

Summary

Instance fields
+ $fragment Fragment
+ $host Host
+ $path Path
+ $port Port
+ $query Query
+ $scheme Scheme
+ $userinfo User Information
+ $valid Whether the object represents a valid IRI
Instance methods
+ SimplePie_IRI() Create a new IRI object, from a specified string
+ __toString() Return the entire IRI when you try and read the object as a string
+ absolutize() Create a new IRI object by resolving a relative IRI
+ get_authority() Get the complete authority
+ get_fragment() Get the fragment
+ get_host() Get the host
+ get_iri() Get the complete IRI
+ get_path() Get the path
+ get_port() Get the port
+ get_query() Get the query
+ get_scheme() Get the scheme
+ get_userinfo() Get the user information
+ is_valid() Check if the object represents a valid IRI
+ parse_iri() Parse an IRI into scheme/authority/path/query/fragment segments
+ remove_dot_segments() Remove dot segments from a path
+ replace_invalid_with_pct_encoding() Replace invalid character with percent encoding
+ set_authority() Set the authority
+ set_fragment() Set the fragment
+ set_host() Set the host
+ set_path() Set the path
+ set_port() Set the port
+ set_query() Set the query
+ set_scheme() Set the scheme
+ set_userinfo() Set the userinfo

Details

Instance fields

$fragment
var $fragment
Fragment
Access private
Var string
$host
var $host
Host
Access private
Var string
$path
var $path
Path
Access private
Var string
$port
var $port
Port
Access private
Var string
$query
var $query
Query
Access private
Var string
$scheme
var $scheme
Scheme
Access private
Var string
$userinfo
var $userinfo
User Information
Access private
Var string
$valid
var $valid = array()
Whether the object represents a valid IRI
Access private
Var array

Instance methods

SimplePie_IRI()
function SimplePie_IRI( $iri)
Create a new IRI object, from a specified string
Parameters
string $iri
Access public
__toString()
function __toString( )
Return the entire IRI when you try and read the object as a string
Returns string
Access public
absolutize()
function absolutize( $base
$relative
)
Create a new IRI object by resolving a relative IRI
Parameters
SimplePie_IRI $base Base IRI
string $relative Relative IRI
Static
Access public
function get_authority( )
Get the complete authority
Returns string
Access public
function get_fragment( )
Get the fragment
Returns string
Access public
function get_host( )
Get the host
Returns string
Access public
function get_iri( )
Get the complete IRI
Returns string
Access public
function get_path( )
Get the path
Returns string
Access public
function get_port( )
Get the port
Returns string
Access public
function get_query( )
Get the query
Returns string
Access public
function get_scheme( )
Get the scheme
Returns string
Access public
function get_userinfo( )
Get the user information
Returns string
Access public
function is_valid( )
Check if the object represents a valid IRI
Returns bool
Access public
function parse_iri( $iri)
Parse an IRI into scheme/authority/path/query/fragment segments
Parameters
string $iri
Returns array
Access private
function remove_dot_segments( $input)
Remove dot segments from a path
Parameters
string $input
Returns string
Access private
function replace_invalid_with_pct_encoding( $string
$valid_chars
$case = SIMPLEPIE_SAME_CASE
)
Replace invalid character with percent encoding
Parameters
string $string Input string
string $valid_chars Valid characters
int $case Normalise case
Returns string
Access private
function set_authority( $authority)
Set the authority. Returns true on success, false on failure (if there are
any invalid characters).
Parameters
string $authority
Returns bool
Access public
function set_fragment( $fragment)
Set the fragment.
Parameters
string $fragment
Returns bool
Access public
function set_host( $host)
Set the host. Returns true on success, false on failure (if there are
any invalid characters).
Parameters
string $host
Returns bool
Access public
function set_path( $path)
Set the path.
Parameters
string $path
Returns bool
Access public
function set_port( $port)
Set the port. Returns true on success, false on failure (if there are
any invalid characters).
Parameters
string $port
Returns bool
Access public
function set_query( $query)
Set the query.
Parameters
string $query
Returns bool
Access public
function set_scheme( $scheme)
Set the scheme. Returns true on success, false on failure (if there are
any invalid characters).
Parameters
string $scheme
Returns bool
Access public
function set_userinfo( $userinfo)
Set the userinfo.
Parameters
string $userinfo
Returns bool
Access public