Show:

Q_Uri Class

Defined in: platform/classes/Q/Uri.php:8
Module: Q

Represents an internal URI

Constructor

Q_Uri

()

Defined in platform/classes/Q/Uri.php:8

Methods

__get

(
  • $field_name
)
String | Null

Defined in platform/classes/Q/Uri.php:277

Returns the value of the specified URI field, or null if it is not present.

Parameters:

  • $field_name String

    The name of the field.

Returns:

String | Null:

Returns the value of the field, or null if not there.

__isset

(
  • $field_name
)

Defined in platform/classes/Q/Uri.php:307

Returns whether the specified URI field is set

Parameters:

  • $field_name String

    The name of the field.

__set

(
  • $field_name
  • $value
)

Defined in platform/classes/Q/Uri.php:292

Sets the value of the specified URI field

Parameters:

  • $field_name String

    The name of the field.

  • $value String | Array

    The value of the field

__toString

() String

Defined in platform/classes/Q/Uri.php:62

Returns:

String:

cacheBaseUrl

(
  • [$base_url=null]
)
Array static

Defined in platform/classes/Q/Uri.php:238

Set cache base url, relative to which this particular client may store cached versions of files.

Parameters:

  • [$base_url=null] Array optional

    If no arguments are passed, just returns the current cache base url.

Returns:

Array:

Returns the cache base url at the time the function was called.

decode

(
  • $tail
)
Array protected static

Defined in platform/classes/Q/Uri.php:1047

Parameters:

  • $tail String

    This can either be JSON, or something that looks like a=b c=d where a, b, c, d are urlencoded

Returns:

Array:

documentRoot

() String static

Defined in platform/classes/Q/Uri.php:781

Returns:

String:

encode

(
  • $fields
)
String protected static

Defined in platform/classes/Q/Uri.php:1021

Parameters:

  • $fields Array

    An array of fields

Returns:

String:

A representation like a=b c=d where a, b, c, d are urlencoded

filenamefromUrl

(
  • $url
)
String static

Defined in platform/classes/Q/Uri.php:797

Returns what the local filename of a local URL would typically be without any routing. If not found under docroot, also checks various aliases.

Parameters:

  • $url String

    The url to translate, whether local or an absolute url beginning with the base URL

Returns:

String:

The complete filename of the file or directory. It may not point to an actual file or directory, so use file_exists() or realpath()

fixUrl

(
  • $url
)
String static

Defined in platform/classes/Q/Uri.php:871

Interpolates a URL and fixes it to have only one question mark and hash mark.

Parameters:

  • $url String

    The url to fix

Returns:

String:

The URL with all subsequent ? and # replaced by &

from

(
  • $source
  • [$route=null]
)
Q_Uri | False static

Defined in platform/classes/Q/Uri.php:18

Constructs a URI object from something

Parameters:

  • $source String

    An absolute URL, or an array, or a URI in string form.

  • [$route=null] String optional

    The pattern of the route in the routes config. If not specified, then Qbix searches all the route patterns in order, until it finds one that fits. If you set this to false, then $source is treated as an absolute URL, regardless of its format.

Returns:

Q_Uri | False:

Returns false if no route patterns match. Otherwise, returns the URI.

fromArray

(
  • $source
)
Q_Uri protected static

Defined in platform/classes/Q/Uri.php:959

Parameters:

  • $source Array

Returns:

Q_Uri:

fromString

(
  • $source
)
Q_Uri protected static

Defined in platform/classes/Q/Uri.php:980

Parameters:

  • $source String

Returns:

Q_Uri:

fromUrl

(
  • $url
  • [$route=null]
)
Q_Uri protected static

Defined in platform/classes/Q/Uri.php:321

Parameters:

  • $url String
  • [$route=null] String optional

Returns:

Q_Uri:

interpolateUrl

(
  • $url
  • [$additional=array()]
)
static

Defined in platform/classes/Q/Uri.php:839

Interpolate some standard placeholders inside a url, such as {{AppName}} or {{PluginName}}

Parameters:

  • $url String
  • [$additional=array()] Array optional

    Any additional substitutions

Returns:

{strQ_Uri::interpolateUrlitutions applied

matchRoute

(
  • $pattern
  • $fields
  • [$controller=true]
)
String | False protected static

Defined in platform/classes/Q/Uri.php:622

Parameters:

  • $pattern String
  • $fields Array
  • [$controller=true] String optional

Returns:

String | False:

Returns false if even one field doesn't match. Otherwise, returns the URL that would be routed to this uri.

matchSegments

(
  • $pattern
  • $segments
)
Array | False protected static

Defined in platform/classes/Q/Uri.php:550

Parameters:

  • $pattern String

    The pattern (of the rule) to match

  • $segments String

    The segments extracted from the URL

Returns:

Array | False:

Returns false if one of the literal values doesn't match up, Otherwise, returns array of field => name pairs where fields were filled.

pluginBaseUrl

(
  • string
)
String static

Defined in platform/classes/Q/Uri.php:256

Get the base url of a plugin

Parameters:

  • string Object

    $plugin The name of the plugin, with first letter uppercase.

Returns:

String:

Returns an absolute or relative URL

proxyDestination

(
  • $url
)
String static

Defined in platform/classes/Q/Uri.php:736

If a proxy exists for this URL, returns the destination URL, otherwise returns the input URL

Parameters:

  • $url String

Returns:

String:

proxySource

(
  • $url
)
String static

Defined in platform/classes/Q/Uri.php:758

If a proxy exists for this URL, returns the source URL, otherwise returns the input URL

Parameters:

  • $url String

Returns:

String:

route

() String

Defined in platform/classes/Q/Uri.php:540

Get the route that was used to obtain this URI from a URL

Returns:

String:

suffix

(
  • [$suffix=null]
)
Array static

Defined in platform/classes/Q/Uri.php:214

Set a suffix for all URLs that will be generated with this class.

Parameters:

  • [$suffix=null] Array | String optional

    If no arguments are passed, just returns the current suffix. Pass an array here. For each entry, the key is tested and if it begins the URL, then the value is appended. Suffixes are applied when URLs are generated. You can also pass a string here, in which case the array('' => $suffix) is used.

Returns:

Array:

Returns the suffix at the time the function was called.

toArray

() Array

Defined in platform/classes/Q/Uri.php:97

Returns:

Array:

toUrl

(
  • [$route=null]
  • [$controller=true]
)
String

Defined in platform/classes/Q/Uri.php:451

Maps this URI into an external URL.

Parameters:

  • [$route=null] String optional

    If you name the route to use for unrouting, it will be used as much as possible. Otherwise, Qbix will go through the routes one by one in order, until it finds one that can route a URL to the full URI contained in this object.

  • [$controller=true] String optional

    You can supply a different controller name, like 'tool.php'

Returns:

String:

If a $route is specified, the router uses this route and replaces as many variables as it can to match the $internal_destination. If not, the router tries to find a route and use it to make an external URL that maps to the internal destination exactly, but if none of the routes can do this, it returns an empty string. You may want to use Q_Uri::proxySource() on the returned url to get the proxy url corresponding to it.

url

(
  • $source
  • [$route=null]
  • [$noProxy=false]
  • [$controller=true]
)
String static

Defined in platform/classes/Q/Uri.php:114

Takes some input and returns the corresponding URL

Parameters:

  • $source String | Boolean | Array | Q_Uri

    This can be a Q_Uri, an array or string representing a uri, an absolute url, or "true". If you pass "true", then the Q_Request::baseUrl(true) is used as input.

  • [$route=null] String | Null optional

    If you know which route pattern to use, then specify it here. Otherwise, leave it null.

  • [$noProxy=false] Boolean optional

    If set to true, Q_Uri::proxySource($url) is not called before returning the result.

  • [$controller=true] String optional

    The controller to pass to Q_Request::baseUrl($controller) when forming the URL.

Returns:

String:

Properties

$anchorstring

String protected

Defined in platform/classes/Q/Uri.php:1096

$cacheBaseUrl

String public

Defined in platform/classes/Q/Uri.php:1120

$fields

Array protected

Defined in platform/classes/Q/Uri.php:1078

$querystring

String protected

Defined in platform/classes/Q/Uri.php:1090

$route

String protected

Defined in platform/classes/Q/Uri.php:1084

$suffix

Array protected

Defined in platform/classes/Q/Uri.php:1102

$url

Array public

Defined in platform/classes/Q/Uri.php:1132

$urls

String public

Defined in platform/classes/Q/Uri.php:1126

$variablePrefixes

Array public

Defined in platform/classes/Q/Uri.php:1108

$variablePrefixes

Array public

Defined in platform/classes/Q/Uri.php:1114

Events

Q/Uri/fromUrl

Before

Defined in platform/classes/Q/Uri.php:345

Hook for custom logic modifying routing from URLs to internal URIs

Event Payload:

  • url String

Q/Uri/pluginUrl

Before

Defined in platform/classes/Q/Uri.php:265

Hook for custom logic modifying the urls for a plugin

Event Payload:

  • plugin String

Q/Uri/toUrl

Before

Defined in platform/classes/Q/Uri.php:520

Event Payload:

  • uri Q_Uri

    This is the uri being turned into a URL

  • route String | Null

    The route that is going to be used (from config)

  • controller String | Null

    The controller that is being used for the baseUrl

  • url String | Null

    The computed url, that will be returned. You can modify it.