KMP PHP API Reference

PlatformJobsRunCommand extends Command
in package

Table of Contents

Properties

$lastResult  : array{claimed: int, completed: int, failed: int}
$runner  : PlatformJobRunner|null

Methods

__construct()  : mixed
Constructor.
defaultName()  : string
execute()  : int
lastResult()  : array{claimed: int, completed: int, failed: int}
Return the most recent execution summary.
buildOptionParser()  : ConsoleOptionParser
getRunner()  : PlatformJobRunner
Return the configured platform job runner.

Properties

$lastResult

private array{claimed: int, completed: int, failed: int} $lastResult = ['claimed' => 0, 'completed' => 0, 'failed' => 0]

Methods

__construct()

Constructor.

public __construct([mixed $runner = null ]) : mixed
Parameters
$runner : mixed = null

execute()

public execute(Arguments $args, ConsoleIo $io) : int
Parameters
$args : Arguments
$io : ConsoleIo
Tags
inheritDoc
Return values
int

lastResult()

Return the most recent execution summary.

public lastResult() : array{claimed: int, completed: int, failed: int}
Return values
array{claimed: int, completed: int, failed: int}

buildOptionParser()

protected buildOptionParser(ConsoleOptionParser $parser) : ConsoleOptionParser
Parameters
$parser : ConsoleOptionParser
Tags
inheritDoc
Return values
ConsoleOptionParser
On this page

Search results