Class URL

Internal references and external URLs based on the associated formatter proxy view.

Core\Object implements Core\Chainable

Core\Set implements Core\Accessor

Core\Formatter\Driver\coreuimarkup\Token

Core\Formatter\Driver\coreuimarkup\Token\URL

Namespace: Core\Formatter\Driver\coreuimarkup\Token
Package: CoreUI\Markup\Token
Since: 3.1
Requires: PHP 5.3
Version: 1.0
Located at Formatter/Driver/coreuimarkup/Token/URL.inc.php

Methods summary

`public`	# `__construct( Core\Formatter $formatter )` Initialises URL token instance and sets up standard schemes. Initialises URL token instance and sets up standard schemes. Parameters `$formatter` Reference to the formatter instance that initialises the token. Since 3.1 Overrides `Core\Formatter\Driver\coreuimarkup\Token::__construct`
`public string[]`	# `captures( )` Returns a hash of regular expressions and handlers processed by this token instance. Returns a hash of regular expressions and handlers processed by this token instance. Returns string[] Hash with regular expressions as keys and their handlers as values. A handler is a hash with unique capture names as keys and their corresponding callbacks to handle the capture as values. Regular expressions must use named captures that match the handler hash keys. Since 3.1
`public`	# `formatAppURL( Core\URI $uri, string $displayName )` Formats an application 'app' scheme URL. Formats an application 'app' scheme URL. Parameters `$uri` URI of extracted URL with 'app' scheme. `$displayName` Encoded display name to use for URL. Since 3.1
`public string`	# `handleCapture( string $key, string $fragment, array $match )` Formats markup parser captures. Formats markup parser captures. Parameters `$key` Key of capture token. `$fragment` Captured text fragment. `$match` Hash of match captures. Returns string Formatted text fragment. Since 3.1
`public`	# `registerScheme( string $scheme, callable $callback )` Registers a new handler for a scheme. An existing handler for the given scheme is replaced with the new one. Registers a new handler for a scheme. An existing handler for the given scheme is replaced with the new one. Parameters `$scheme` Scheme name to register handler for. `$callback` Callback to invoke on registered scheme. Returns $this Reference to this instance. Since 3.1
`public`	# `registerSchemes( array $schemes )` Registers a set of new scheme handlers. Any already existing handler for a given scheme is replaced with the new one. Registers a set of new scheme handlers. Any already existing handler for a given scheme is replaced with the new one. Parameters `$schemes` Dictionary of scheme names as keys with their corresponding callbacks as values to register. Returns $this Reference to this instance. Since 3.1
`public`	# `setIgnoreUnregisteredSchemes( boolean $flag )` Sets the ignore unregistered schemes flag. Sets the ignore unregistered schemes flag. Parameters `$flag` Whether to ignore unregistered scheme occurrences. Returns $this Reference to this instance. Since 3.1
`public`	# `setRelativeAppURLs( boolean $value )` Sets the relative applications URLs flag. Sets the relative applications URLs flag. Parameters `$value` Whether application URLs should be relative. Returns $this Since 3.1

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), __toString(), attachMethod(), chain(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

`protected boolean`	`$_v_ignoreUnregisteredSchemes` If set, captured links with unregistered schemes are silently ignored. If set, captured links with unregistered schemes are silently ignored. Since 3.1	# `false`
`protected boolean`	`$_v_relativeAppURLs` If set, application URLs are relative, if possible. If set, application URLs are relative, if possible. Since 3.1	#
`protected array`	`$_v_schemes` Dictionary of registered schemes as keys and their associated callbacks as values. Dictionary of registered schemes as keys and their associated callbacks as values. Since 3.1	# `array ()`

Properties inherited from Core\Formatter\Driver\coreuimarkup\Token

$_v_formatter

Magic properties

`public read-only boolean`	`$ignoreUnregisteredSchemes` If set, captured links with unregistered schemes are silently ignored. Otherwise a normal link using the captured scheme is rendered.
`public read-only boolean`	`$relativeAppURLs` If set to `false`, application URLs are always absolute, otherwise, if possible, application URLs are relative.
`public read-only array`	`$schemes` Dictionary of registered schemes as keys and their associated callbacks as values.

Magic properties inherited from Core\Formatter\Driver\coreuimarkup\Token

$formatter

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Class URL

Methods summary

Parameters

Since

Overrides

Returns

Since

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Methods inherited from Core\Set

Methods inherited from Core\Object

Constants summary

Constants inherited from Core\Object

Properties summary

Since

Since

Since

Properties inherited from Core\Formatter\Driver\coreuimarkup\Token

Magic properties

Magic properties inherited from Core\Formatter\Driver\coreuimarkup\Token

Magic properties inherited from Core\Object