PHP Class SimplePie_IRI, ojs

Datei anzeigen Open project: pkp/ojs Class Usage Examples

Public Properties

Property Type Description
$fragment string Fragment
$host string Host
$path string Path
$port string Port
$query string Query
$scheme string Scheme
$userinfo string User Information
$valid array Whether the object represents a valid IRI

Public Methods

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

Method Details

SimplePie_IRI() public method

Create a new IRI object, from a specified string
public SimplePie_IRI ( string $iri ) : SimplePie_IRI
$iri string
return SimplePie_IRI

__toString() public method

Return the entire IRI when you try and read the object as a string
public __toString ( ) : string
return string

absolutize() public method

Create a new IRI object by resolving a relative IRI
public absolutize ( SimplePie_IRI $base, string $relative ) : SimplePie_IRI
$base SimplePie_IRI Base IRI
$relative string Relative IRI
return SimplePie_IRI

get_authority() public method

Get the complete authority
public get_authority ( ) : string
return string

get_fragment() public method

Get the fragment
public get_fragment ( ) : string
return string

get_host() public method

Get the host
public get_host ( ) : string
return string

get_iri() public method

Get the complete IRI
public get_iri ( ) : string
return string

get_path() public method

Get the path
public get_path ( ) : string
return string

get_port() public method

Get the port
public get_port ( ) : string
return string

get_query() public method

Get the query
public get_query ( ) : string
return string

get_scheme() public method

Get the scheme
public get_scheme ( ) : string
return string

get_userinfo() public method

Get the user information
public get_userinfo ( ) : string
return string

is_valid() public method

Check if the object represents a valid IRI
public is_valid ( ) : boolean
return boolean

parse_iri() public method

Parse an IRI into scheme/authority/path/query/fragment segments
public parse_iri ( string $iri ) : array
$iri string
return array

remove_dot_segments() public method

Remove dot segments from a path
public remove_dot_segments ( string $input ) : string
$input string
return string

replace_invalid_with_pct_encoding() public method

Replace invalid character with percent encoding
public replace_invalid_with_pct_encoding ( string $string, string $valid_chars, integer $case = SIMPLEPIE_SAME_CASE ) : string
$string string Input string
$valid_chars string Valid characters
$case integer Normalise case
return string

set_authority() public method

Set the authority. Returns true on success, false on failure (if there are any invalid characters).
public set_authority ( string $authority ) : boolean
$authority string
return boolean

set_fragment() public method

Set the fragment.
public set_fragment ( string $fragment ) : boolean
$fragment string
return boolean

set_host() public method

Set the host. Returns true on success, false on failure (if there are any invalid characters).
public set_host ( string $host ) : boolean
$host string
return boolean

set_path() public method

Set the path.
public set_path ( string $path ) : boolean
$path string
return boolean

set_port() public method

Set the port. Returns true on success, false on failure (if there are any invalid characters).
public set_port ( string $port ) : boolean
$port string
return boolean

set_query() public method

Set the query.
public set_query ( string $query ) : boolean
$query string
return boolean

set_scheme() public method

Set the scheme. Returns true on success, false on failure (if there are any invalid characters).
public set_scheme ( string $scheme ) : boolean
$scheme string
return boolean

set_userinfo() public method

Set the userinfo.
public set_userinfo ( string $userinfo ) : boolean
$userinfo string
return boolean

Property Details

$fragment public_oe property

Fragment
public string $fragment
return string

$host public_oe property

Host
public string $host
return string

$path public_oe property

Path
public string $path
return string

$port public_oe property

Port
public string $port
return string

$query public_oe property

Query
public string $query
return string

$scheme public_oe property

Scheme
public string $scheme
return string

$userinfo public_oe property

User Information
public string $userinfo
return string

$valid public_oe property

Whether the object represents a valid IRI
public array $valid
return array