Documentation

SimplePie_IRI
in package

Table of Contents

Properties

$ifragment  : mixed
$ihost  : mixed
$ipath  : mixed
$iquery  : mixed
$iuserinfo  : mixed
$normalization  : mixed
$port  : mixed
$scheme  : mixed

Methods

__construct()  : mixed
Create a new IRI object, from a specified string
__destruct()  : mixed
Clean up
__get()  : mixed
__isset()  : bool
Overload __isset() to provide access via properties
__set()  : mixed
__toString()  : mixed
__unset()  : mixed
Overload __unset() to provide access via properties
absolutize()  : IRI|false
Create a new IRI object by resolving a relative IRI
get_iri()  : string
Get the complete IRI
get_uri()  : string
Get the complete URI
is_valid()  : bool
Check if the object represents a valid IRI. This needs to be done on each call as some things change depending on another part of the IRI.
set_authority()  : bool
Set the authority. Returns true on success, false on failure (if there are any invalid characters).
set_fragment()  : bool
Set the ifragment.
set_host()  : bool
Set the ihost. Returns true on success, false on failure (if there are any invalid characters).
set_iri()  : bool
Set the entire IRI. Returns true on success, false on failure (if there are any invalid characters).
set_path()  : bool
Set the ipath.
set_port()  : bool
Set the port. Returns true on success, false on failure (if there are any invalid characters).
set_query()  : bool
Set the iquery.
set_scheme()  : bool
Set the scheme. Returns true on success, false on failure (if there are any invalid characters).
set_userinfo()  : bool
Set the iuserinfo.
to_uri()  : string
Convert an IRI to a URI (or parts thereof)
get_authority()  : string
Get the complete authority
get_iauthority()  : string
Get the complete iauthority
parse_iri()  : array<string|int, mixed>
Parse an IRI into scheme/authority/path/query/fragment segments
remove_dot_segments()  : string
Remove dot segments from a path
remove_iunreserved_percent_encoded()  : string
Callback function for preg_replace_callback.
replace_invalid_with_pct_encoding()  : string
Replace invalid character with percent encoding
scheme_normalization()  : mixed

Properties

$ifragment

protected mixed $ifragment = \null

$ihost

protected mixed $ihost = \null

$ipath

protected mixed $ipath = ''

$iquery

protected mixed $iquery = \null

$iuserinfo

protected mixed $iuserinfo = \null

$normalization

protected mixed $normalization = array('acap' => array('port' => 674), 'dict' => array('port' => 2628), 'file' => array('ihost' => 'localhost'), 'http' => array('port' => 80, 'ipath' => '/'), 'https' => array('port' => 443, 'ipath' => '/'))

$port

protected mixed $port = \null

$scheme

protected mixed $scheme = \null

Methods

__construct()

Create a new IRI object, from a specified string

public __construct([string $iri = null ]) : mixed
Parameters
$iri : string = null

__destruct()

Clean up

public __destruct() : mixed

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed

__isset()

Overload __isset() to provide access via properties

public __isset(string $name) : bool
Parameters
$name : string

Property name

Return values
bool

__set()

public __set(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed

__toString()

public __toString() : mixed

__unset()

Overload __unset() to provide access via properties

public __unset(string $name) : mixed
Parameters
$name : string

Property name

absolutize()

Create a new IRI object by resolving a relative IRI

public static absolutize(IRI|string $base, IRI|string $relative) : IRI|false

Returns false if $base is not absolute, otherwise an IRI.

Parameters
$base : IRI|string

(Absolute) Base IRI

$relative : IRI|string

Relative IRI

Return values
IRI|false

get_iri()

Get the complete IRI

public get_iri() : string
Return values
string

get_uri()

Get the complete URI

public get_uri() : string
Return values
string

is_valid()

Check if the object represents a valid IRI. This needs to be done on each call as some things change depending on another part of the IRI.

public is_valid() : bool
Return values
bool

set_authority()

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

public set_authority(string $authority[, mixed $clear_cache = false ]) : bool
Parameters
$authority : string
$clear_cache : mixed = false
Return values
bool

set_fragment()

Set the ifragment.

public set_fragment(string $ifragment) : bool
Parameters
$ifragment : string
Return values
bool

set_host()

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

public set_host(string $ihost) : bool
Parameters
$ihost : string
Return values
bool

set_iri()

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

public set_iri(string $iri[, mixed $clear_cache = false ]) : bool
Parameters
$iri : string
$clear_cache : mixed = false
Return values
bool

set_path()

Set the ipath.

public set_path(string $ipath[, mixed $clear_cache = false ]) : bool
Parameters
$ipath : string
$clear_cache : mixed = false
Return values
bool

set_port()

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

public set_port(string $port) : bool
Parameters
$port : string
Return values
bool

set_query()

Set the iquery.

public set_query(string $iquery) : bool
Parameters
$iquery : string
Return values
bool

set_scheme()

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

public set_scheme(string $scheme) : bool
Parameters
$scheme : string
Return values
bool

set_userinfo()

Set the iuserinfo.

public set_userinfo(string $iuserinfo) : bool
Parameters
$iuserinfo : string
Return values
bool

to_uri()

Convert an IRI to a URI (or parts thereof)

public to_uri(mixed $string) : string
Parameters
$string : mixed
Return values
string

get_authority()

Get the complete authority

protected get_authority() : string
Return values
string

get_iauthority()

Get the complete iauthority

protected get_iauthority() : string
Return values
string

parse_iri()

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

protected parse_iri(string $iri) : array<string|int, mixed>
Parameters
$iri : string
Return values
array<string|int, mixed>

remove_dot_segments()

Remove dot segments from a path

protected remove_dot_segments(string $input) : string
Parameters
$input : string
Return values
string

remove_iunreserved_percent_encoded()

Callback function for preg_replace_callback.

protected remove_iunreserved_percent_encoded(array<string|int, mixed> $match) : string

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

Parameters
$match : array<string|int, mixed>

PCRE match

Return values
string —

Replacement

replace_invalid_with_pct_encoding()

Replace invalid character with percent encoding

protected replace_invalid_with_pct_encoding(string $string, string $extra_chars[, bool $iprivate = false ]) : string
Parameters
$string : string

Input string

$extra_chars : string

Valid characters not in iunreserved or iprivate (this is ASCII-only)

$iprivate : bool = false

Allow iprivate

Return values
string

scheme_normalization()

protected scheme_normalization() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results