Class SimplePie_IRI

IRI parser/serialiser/normaliser

Package: SimplePie\HTTP
Copyright: 2007-2012 Geoffrey Sneddon, Steve Minutillo, Ryan McCue
License: http://www.opensource.org/licenses/bsd-license.php
Author: Geoffrey Sneddon
Author: Steve Minutillo
Author: Ryan McCue
Located at vendor/simplepie/simplepie/library/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`	# `__set( string $name, mixed $value )` Overload __set() to provide access via properties Overload __set() to provide access via properties Parameters `$name` `string` - $name Property name `$value` `mixed` - $value Property value
`public mixed`	# `__get( string $name )` Overload __get() to provide access via properties Overload __get() to provide access via properties Parameters `$name` `string` - $name Property name Returns `mixed`
`public boolean`	# `__isset( string $name )` Overload __isset() to provide access via properties Overload __isset() to provide access via properties Parameters `$name` `string` - $name Property name Returns `boolean`
`public`	# `__unset( string $name )` Overload __unset() to provide access via properties Overload __unset() to provide access via properties Parameters `$name` `string` - $name Property name
`public`	# `__construct( string $iri = null )` Create a new IRI object, from a specified string Create a new IRI object, from a specified string Parameters `$iri` `string` - $iri
`public static IRI\|false`	# `absolutize( IRI\|string $base, IRI\|string $relative )` Create a new IRI object by resolving a relative IRI Create a new IRI object by resolving a relative IRI Returns false if $base is not absolute, otherwise an IRI. Parameters `$base` `IRI\|string` - $base (Absolute) Base IRI `$relative` `IRI\|string` - $relative Relative IRI Returns `IRI\|false`
`protected 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` - $iri Returns `array`
`protected string`	# `remove_dot_segments( string $input )` Remove dot segments from a path Remove dot segments from a path Parameters `$input` `string` - $input Returns `string`
`protected string`	# `replace_invalid_with_pct_encoding( string $string, string $extra_chars, boolean $iprivate = false )` Replace invalid character with percent encoding Replace invalid character with percent encoding Parameters `$string` `string` - $string Input string `$extra_chars` `string` - $extra_chars Valid characters not in iunreserved or iprivate (this is ASCII-only) `$iprivate` `boolean` - $iprivate 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` - $match PCRE match Returns `string` - Replacement
`protected`	# `scheme_normalization( )`
`public boolean`	# `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. 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. Returns `boolean`
`public boolean`	# `set_iri( string $iri )` Set the entire IRI. Returns true on success, false on failure (if there are any invalid characters). Set the entire IRI. Returns true on success, false on failure (if there are any invalid characters). Parameters `$iri` `string` - $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` - $scheme 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` - $authority Returns `boolean`
`public boolean`	# `set_userinfo( string $iuserinfo )` Set the iuserinfo. Set the iuserinfo. Parameters `$iuserinfo` `string` - $iuserinfo Returns `boolean`
`public boolean`	# `set_host( string $ihost )` Set the ihost. Returns true on success, false on failure (if there are any invalid characters). Set the ihost. Returns true on success, false on failure (if there are any invalid characters). Parameters `$ihost` `string` - $ihost 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` - $port Returns `boolean`
`public boolean`	# `set_path( string $ipath )` Set the ipath. Set the ipath. Parameters `$ipath` `string` - $ipath Returns `boolean`
`public boolean`	# `set_query( string $iquery )` Set the iquery. Set the iquery. Parameters `$iquery` `string` - $iquery Returns `boolean`
`public boolean`	# `set_fragment( string $ifragment )` Set the ifragment. Set the ifragment. Parameters `$ifragment` `string` - $ifragment Returns `boolean`
`public string`	# `to_uri( mixed $string )` Convert an IRI to a URI (or parts thereof) Convert an IRI to a URI (or parts thereof) Returns `string`
`public string`	# `get_iri( )` Get the complete IRI Get the complete IRI Returns `string`
`public string`	# `get_uri( )` Get the complete URI Get the complete URI Returns `string`
`protected string`	# `get_iauthority( )` Get the complete iauthority Get the complete iauthority Returns `string`
`protected string`	# `get_authority( )` Get the complete authority Get the complete authority Returns `string`

Magic methods summary

Properties summary

`protected string`	`$scheme`	# Scheme Scheme
`protected string`	`$iuserinfo`	# User Information User Information
`protected string`	`$ihost`	# ihost ihost
`protected string`	`$port`	# Port Port
`protected string`	`$ipath`	# ipath ipath
`protected string`	`$iquery`	# iquery iquery
`protected string`	`$ifragment`	# ifragment ifragment
`protected array`	`$normalization`	# Normalization database Normalization database Each key is the scheme, each value is an array with each key as the IRI part and value as the default value for that part.

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class SimplePie_IRI

Methods summary

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Magic methods summary

Properties summary