api_reference

PHP Deferred Callchain

Table of Contents

• BadTargetClassException
  • __construct
• BadTargetInterfaceException
  • __construct
• BadTargetTypeException
  • __construct
• DeferredCallChain
  • offsetSet
  • offsetExists
  • offsetUnset
  • jsonSerialize
  • __toString
  • toString
  • __construct
  • __call
  • offsetGet
  • __invoke
• TargetAlreadyDefinedException
  • __construct
• UndefinedTargetClassException
  • __construct

BadTargetClassException

Thrown when applying a deferred call chain on a target which is not an instance of the expected class.

• Full name: \JClaveau\Async\Exceptions\BadTargetClassException
• Parent class:

__construct

Constructor.

BadTargetClassException::__construct( \JClaveau\Async\DeferredCallChain $callchain, mixed $expected_target, mixed $target )

Parameters:

Parameter	Type	Description
$callchain	\JClaveau\Async\DeferredCallChain
$expected_target	mixed	The expected class
$target	mixed

---

BadTargetInterfaceException

Thrown when applying a deferred call chain on a target which doesn't implement the expected interface.

• Full name: \JClaveau\Async\Exceptions\BadTargetInterfaceException
• Parent class:

__construct

Constructor.

BadTargetInterfaceException::__construct( \JClaveau\Async\DeferredCallChain $callchain, mixed $expected_target, mixed $target )

Parameters:

Parameter	Type	Description
$callchain	\JClaveau\Async\DeferredCallChain
$expected_target	mixed	The expected interface
$target	mixed

---

BadTargetTypeException

Thrown when applying a deferred call chain on a target which is not of the expected type.

• Full name: \JClaveau\Async\Exceptions\BadTargetTypeException
• Parent class:

__construct

Constructor.

BadTargetTypeException::__construct( \JClaveau\Async\DeferredCallChain $callchain, mixed $expected_target, mixed $target )

Parameters:

Parameter	Type	Description
$callchain	\JClaveau\Async\DeferredCallChain
$expected_target	mixed	The expected type
$target	mixed

---

DeferredCallChain

This class stores an arbitrary stack of calls (methods or array entries access) that will be callable on any future variable.

• Full name: \JClaveau\Async\DeferredCallChain
• This class implements: \JsonSerializable, \ArrayAccess

offsetSet

Unused part of the ArrayAccess interface

DeferredCallChain::offsetSet(  $offset,  $value )

Parameters:

Parameter	Type	Description
$offset	****
$value	****

---

offsetExists

Unused part of the ArrayAccess interface

DeferredCallChain::offsetExists(  $offset )

Parameters:

Parameter	Type	Description
$offset	****

---

offsetUnset

Unused part of the ArrayAccess interface

DeferredCallChain::offsetUnset(  $offset )

Parameters:

Parameter	Type	Description
$offset	****

---

jsonSerialize

For implementing JsonSerializable interface.

DeferredCallChain::jsonSerialize(  )

See Also:

• https://secure.php.net/manual/en/jsonserializable.jsonserialize.php

---

__toString

Outputs the PHP code producing the current call chain while it's casted as a string.

DeferredCallChain::__toString(  ): string

Return Value:

The PHP code corresponding to this call chain

---

toString

Outputs the PHP code producing the current call chain while it's casted as a string.

DeferredCallChain::toString( array $options = array() ): string

Parameters:

Parameter	Type	Description
$options	array	target: mixed | max_parameter_length: int | short_objects: bool

Return Value:

The PHP code corresponding to this call chain

---

__construct

Constructor

DeferredCallChain::__construct( string $class_type_interface_or_instance = null )

Parameters:

Parameter	Type	Description
$class_type_interface_or_instance	string	The expected target class/type/interface/instance

---

__call

Stores any call in the the stack.

DeferredCallChain::__call( string $method, array $arguments ): $this

Parameters:

Parameter	Type	Description
$method	string
$arguments	array

---

offsetGet

ArrayAccess interface

DeferredCallChain::offsetGet( string $key )

Parameters:

Parameter	Type	Description
$key	string	The entry to acces

---

__invoke

Invoking the instance produces the call of the stack

DeferredCallChain::__invoke( mixed $target = null ): mixed

Parameters:

Parameter	Type	Description
$target	mixed	The target to apply the callchain on

Return Value:

The value returned once the call chain is called uppon $target

---

TargetAlreadyDefinedException

Thrown when applying a deferred call chain on a target which is already defined.

• Full name: \JClaveau\Async\Exceptions\TargetAlreadyDefinedException
• Parent class:

__construct

Constructor.

TargetAlreadyDefinedException::__construct( \JClaveau\Async\DeferredCallChain $callchain, mixed $expected_target, mixed $target )

Parameters:

Parameter	Type	Description
$callchain	\JClaveau\Async\DeferredCallChain
$expected_target	mixed	The target instance
$target	mixed

---

UndefinedTargetClassException

Thrown when defining an expected target which is not an existing class, an existing interface or native type.

• Full name: \JClaveau\Async\Exceptions\UndefinedTargetClassException
• Parent class:

__construct

Constructor.

UndefinedTargetClassException::__construct( \JClaveau\Async\DeferredCallChain $callchain, mixed $expected_target )

Parameters:

Parameter	Type	Description
$callchain	\JClaveau\Async\DeferredCallChain
$expected_target	mixed	The wrong expected target

---

---

This document was automatically generated from source code comments on 2019-11-12 using phpDocumentor and cvuorinen/phpdoc-markdown-public