Overview

Packages

  • None
  • SimplePie

Classes

  • SimplePie
  • SimplePie_Author
  • SimplePie_Autoloader
  • SimplePie_Cache
  • SimplePie_Cache_DB
  • SimplePie_Cache_File
  • SimplePie_Cache_Memcache
  • SimplePie_Cache_MySQL
  • SimplePie_Caption
  • SimplePie_Category
  • SimplePie_Content_Type_Sniffer
  • SimplePie_Copyright
  • SimplePie_Core
  • SimplePie_Credit
  • SimplePie_Decode_HTML_Entities
  • SimplePie_Enclosure
  • SimplePie_File
  • SimplePie_gzdecode
  • SimplePie_HTTP_Parser
  • SimplePie_IRI
  • SimplePie_Item
  • SimplePie_Locator
  • SimplePie_Misc
  • SimplePie_Net_IPv6
  • SimplePie_Parse_Date
  • SimplePie_Parser
  • SimplePie_Rating
  • SimplePie_Registry
  • SimplePie_Restriction
  • SimplePie_Sanitize
  • SimplePie_Source
  • SimplePie_XML_Declaration_Parser

Interfaces

  • SimplePie_Cache_Base
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class SimplePie_IRI

IRI parser/serialiser

Package: SimplePie
Located at SimplePie/IRI.php
Methods summary
public string
# __toString( )

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

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

Returns

string
public SimplePie_IRI
# __construct( string $iri )

Create a new IRI object, from a specified string

Create a new IRI object, from a specified string

Parameters

$iri
string

Returns

SimplePie_IRI
public static SimplePie_IRI
# absolutize( SimplePie_IRI $base, string $relative )

Create a new IRI object by resolving a relative IRI

Create a new IRI object by resolving a relative IRI

Parameters

$base
SimplePie_IRI
Base IRI
$relative
string
Relative IRI

Returns

SimplePie_IRI
public array
# parse_iri( string $iri )

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

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

Parameters

$iri
string

Returns

array
public string
# remove_dot_segments( string $input )

Remove dot segments from a path

Remove dot segments from a path

Parameters

$input
string

Returns

string
protected string
# replace_invalid_with_pct_encoding( string $string, string $valid_chars, integer $case = SIMPLEPIE_SAME_CASE, boolean $iprivate = false )

Replace invalid character with percent encoding

Replace invalid character with percent encoding

Parameters

$string
string
Input string
$valid_chars
string
Valid characters not in iunreserved or iprivate (this is ASCII-only)
$case
integer
Normalise case
$iprivate
boolean
Allow iprivate

Returns

string
protected string
# remove_iunreserved_percent_encoded( array $match )

Callback function for preg_replace_callback.

Callback function for preg_replace_callback.

Removes sequences of percent encoded bytes that represent UTF-8 encoded characters in iunreserved

Parameters

$match
array
PCRE match

Returns

string
Replacement
public boolean
# is_valid( )

Check if the object represents a valid IRI

Check if the object represents a valid IRI

Returns

boolean
public boolean
# set_scheme( string $scheme )

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

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

Parameters

$scheme
string

Returns

boolean
public boolean
# set_authority( string $authority )

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

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

Parameters

$authority
string

Returns

boolean
public boolean
# set_userinfo( string $userinfo )

Set the userinfo.

Set the userinfo.

Parameters

$userinfo
string

Returns

boolean
public boolean
# set_host( string $host )

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

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

Parameters

$host
string

Returns

boolean
public boolean
# set_port( string $port )

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

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

Parameters

$port
string

Returns

boolean
public boolean
# set_path( string $path )

Set the path.

Set the path.

Parameters

$path
string

Returns

boolean
public boolean
# set_query( string $query )

Set the query.

Set the query.

Parameters

$query
string

Returns

boolean
public boolean
# set_fragment( string $fragment )

Set the fragment.

Set the fragment.

Parameters

$fragment
string

Returns

boolean
public string
# get_iri( )

Get the complete IRI

Get the complete IRI

Returns

string
public string
# get_scheme( )

Get the scheme

Get the scheme

Returns

string
public string
# get_authority( )

Get the complete authority

Get the complete authority

Returns

string
public string
# get_userinfo( )

Get the user information

Get the user information

Returns

string
public string
# get_host( )

Get the host

Get the host

Returns

string
public string
# get_port( )

Get the port

Get the port

Returns

string
public string
# get_path( )

Get the path

Get the path

Returns

string
public string
# get_query( )

Get the query

Get the query

Returns

string
public string
# get_fragment( )

Get the fragment

Get the fragment

Returns

string
Properties summary
public string $scheme
#

Scheme

Scheme

public string $userinfo
#

User Information

User Information

public string $host
#

Host

Host

public string $port
#

Port

Port

public string $path
#

Path

Path

public string $query
#

Query

Query

public string $fragment
#

Fragment

Fragment

public array $valid array()
#

Whether the object represents a valid IRI

Whether the object represents a valid IRI

SimplePie Documentation API documentation generated by ApiGen 2.4.0