Documentation

Uri

in package

• Grav
• Common

Class Uri

Table of Contents

Constants

HOSTNAME_REGEX  = '/^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$/'

Properties

$url  : string

$base  : string

$basename  : string|null

$content_path  : string

$currentRoute  : Route|null

$currentUri  : Uri|null

$env  : string

$extension  : string|null

$fragment  : string|null

$host  : string|null

$params  : array<string|int, mixed>

$password  : string|null

$path  : string

$paths  : array<string|int, mixed>

$port  : int|null

$post  : array<string|int, mixed>

$queries  : array<string|int, mixed>

$query  : string

$root  : string

$root_path  : string

$scheme  : string|null

$setup_base  : string

$uri  : string

$user  : string|null

Methods

__construct()  : mixed

Uri constructor.

__toString()  : string

addNonce()  : string

Adds the nonce to a URL for a specific action

base()  : string

Return the base of the URI

baseIncludingLanguage()  : string

Return the base relative URL including the language prefix or the base relative url if multi-language is not enabled

basename()  : string

Return the basename of the URI

buildParams()  : string

buildUrl()  : string

The opposite of built-in PHP method parse_url()

cleanPath()  : string

Removes extra double slashes and fixes back-slashes

convertUrl()  : string|array<string|int, mixed>

Converts links from absolute '/' or relative (../..) to a Grav friendly format

convertUrlOld()  : string

Converts links from absolute '/' or relative (../..) to a Grav friendly format

currentPage()  : int

Return current page number.

environment()  : string

Gets the environment name

extension()  : string|null

Return the Extension of the URI

extractParams()  : array<string|int, mixed>

filterPath()  : string

Filter Uri path.

filterQuery()  : string

Filters the query string or fragment of a URI.

filterUserInfo()  : string

Filters the user info string.

fragment()  : string|null

Gets the Fragment portion of a URI (eg #target)

getAllHeaders()  : mixed

Compatibility in case getallheaders() is not available on platform

getContentType()  : null|string

Get content type from request

getCurrentRoute()  : Route

Returns current route.

getCurrentUri()  : Uri

Returns current Uri.

host()  : string|null

Return the host of the URI

init()  : void

Initializes the URI object based on the url set on the object

initializeWithUrl()  : $this

Initialize the URI class with a url passed via parameter.

initializeWithUrlAndRootPath()  : $this

Initialize the URI class by providing url and root_path arguments

ip()  : string

Return the IP address of the current user

isExternal()  : bool

Is this an external URL? if it starts with `http` then yes, else false

isValidExtension()  : bool

Check if this is a valid Grav extension

isValidUrl()  : bool

Is the passed in URL a valid URL?

method()  : string

param()  : string|false|null

Get URI parameter.

params()  : null|string|array<string|int, mixed>

Return all or a single query parameter as a URI compatible string.

paramsRegex()  : string

Calculate the parameter regex based on the param_sep setting

parseUrl()  : array<string|int, mixed>|false

password()  : string|null

Return password

path()  : string

Return the Path

paths()  : string|array<string|int, string>

Return URI path.

port()  : int|null

Return the port number if it can be figured out

post()  : array<string|int, mixed>|null

Get post from either $_POST or JSON response object By default returns all data, or can return a single item

query()  : string|array<string|int, mixed>

Return full query string or a single query attribute.

referrer()  : string

Return relative path to the referrer defaulting to current or given page.

rootUrl()  : string

Return root URL to the site.

route()  : string

Return route to the current URI. By default route doesn't include base path.

scheme()  : string

Return the scheme of the URI

setUriProperties()  : Uri

Allow overriding of any element (be careful!)

toArray()  : array<string|int, mixed>

toOriginalString()  : string

uri()  : string

Return the full uri

url()  : string

Return URL.

user()  : string|null

Return user

validateHostname()  : bool

Validate a hostname

createFromEnvironment()  : void

createFromString()  : mixed

hasStandardPort()  : bool

Does this Uri use a standard port?

reset()  : void

buildBaseUrl()  : string

Get the base URI with port if needed

buildEnvironment()  : string

buildRootPath()  : string

Get the Grav Root Path

processParams()  : string

Process any params based in this URL, supports any valid delimiter