[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/vendor/simplepie/simplepie/library/SimplePie/ -> IRI.php (summary)

SimplePie A PHP-Based RSS and Atom Feed Framework. Takes the hard work out of managing a complete RSS/Atom solution.

Author: Ryan Parman
Author: Geoffrey Sneddon
Author: Ryan McCue
Copyright: 2004-2016 Ryan Parman, Geoffrey Sneddon, Ryan McCue
License: http://www.opensource.org/licenses/bsd-license.php BSD License
Link: http://simplepie.org/ SimplePie
File Size: 1236 lines (29 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

SimplePie_IRI:: (28 methods):
  __toString()
  __set()
  __get()
  __isset()
  __unset()
  __construct()
  __destruct()
  absolutize()
  parse_iri()
  remove_dot_segments()
  replace_invalid_with_pct_encoding()
  remove_iunreserved_percent_encoded()
  scheme_normalization()
  is_valid()
  set_iri()
  set_scheme()
  set_authority()
  set_userinfo()
  set_host()
  set_port()
  set_path()
  set_query()
  set_fragment()
  to_uri()
  get_iri()
  get_uri()
  get_iauthority()
  get_authority()


Class: SimplePie_IRI  - X-Ref

IRI parser/serialiser/normaliser

__toString()   X-Ref
Return the entire IRI when you try and read the object as a string

return: string

__set($name, $value)   X-Ref
Overload __set() to provide access via properties

param: string $name Property name
param: mixed $value Property value

__get($name)   X-Ref
Overload __get() to provide access via properties

return: mixed
param: string $name Property name

__isset($name)   X-Ref
Overload __isset() to provide access via properties

return: bool
param: string $name Property name

__unset($name)   X-Ref
Overload __unset() to provide access via properties

param: string $name Property name

__construct($iri = null)   X-Ref
Create a new IRI object, from a specified string

param: string $iri

__destruct()   X-Ref
Clean up


absolutize($base, $relative)   X-Ref
Create a new IRI object by resolving a relative IRI

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

return: IRI|false
param: IRI|string $base (Absolute) Base IRI
param: IRI|string $relative Relative IRI

parse_iri($iri)   X-Ref
Parse an IRI into scheme/authority/path/query/fragment segments

return: array
param: string $iri

remove_dot_segments($input)   X-Ref
Remove dot segments from a path

return: string
param: string $input

replace_invalid_with_pct_encoding($string, $extra_chars, $iprivate = false)   X-Ref
Replace invalid character with percent encoding

return: string
param: string $string Input string
param: string $extra_chars Valid characters not in iunreserved or
param: bool $iprivate Allow iprivate

remove_iunreserved_percent_encoded($match)   X-Ref
Callback function for preg_replace_callback.

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

return: string Replacement
param: array $match PCRE match

scheme_normalization()   X-Ref
No description

is_valid()   X-Ref
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.

return: bool

set_iri($iri, $clear_cache = false)   X-Ref
Set the entire IRI. Returns true on success, false on failure (if there
are any invalid characters).

return: bool
param: string $iri

set_scheme($scheme)   X-Ref
Set the scheme. Returns true on success, false on failure (if there are
any invalid characters).

return: bool
param: string $scheme

set_authority($authority, $clear_cache = false)   X-Ref
Set the authority. Returns true on success, false on failure (if there are
any invalid characters).

return: bool
param: string $authority

set_userinfo($iuserinfo)   X-Ref
Set the iuserinfo.

return: bool
param: string $iuserinfo

set_host($ihost)   X-Ref
Set the ihost. Returns true on success, false on failure (if there are
any invalid characters).

return: bool
param: string $ihost

set_port($port)   X-Ref
Set the port. Returns true on success, false on failure (if there are
any invalid characters).

return: bool
param: string $port

set_path($ipath, $clear_cache = false)   X-Ref
Set the ipath.

return: bool
param: string $ipath

set_query($iquery)   X-Ref
Set the iquery.

return: bool
param: string $iquery

set_fragment($ifragment)   X-Ref
Set the ifragment.

return: bool
param: string $ifragment

to_uri($string)   X-Ref
Convert an IRI to a URI (or parts thereof)

return: string

get_iri()   X-Ref
Get the complete IRI

return: string

get_uri()   X-Ref
Get the complete URI

return: string

get_iauthority()   X-Ref
Get the complete iauthority

return: string

get_authority()   X-Ref
Get the complete authority

return: string