Class coreuimarkup

Transforms CoreUI markup language using formatter of an associated CoreUI proxy view.

Core\Object implements Core\Chainable

Core\Set implements Core\Accessor

Core\Formatter\Driver\coreuimarkup

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

Methods summary

`public`	# `__construct( Core\URI $uri )` Initialises new CoreUI markup language parser instance. Initialises new CoreUI markup language parser instance. Parameters `$uri` Driver descriptor URI. Since 3.1
`public boolean`	# `chain( Core\Chainable $object, array $flags = null )` Chains a successor formatter instance to this instance. Chains the CoreUI proxy view to the formatter. Chains a successor formatter instance to this instance. Chains the CoreUI proxy view to the formatter. Parameters `$object` Formatter instance to chain as successor. `$flags` See Core\Formatter\Driver\Chainable::chain() for standard flags. Returns boolean `true` on success, otherwise `false`. Throws Exception\InvalidArgument Class of provided object is not supported. Since 3.1 Overrides `Core\Formatter::chain`
`public string`	# `parse( string $text )` Parses and transforms an already encoded CoreUI markup string. Parses and transforms an already encoded CoreUI markup string. Parameters `$text` Markup string to parse. Returns string Transformed input string or `null` on error. Since 3.1
`public string`	# `format( string $text, array $options = null )` Formats a provided string by encoding it according to the chained proxy view encoder and parsing contained CoreUI markup. Formats a provided string by encoding it according to the chained proxy view encoder and parsing contained CoreUI markup. Parameters `$text` Markup string to encode and parse. `$options` Unused by this formatter. Returns string Transformed and encoded input string or `null` on error. Since 3.1 Overrides `Core\Formatter::format`
`protected string`	# `handleCapture( array $matches )` Handles captures from `Core\Formatter\Driver\coreuimarkup::parse()` method. Handles captures from `Core\Formatter\Driver\coreuimarkup::parse()` method. Parameters `$matches` Array of matches from regular expressions parser. Returns string Result of token callback handler or `null` on error. Since 3.1

Constants summary

Constants inherited from Core\Object

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

Properties summary

`protected Core\Hash`	`$_v_tokens` Hash of registered language token instances identified by name. Hash of registered language token instances identified by name. Since 3.1	#
`protected Core\View\Driver\coreui`	`$_v_proxy` Reference to chained proxy view. Reference to chained proxy view. Since 3.1	#

Properties inherited from Core\Formatter

$_v_successor

Magic properties

`public read-only Core\Hash`	`$tokens` Hash of registered language token instances identified by name.
`public read-only Core\View\Driver\coreui`	`$proxy` Reference to chained proxy view.

Magic properties inherited from Core\Formatter

$successor

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Class coreuimarkup

Methods summary

Parameters

Since

Parameters

Returns

Throws

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Methods inherited from Core\Formatter

Methods inherited from Core\Set

Methods inherited from Core\Object

Constants summary

Constants inherited from Core\Object

Properties summary

Since

Since

Properties inherited from Core\Formatter

Magic properties

Magic properties inherited from Core\Formatter

Magic properties inherited from Core\Object