History
in package
implements
Countable, IteratorAggregate
Represents a history container that is required when using the history middleware.
Interfaces, Classes and Traits
- Countable
- IteratorAggregate
Table of Contents
- $entries : mixed
- $maxEntries : mixed
- __construct() : mixed
- clear() : mixed
- Flush the history
- count() : mixed
- finish() : mixed
- Finish adding an entry to the history container.
- getIterator() : mixed
- getLastCommand() : CommandInterface
- Get the last finished command seen by the history container.
- getLastRequest() : RequestInterface
- Get the last finished request seen by the history container.
- getLastReturn() : ResultInterface|AwsException
- Get the last received result or exception.
- start() : string
- Initiate an entry being added to the history.
- toArray() : array<string|int, mixed>
- Converts the history to an array.
Properties
$entries
private
mixed
$entries
= array()
$maxEntries
private
mixed
$maxEntries
Methods
__construct()
public
__construct([int $maxEntries = 10 ]) : mixed
Parameters
- $maxEntries : int = 10
-
Maximum number of entries to store.
Return values
mixed —clear()
Flush the history
public
clear() : mixed
Return values
mixed —count()
public
count() : mixed
Return values
mixed —finish()
Finish adding an entry to the history container.
public
finish(string $ticket, mixed $result) : mixed
Parameters
- $ticket : string
-
Ticket returned from the start call.
- $result : mixed
-
The result (an exception or AwsResult).
Return values
mixed —getIterator()
public
getIterator() : mixed
Return values
mixed —getLastCommand()
Get the last finished command seen by the history container.
public
getLastCommand() : CommandInterface
Tags
Return values
CommandInterface —getLastRequest()
Get the last finished request seen by the history container.
public
getLastRequest() : RequestInterface
Tags
Return values
RequestInterface —getLastReturn()
Get the last received result or exception.
public
getLastReturn() : ResultInterface|AwsException
Tags
Return values
ResultInterface|AwsException —start()
Initiate an entry being added to the history.
public
start(CommandInterface $cmd, RequestInterface $req) : string
Parameters
- $cmd : CommandInterface
-
Command be executed.
- $req : RequestInterface
-
Request being sent.
Return values
string —Returns the ticket used to finish the entry.
toArray()
Converts the history to an array.
public
toArray() : array<string|int, mixed>