Class Closure

Interface to PHP native Closure instances. Embeds a Closure instance (aka lambda function) and provides an extended user interface including code and parameter retrieval and serialisation.

Core\Object implements Core\Chainable

Core\Set implements Core\Accessor

Core\Closure

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

Methods summary

`public`	# `__construct( $closure, array $args = null )` Initialises the `Core\Closure` instance with a PHP-native closure. Initialises the `Core\Closure` instance with a PHP-native closure. Parameters `$closure` closure represented by this instance. `$args` Optional array of arguments to bind closure to. Throws `Core\Exception\InvalidArgument` Provided argument is not a lambda function. `Core\Exception\Loader` Since 3.1
`public mixed`	# `__invoke( )` Invokes the embedded Closure with the given arguments. Invokes the embedded Closure with the given arguments. Returns mixed Return value of the embedded closure. Since 3.1
`public string[]`	# `__sleep( )` Serialises this instance. Serialises this instance. Returns string[] Array of properties to store during serialisation. Since 3.1
`public`	# `__wakeUp( )` De-serialises contents of a fresh instance. De-serialises contents of a fresh instance. Throws `Core\Exception\Inconsistency` Serialised closure data is defective. `Core\Exception\Loader` Since 3.1
`public ReflectionParameter[]`	# `parameters( )` Returns an array of parameters expected by the embedded closure. Returns an array of parameters expected by the embedded closure. Returns `ReflectionParameter[]` Array of `ReflectionParameter` instances storing parameter names of the embedded closure. Since 3.1
`public string\|false`	# `sourceCode( )` Returns the PHP source code of the embedded closure. Returns the PHP source code of the embedded closure. Returns string\|false PHP source code string of the embedded closure or `false` if the query to fetch the source code failed. Since 3.1
`public string[]\|false`	# `usedVariables( )` Returns an array of variables used by the embedded closure. Returns an array of variables used by the embedded closure. Returns string[]\|false Array of variable names used by of the embedded closure. If no variables are used, an empty array is returned. If the list of used variables cannot be retrieves (e.g. error fetching the source code), `false` is returned instead. 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 array`	`$_v_arguments` Array of bound arguments. Array of bound arguments. Since 3.1	#
`protected Closure`	`$_v_closure` The embedded closure. The embedded closure. Since 3.1	#
`protected ReflectionFunction`	`$_rf` The reflection function instance of the embedded closure. The reflection function instance of the embedded closure. Since 3.1	#
`protected string`	`$_sourceCode` Source code buffer. Source code buffer. Since 3.1	#
`protected array`	`$_usedVariables` Used variables buffer. Used variables buffer. Since 3.1	#

Magic properties

`public read-only array`	`$arguments` Array of bound arguments.
`public read-only Closure`	`$closure` The embedded closure.
`public read-only string\|false`	`$sourceCode` PHP source code of the embedded closure.

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Interfaces

Exceptions

Constants

Class Closure

Methods summary

Parameters

Throws

Since

Returns

Since

Returns

Since

Throws

Since

Returns

Since

Returns

Since

Returns

Since

Methods inherited from Core\Set

Methods inherited from Core\Object

Constants summary

Constants inherited from Core\Object

Properties summary

Since

Since

Since

Since

Since

Magic properties

Magic properties inherited from Core\Object