\Pvra\ResultCallbackChainHelperTrait

Class CallbackChainHelperTrait

Summary

Methods
Properties
Constants
terminateCallbackChain()
No public properties found
No constants found
inCallbackChain()
isCallbackChainToBeTerminated()
markCallbackChainTerminated()
No protected properties found
N/A
No private methods found
$terminateCallbackChain
$inCallbackChain
N/A

Properties

$terminateCallbackChain

$terminateCallbackChain : boolean

Determines if the current callback-chain should be terminated at the next iteration

Type

boolean

$inCallbackChain

$inCallbackChain : boolean

Callback execution status

Type

boolean

Methods

terminateCallbackChain()

terminateCallbackChain() 

Terminate callback chain from inside a callback

This method may be called from inside of a callback chain to break out in the next iteration *

Throws

\LogicException

Thrown if no callback chain is executing when called

inCallbackChain()

inCallbackChain(boolean  $areWeInCallbackChain) 

Modify the status of current callback execution

This method can be used by the callback calling code to make sure other methods react properly.

Parameters

boolean $areWeInCallbackChain

Set the status of the callback chain execution

isCallbackChainToBeTerminated()

isCallbackChainToBeTerminated() : boolean

Get the status of the callback chain termination

This method can be used to determine if the callback chain is to be terminated prematurely.

Returns

boolean

markCallbackChainTerminated()

markCallbackChainTerminated() 

Mark callback chain terminated

This method should be called after the callback chain was terminated, either by breaking out of it prematurely or after finishing all callback handlers.