[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/Requests/ -> Iri.php (summary)

IRI parser/serialiser/normaliser

File Size: 1101 lines (29 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Iri:: (27 methods):
  __toString()
  __set()
  __get()
  __isset()
  __unset()
  __construct()
  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: Iri  - X-Ref

IRI parser/serialiser/normaliser

Copyright (c) 2007-2010, Geoffrey Sneddon and Steve Minutillo.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name of the SimplePie Team nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

__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

param: string $name Property name
return: mixed

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

param: string $name Property name
return: bool

__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|Stringable|null $iri

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.

param: \WpOrg\Requests\Iri|string $base (Absolute) Base IRI
param: \WpOrg\Requests\Iri|string $relative Relative IRI
return: \WpOrg\Requests\Iri|false

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

param: string $iri
return: array

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

param: string $input
return: string

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

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

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

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

param: array $regex_match PCRE match
return: string Replacement

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)   X-Ref
Set the entire IRI. Returns true on success, false on failure (if there
are any invalid characters).

param: string $iri
return: bool

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

param: string $scheme
return: bool

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

param: string $authority
return: bool

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

param: string $iuserinfo
return: bool

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

param: string $ihost
return: bool

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

param: string $port
return: bool

set_path($ipath)   X-Ref
Set the ipath.

param: string $ipath
return: bool

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

param: string $iquery
return: bool

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

param: string $ifragment
return: bool

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

param: string|bool $iri IRI to convert (or false from {@see \WpOrg\Requests\IRI::get_iri()})
return: string|false URI if IRI is valid, false otherwise.

get_iri()   X-Ref
Get the complete IRI

return: string|false

get_uri()   X-Ref
Get the complete URI

return: string

get_iauthority()   X-Ref
Get the complete iauthority

return: string|null

get_authority()   X-Ref
Get the complete authority

return: string



Generated: Mon Dec 6 01:00:03 2021 Cross-referenced by PHPXref 0.7.1