Class SimplePie_IRI

Description

IRI parser/serialiser

Located in /libraries/simplepie/simplepie.php (line 11573)


	
			
Variable Summary
string $fragment
string $host
string $path
string $port
string $query
string $scheme
string $userinfo
array $valid
Method Summary
static SimplePie_IRI absolutize (SimplePie_IRI $base, string $relative)
SimplePie_IRI SimplePie_IRI (string $iri)
string get_authority ()
string get_fragment ()
string get_host ()
string get_iri ()
string get_path ()
string get_port ()
string get_query ()
string get_scheme ()
string get_userinfo ()
bool is_valid ()
array parse_iri (string $iri)
string remove_dot_segments (string $input)
string replace_invalid_with_pct_encoding (string $string, string $valid_chars, [int $case = SIMPLEPIE_SAME_CASE])
bool set_authority (string $authority)
bool set_fragment (string $fragment)
bool set_host (string $host)
bool set_path (string $path)
bool set_port (string $port)
bool set_query (string $query)
bool set_scheme (string $scheme)
bool set_userinfo (string $userinfo)
string __toString ()
Variables
string $fragment (line 11629)

Fragment

  • access: private
string $host (line 11597)

Host

  • access: private
string $path (line 11613)

Path

  • access: private
string $port (line 11605)

Port

  • access: private
string $query (line 11621)

Query

  • access: private
string $scheme (line 11581)

Scheme

  • access: private
string $userinfo (line 11589)

User Information

  • access: private
array $valid = array() (line 11637)

Whether the object represents a valid IRI

  • access: private
Methods
static method absolutize (line 11680)

Create a new IRI object by resolving a relative IRI

  • access: public
static SimplePie_IRI absolutize (SimplePie_IRI $base, string $relative)
Constructor SimplePie_IRI (line 11657)

Create a new IRI object, from a specified string

  • access: public
SimplePie_IRI SimplePie_IRI (string $iri)
  • string $iri
get_authority (line 12216)

Get the complete authority

  • access: public
string get_authority ()
get_fragment (line 12303)

Get the fragment

  • access: public
string get_fragment ()
get_host (line 12259)

Get the host

  • access: public
string get_host ()
get_iri (line 12165)

Get the complete IRI

  • access: public
string get_iri ()
get_path (line 12281)

Get the path

  • access: public
string get_path ()
get_port (line 12270)

Get the port

  • access: public
string get_port ()
get_query (line 12292)

Get the query

  • access: public
string get_query ()
get_scheme (line 12205)

Get the scheme

  • access: public
string get_scheme ()
get_userinfo (line 12248)

Get the user information

  • access: public
string get_userinfo ()
is_valid (line 11915)

Check if the object represents a valid IRI

  • access: public
bool is_valid ()
parse_iri (line 11759)

Parse an IRI into scheme/authority/path/query/fragment segments

  • access: private
array parse_iri (string $iri)
  • string $iri
remove_dot_segments (line 11776)

Remove dot segments from a path

  • access: private
string remove_dot_segments (string $input)
  • string $input
replace_invalid_with_pct_encoding (line 11839)

Replace invalid character with percent encoding

  • access: private
string replace_invalid_with_pct_encoding (string $string, string $valid_chars, [int $case = SIMPLEPIE_SAME_CASE])
  • string $string: Input string
  • string $valid_chars: Valid characters
  • int $case: Normalise case
set_authority (line 11969)

Set the authority. Returns true on success, false on failure (if there are any invalid characters).

  • access: public
bool set_authority (string $authority)
  • string $authority
set_fragment (line 12145)

Set the fragment.

  • access: public
bool set_fragment (string $fragment)
  • string $fragment
set_host (line 12023)

Set the host. Returns true on success, false on failure (if there are any invalid characters).

  • access: public
bool set_host (string $host)
  • string $host
set_path (line 12091)

Set the path.

  • access: public
bool set_path (string $path)
  • string $path
set_port (line 12062)

Set the port. Returns true on success, false on failure (if there are any invalid characters).

  • access: public
bool set_port (string $port)
  • string $port
set_query (line 12124)

Set the query.

  • access: public
bool set_query (string $query)
  • string $query
set_scheme (line 11928)

Set the scheme. Returns true on success, false on failure (if there are any invalid characters).

  • access: public
bool set_scheme (string $scheme)
  • string $scheme
set_userinfo (line 12001)

Set the userinfo.

  • access: public
bool set_userinfo (string $userinfo)
  • string $userinfo
__toString (line 11645)

Return the entire IRI when you try and read the object as a string

  • access: public
string __toString ()

Documentation generated on Mon, 25 Jun 2012 13:59:35 -0500 by phpDocumentor 1.4.4