OperationFrame
in package
Read onlyYes
FinalYes
Immutable description of one running operation; it is also the token that ends it.
Only OperationScope::begin() issues frames and OperationScope::end() accepts only the very instance it issued (a clone or a frame built by hand is foreign). Whether the frame is still open is tracked by the scope, not here. Carries scalars only: no request, payload or entity.
parentId is set only for a frame joined to an already running operation (an operation body
called from another one); such a frame owns nothing and its end closes nothing.
Table of Contents
Constants
- SOURCE_BRIDGE : string = 'bridge'
- SOURCE_CLI : string = 'cli'
- Step of a `bin/*` script or a CLI harness ({@see OperationRunner::cli()}).
- SOURCE_CRON : string = 'cron'
- Cron action ({@see \App\Core\Base\Cron\BasePresenter}), transitional until Cron calls the Api.
- SOURCE_HTTP : string = 'http'
Properties
- $action : string
- $id : int
- $parentId : int|null
- $presenter : string
- $source : string
Methods
- __construct() : mixed
- isJoined() : bool
Constants
SOURCE_BRIDGE
public
string
SOURCE_BRIDGE
= 'bridge'
SOURCE_CLI
Step of a `bin/*` script or a CLI harness ({@see OperationRunner::cli()}).
public
string
SOURCE_CLI
= 'cli'
SOURCE_CRON
Cron action ({@see \App\Core\Base\Cron\BasePresenter}), transitional until Cron calls the Api.
public
string
SOURCE_CRON
= 'cron'
SOURCE_HTTP
public
string
SOURCE_HTTP
= 'http'
Properties
$action
public
string
$action
$id
public
int
$id
$parentId
public
int|null
$parentId
$presenter
public
string
$presenter
$source
public
string
$source
Methods
__construct()
public
__construct(int $id, int|null $parentId, string $source, string $presenter, string $action) : mixed
Parameters
- $id : int
- $parentId : int|null
- $source : string
- $presenter : string
- $action : string
isJoined()
public
isJoined() : bool