Class Env_Field

Environmental value group interface. Base class for simple global arrays.

The name of derived classes must end in the name of the global variable it wants to represent, e.g. Env_SERVER for the global $_SERVER array.

Internally, the KDC data field is a reference to the corresponding global variable. On KDC access, the corresponeding value is wrapped into a Core\Value instance with callback support for reflecting changes to its value to the global array.

Core\Object implements Core\Chainable

Core\Set implements Core\Accessor

Core\Set\Mutable implements Core\Mutator

Core\Field implements Core\Inquiry

Core\Env_Field

Direct known subclasses

Core\Env_SERVER

Namespace: Core
Package: Core\Env
Since: 3.1
Requires: PHP 5.3
Version: 1.0
Located at Env.inc.php

Methods summary

`public`	# `__construct( )` Since 3.1
`protected Core\Value`	# `_retrieveValueForKey( string $key )` Retrieves a value from the associated global array, wraps it in a `Core\Value` instance and returns the value. Retrieves a value from the associated global array, wraps it in a `Core\Value` instance and returns the value. Parameters `$key` Key of environment group entry to retrieve. Returns `Core\Value` Value instance storing the data value (which may be `null`, if the entry identified by the given key key does not exist). Since 3.1
`public Core\Value`	# `getDataForUndefinedKey( string $key )` Default data retrieval implementation for environment fields: The user can choose between KVC and KDC access, both allowing access to the same data fields; per standard values are wrapped by `Core\Value` instances. Default data retrieval implementation for environment fields: The user can choose between KVC and KDC access, both allowing access to the same data fields; per standard values are wrapped by `Core\Value` instances. Parameters `$key` Key of environment group entry to retrieve. Returns `Core\Value` Value instance storing the data value (which may be `null`, if the entry identified by the given key key does not exist). Throws `Core\Exception\UndefinedKey` Failed to resolve data field for the given key. Since 3.1 Overrides `Core\Field::getDataForUndefinedKey`
`public Core\Value`	# `getValueForUndefinedKey( string $key )` Default data retrieval implementation for environment fields: The user can choose between KVC and KDC access, both allowing access to the same data fields; per standard values are wrapped by `Core\Value` instances. Default data retrieval implementation for environment fields: The user can choose between KVC and KDC access, both allowing access to the same data fields; per standard values are wrapped by `Core\Value` instances. Parameters `$key` Key of environment group entry to retrieve. Returns `Core\Value` Value instance storing the data value (which may be `null`, if the entry identified by the given key key does not exist). Throws `Core\Exception\UndefinedKey` Failed to resolve value for the given key. Since 3.1 Overrides `Core\Object::getValueForUndefinedKey`

Constants summary

Constants inherited from Core\Object

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

Properties summary

`protected string`	`$_sourceName` Name of associated global variable array. Name of associated global variable array. Since 3.1	#

Properties inherited from Core\Field

$_v_data

Magic properties inherited from Core\Field

$data

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class Env_Field

Direct known subclasses

Methods summary

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Overrides

Parameters

Returns

Throws

Since

Overrides

Methods inherited from Core\Field

Methods inherited from Core\Set\Mutable

Methods inherited from Core\Set

Methods inherited from Core\Object

Constants summary

Constants inherited from Core\Object

Properties summary

Since

Properties inherited from Core\Field

Magic properties inherited from Core\Field

Magic properties inherited from Core\Object