Class Object

Object is the root class for most core class hierarchies. Object provides key-value coding support methods and generic helpers for all derived classes. Also, all Core\Object derived classes inherit a default implementation to the Core\Chainable interface.

Core\Object implements Core\Chainable

Direct known subclasses

Core\Env, Core\Nothing, Core\Set, Core\Storage\Accessor

Indirect known subclasses

Namespace: Core
Package: Core
Since: 3.0
Requires: PHP 5.3
Version: 1.0
Located at Object.inc.php

Methods summary

`public static Core\ClassDescriptor`	# `attachMethod( string $methodName, object $object, string $objectMethod )` Attaches a new method to the class of the instance. Attaches a new method to the class of the instance. Parameters `$methodName` Name of method to attach. `$object` Object holding the implemented method to attach. `$objectMethod` Name of method in object to attach. Returns `Core\ClassDescriptor` Class descriptor interface for the class of the instance. Since 3.1
`protected static object`	# `__autocreateFactory( Core\URI $uri, string $class )` Helper method for standardised autocreate factories. Takes the `Core\URI` scheme, base class name and an optional module path to build the target module name and tries to load the module. On success, a new driver instance is created, taking the `Core\URI` as its only argument; if the scheme is »class«, the class identified by the path component of the `Core\URI` is created instead. Otherwise an invalid driver exception is thrown. Helper method for standardised autocreate factories. Takes the `Core\URI` scheme, base class name and an optional module path to build the target module name and tries to load the module. On success, a new driver instance is created, taking the `Core\URI` as its only argument; if the scheme is »class«, the class identified by the path component of the `Core\URI` is created instead. Otherwise an invalid driver exception is thrown. A standard autocreate factory implementation equals the following example: static public function autocreate(URI $uri_) { return self::__autocreateFactory($uri_, __CLASS__); } Parameters `$uri` Driver specification `Core\URI` instance. The scheme identifies the driver to load, all other `Core\URI` components are used by the driver itself (e.g. configuration settings). The `Core\URI` is passed verbatim to the driver instance. `$class` Name of base class offering the autocreate factory. Usually the constant `__CLASS__` is used. Drivers are searched in the subdirectory with the same name as the base class. Returns object New driver instance. Throws `Core\Exception\InvalidDriver` The driver module does not exist. Since 3.0
`public mixed`	# `__call( string $name, array $args )` Implements support for dynamically attached methods to classes. Implements support for dynamically attached methods to classes. Classes implementing `__call()` should should call their parent implementation of this method if either the invoked method name is not handled by their implementation or further processing is required. Otherwise the class will no longer support dynamically attached methods. Parameters `$name` Name of the invoked method. `$args` Array or arguments passed to the invoked method. Returns mixed Return value of the attached method. Throws `Core\Exception\BadMethodCall` The invoked method is neither a class method nor an attached method. Since 3.1
`public string`	# `__toString( )` Formats a generic string representation of the current object. Subclasses should provide a more specific implementation with further details on the object. Formats a generic string representation of the current object. Subclasses should provide a more specific implementation with further details on the object. The standard object representation of this function may change in the future without further notice and thus should not be reprocessed. Returns string Generic string representation of the current object. The standard output contains the object class name and the instance UUID. The example code `echo new Set();` returns a string similar to `object[Set]@21254f96-fd59-4bff-8536-c713fe803d58` Since 3.0
`public integer\|boolean`	# `chain( Core\Chainable $object, array $flags = null )` Connects another object to the current object. Usage depends on the actual class implementation; common examples are lazy configuration completion or layer expansions. Connects another object to the current object. Usage depends on the actual class implementation; common examples are lazy configuration completion or layer expansions. Parameters `$object` Object to chain to instance. `$flags` Optional array of additional chain flags. Usage depends on the actual chain implementation. Returns integer\|boolean Returns a non-zero value on success, otherwise `false`. Throws `Core\Exception\InvalidArgument` Class of provided object is not supported. Since 3.0 Implementation of `Core\Chainable::chain()`
`public mixed`	# `getValueForKey( string $key )` Retrieves the value for a specified key. Values are retrieved in the following order: Retrieves the value for a specified key. Values are retrieved in the following order: If a property named _v_key exists, its value is returned; otherwise a method named equal to the key is called; if no such method exists, `Core\Object::getValueForUndefinedKey()` is called. Subclasses in general should not override the default behaviour of this function; instead provide properties or methods for specific keys. To dynamically process keys, implement `Core\Object::getValueForUndefinedKey()`. Parameters `$key` Key to retrieve value for. Returns mixed Value of key, if key exists. Throws `Core\Exception\UndefinedKey` Failed to resolve value for the given key. See `Core\Object::getValueForUndefinedKey()` Since 3.0
`final public mixed`	# `getValueForKeyPath( string $path )` Retrieves the value for a specified key path. A key path can contain multiple path segments separated by a dot ».«. Each segment is the key to identify a value of the object identified by the previous segment. The first key identifies a value from the current object. Retrieves the value for a specified key path. A key path can contain multiple path segments separated by a dot ».«. Each segment is the key to identify a value of the object identified by the previous segment. The first key identifies a value from the current object. Segments prefixed with an exclamation mark `!``segment` denote a KDC data field, segments prefixed with an at sign `@``segment` denote an accumulator function for a collection object. Segments that return an array or `ArrayAccess` conform objects may specify the index of an entry by adding an array-like index key in squared brackets as in `segment`*`[``key``]`*. Each value or field is resolved via `Core\Object::getValueForKey()` or Field::getDataForKey(), respectively. Subclasses may overloaded these methods for optimisation purposes or specific extensions. Parameters `$path` Key path to retrieve value for. Returns mixed Value for key path. Throws `Core\Exception\InvalidArgument` A key path must be non-empty. `Core\Exception\UndefinedKey` Failed to resolve the value for a path segment. See `Core\Object::getValueForKey()` Field::getDataForKey() Since 3.0
`public mixed`	# `getValueForUndefinedKey( string $key )` Retrieves the value for an undefined key. The default implementation throws `Core\Exception\UndefinedKey`; subclasses should implement an own version of this method to provide dynamic value access. This method is always called, when `Core\Object::getValueForKey()` fails. Retrieves the value for an undefined key. The default implementation throws `Core\Exception\UndefinedKey`; subclasses should implement an own version of this method to provide dynamic value access. This method is always called, when `Core\Object::getValueForKey()` fails. Subclasses implementing `Core\Object::getValueForUndefinedKey()` should also provide an own implementation of `Core\Object::issetValueForKey()`. Parameters `$key` Key to retrieve value for. Returns mixed Value of key. Throws `Core\Exception\UndefinedKey` Failed to resolve value for the given key. See `Core\Object::getValueForKey()` `Core\Object::issetValueForKey()` Since 3.0
`public string`	# `hash( )` Returns a hash value for the current instance that is unique for each object but equal for all equal objects. The default implementation returns the SPL object hash. Returns a hash value for the current instance that is unique for each object but equal for all equal objects. The default implementation returns the SPL object hash. Returns string Hash value of current object. Since 3.0
`public boolean`	# `issetValueForKey( string $key )` Tests, whether a property or method for a given key exists. The default implementation cannot test, if `Core\Object::getValueForUndefinedKey()` can handle a key; thus subclasses implementing `Core\Object::getValueForUndefinedKey()` should also provide an own implementation for `Core\Object::issetValueForKey()`. Tests, whether a property or method for a given key exists. The default implementation cannot test, if `Core\Object::getValueForUndefinedKey()` can handle a key; thus subclasses implementing `Core\Object::getValueForUndefinedKey()` should also provide an own implementation for `Core\Object::issetValueForKey()`. Parameters `$key` Key to check for existence. Returns boolean `true`, if a property or method for the given key exists, otherwise `false`. Since 3.0
`public mixed`	# `setValueForKey( string $key, mixed $value )` Updates the value for a specified key. Values are updated in the following order: Updates the value for a specified key. Values are updated in the following order: If a method named `set`*`Key`* exists, the update is handled by that method; otherwise a property named `_v_`*`key`* is updated; if no such property exists, `Core\Object::setValueForUndefinedKey()` is called. Subclasses in general should not override the default behaviour of this function; instead provide properties or methods for specific keys. To dynamically process keys, implement `Core\Object::setValueForUndefinedKey()`. Parameters `$key` Key to update value for. `$value` New value for the given key. Returns mixed `true`, if a property has directly been updated, otherwise the return value of the called method is returned and is implementation dependent. Throws `Core\Exception\UndefinedKey` An update operation is not available for the given key. See `Core\Object::setValueForUndefinedKey()` Since 3.0
`final public mixed`	# `setValueForKeyPath( string $path, mixed $value )` Updates the value for a specified key path. See `Core\Object::getValueForKeyPath()` for implementation details. Updates the value for a specified key path. See `Core\Object::getValueForKeyPath()` for implementation details. Parameters `$path` Key path to update value for. `$value` New value for the given key path. Returns mixed `true`, if a property has directly been updated, otherwise the return value of the latest `Core\Object::setValueForKey()` call is returned. Throws `Core\Exception\InvalidArgument` A key path must be non-empty. `Core\Exception\UndefinedKey` Failed to resolve the value for a path segment or an update operation is not available for the last path segment. See `Core\Object::setValueForKey()` Since 3.0
`public mixed`	# `setValueForUndefinedKey( string $key, mixed $value )` Updates value for an undefined key. The default implementation throws `Core\Exception\UndefinedKey`; subclasses should implement an own version of this method to provide dynamic value access. The method is always called, when `Core\Object::setValueForKey()` fails. Updates value for an undefined key. The default implementation throws `Core\Exception\UndefinedKey`; subclasses should implement an own version of this method to provide dynamic value access. The method is always called, when `Core\Object::setValueForKey()` fails. Parameters `$key` Key to update value for. `$value` New value for the given key. Returns mixed The return value depends on the actual implementation. Throws `Core\Exception\UndefinedKey` An update operation is not available for the given key. See `Core\Object::setValueForKey()` Since 3.0
`public string`	# `uuid( )` Returns the instance UUID-string. On the first request, a new UUID-string is assigned and stored with the object. Further requests will return the same UUID-string for the same object. Returns the instance UUID-string. On the first request, a new UUID-string is assigned and stored with the object. Further requests will return the same UUID-string for the same object. The SPL object hash is an alternative to object UUIDs but with a drawback: the SPL object hash is only unique for objects residing in memory at the same time; once an object is released, its hash is re-used. The object UUID generated from this method is unique for an object regardless of time. Returns string UUID-string to identify the current object. See `Core\UUID` Since 3.0
`protected`	# `__processParameters( Core\URI $uri, array $parameterSet )` Helper method for processing `Core\URI` parameters. Helper method for processing `Core\URI` parameters. Complex parameters should be parsed manually after automatic expansion. During automatic expansion, the internal URI parameter set is processed and hence available for further processing. A class implementation using automatic parameter processing must define the protected variable `$_v_parameters`. Parameters `$uri` `Core\URI` instance containing parameters. `$parameterSet` Array of associative key-value pairs. The key specifies the parameter name, the value is an array of up to three values defining the parameter type, default value (optional) and whether the parameter is mandatory (optional). Some data types may require additional parameters. Throws `Core\Exception\InvalidArgument` Target object for auto-chaining does not implement `Core\Chainable`. `Core\Exception\MissingParameter` Mandatory parameter is missing. `Core\Exception\Parameter` Invalid value for enumeration parameter. Since 3.0

Constants summary

`string`	`AnyParameterType` Any (undefined) parameter type, used by automated parameter expansion. Any (undefined) parameter type, used by automated parameter expansion. Since 3.0	# `'X'`
`string`	`AutochainParameterType` Automatically chains a list of registry keys to a given target. If no target is given, the object itself is used as the target of the chaining operation. Automatically chains a list of registry keys to a given target. If no target is given, the object itself is used as the target of the chaining operation. Since 3.1	# `'C'`
`string`	`AutocreateParameterType` Autocreate parameter type, used by automated parameter expansion. Initialises a new instance of a given class hierarchy using the URI string contained in the parameter value. Autocreate parameter type, used by automated parameter expansion. Initialises a new instance of a given class hierarchy using the URI string contained in the parameter value. This parameter requires a fourth parameter set entry containing the name of the base class for the hierarchy to load and call the autocreate factory. Since 3.0	# `'a'`
`string`	`CharParameterType` Character parameter type, used by automated parameter expansion. Character parameter type, used by automated parameter expansion. The value is automatically truncated to at most one character in size. Since 3.0	# `'c'`
`string`	`BooleanParameterType` Boolean parameter type, used by automated parameter expansion. Boolean parameter type, used by automated parameter expansion. Since 3.0	# `'b'`
`string`	`EnumParameterType` Enum parameter type, used by automated parameter expansion. An enum is a set of predefined allowed values. Enum parameter type, used by automated parameter expansion. An enum is a set of predefined allowed values. This parameter type requires a fourth parameter set entry containing the set of allowed values. Since 3.0	# `'e'`
`string`	`IntegerParameterType` Integer parameter type, used by automated parameter expansion. Integer parameter type, used by automated parameter expansion. Supports an optional fourth and fifth parameter to define a minimum and maximum value, respectively, for the parameter value. Boundaries are applied transparently without raising an error (3.1 extension). Since 3.0	# `'i'`
`string`	`RealParameterType` Real parameter type, used by automated parameter expansion. Real parameter type, used by automated parameter expansion. Supports an optional fourth and fifth parameter to define a minimum and maximum value, respectively, for the parameter value. Boundaries are applied transparently without raising an error (3.1 extension). Since 3.0	# `'r'`
`string`	`StringParameterType` String parameter type, used by automated parameter expansion. String parameter type, used by automated parameter expansion. Since 3.0	# `'s'`
`string`	`UserParameterType` User-defined parameter type, parsed via callback. User-defined parameter type, parsed via callback. Since 3.0	# `'U'`

Properties summary

Magic properties

`public read-only string`	`$hash` See `Core\Object::hash()`.
`public read-only string`	`$uuid` See `Core\Object::uuid()`.

Namespaces

Classes

Interfaces

Exceptions

Constants

Class Object

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Returns

Since

Parameters

Returns

Throws

Since

Implementation of

Parameters

Returns

Throws

See

Since

Parameters

Returns

Throws

See

Since

Parameters

Returns

Throws

See

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

See

Since

Parameters

Returns

Throws

See

Since

Parameters

Returns

Throws

See

Since

Returns

See

Since

Parameters

Throws

Since

Constants summary

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Properties summary