JobInterface
in
Job class
Tags
Table of Contents
- attemptOnce() : JobInterface
- Set job to only attempt once
- generateJobId() : string
- Generate job ID
- getCallable() : mixed
- Get job callable
- getCommand() : string
- Get job application command
- getExec() : string
- Get job CLI executable command
- getJobDescription() : string
- Get job description
- getJobId() : string
- Get job ID
- hasCallable() : bool
- Has job callable
- hasCommand() : bool
- Has job application command
- hasExec() : bool
- Has job CLI executable command
- hasFailed() : bool
- Has job failed
- hasJobDescription() : bool
- Has job description
- hasJobId() : bool
- Has job ID
- isAttemptOnce() : bool
- Set job to only attempt to run once
- isComplete() : bool
- Is job complete
- isRunning() : bool
- Is job running
- run() : void
- Run job
- setAsFailed() : JobInterface
- Set job as failed
- setCallable() : JobInterface
- Set job callable
- setCommand() : JobInterface
- Set job application command
- setExec() : JobInterface
- Set job CLI executable command
- setJobDescription() : JobInterface
- Set job description
- setJobId() : JobInterface
- Set job ID
Methods
attemptOnce()
Set job to only attempt once
public
attemptOnce([bool $attemptOnce = true ]) : JobInterface
Parameters
- $attemptOnce : bool = true
Return values
JobInterface —generateJobId()
Generate job ID
public
generateJobId() : string
Return values
string —getCallable()
Get job callable
public
getCallable() : mixed
Return values
mixed —getCommand()
Get job application command
public
getCommand() : string
Return values
string —getExec()
Get job CLI executable command
public
getExec() : string
Return values
string —getJobDescription()
Get job description
public
getJobDescription() : string
Return values
string —getJobId()
Get job ID
public
getJobId() : string
Return values
string —hasCallable()
Has job callable
public
hasCallable() : bool
Return values
bool —hasCommand()
Has job application command
public
hasCommand() : bool
Return values
bool —hasExec()
Has job CLI executable command
public
hasExec() : bool
Return values
bool —hasFailed()
Has job failed
public
hasFailed() : bool
Return values
bool —hasJobDescription()
Has job description
public
hasJobDescription() : bool
Return values
bool —hasJobId()
Has job ID
public
hasJobId() : bool
Return values
bool —isAttemptOnce()
Set job to only attempt to run once
public
isAttemptOnce() : bool
Return values
bool —isComplete()
Is job complete
public
isComplete() : bool
Return values
bool —isRunning()
Is job running
public
isRunning() : bool
Return values
bool —run()
Run job
public
run() : void
Return values
void —setAsFailed()
Set job as failed
public
setAsFailed() : JobInterface
Return values
JobInterface —setCallable()
Set job callable
public
setCallable(mixed $callable[, mixed $params = null ]) : JobInterface
Parameters
- $callable : mixed
- $params : mixed = null
Return values
JobInterface —setCommand()
Set job application command
public
setCommand(string $command) : JobInterface
Parameters
- $command : string
Return values
JobInterface —setExec()
Set job CLI executable command
public
setExec(mixed $command) : JobInterface
Parameters
- $command : mixed
Return values
JobInterface —setJobDescription()
Set job description
public
setJobDescription(string $description) : JobInterface
Parameters
- $description : string
Return values
JobInterface —setJobId()
Set job ID
public
setJobId(string $id) : JobInterface
Parameters
- $id : string