Documentation

Task extends Job
in package

Task class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
2.1.0

Table of Contents

Properties

$attempts  : int
Attempts
$callable  : CallableObject|null
Job callable
$command  : string|null
Job application command
$completed  : int|null
Job completed timestamp
$cron  : Cron|null
The cron Task
$description  : string|null
Job Description
$exec  : string|null
Job CLI executable command
$failed  : int|null
Job failed timestamp
$failedMessages  : array<string|int, mixed>
Job failed messages
$id  : string|null
Job ID
$maxAttempts  : int
Max attempts
$results  : mixed
Job results
$runUntil  : int|string|null
Run until property
$serializedClosure  : string|null
Serialize closure
$serializedParameters  : array<string|int, mixed>|null
Serialize parameters
$started  : int|null
Job started timestamp

Methods

__construct()  : mixed
Constructor
__sleep()  : array<string|int, mixed>
Sleep magic method
__wakeup()  : void
Wakeup magic method
addFailedMessage()  : AbstractJob
Add failed message
between()  : Task
Set job schedule to between two hours
buffer()  : Task
Set time buffer (alias)
command()  : static
Create a job object with an application command
complete()  : AbstractJob
Complete job
create()  : Task
Create task
cron()  : Cron|null
Get cron Task (alias)
daily()  : Task
Set job schedule to daily
dailyAt()  : Task
Set job schedule to daily at specific time, i.e. 14:30
every10Minutes()  : Task
Set job schedule to every 10 minutes
every10Seconds()  : Task
Set job schedule to every 10 seconds
every15Minutes()  : Task
Set job schedule to every 15 minutes
every15Seconds()  : Task
Set job schedule to every 15 seconds
every20Minutes()  : Task
Set job schedule to every 20 minutes
every20Seconds()  : Task
Set job schedule to every 20 seconds
every30Minutes()  : Task
Set job schedule to every 30 minutes
every30Seconds()  : Task
Set job schedule to every 30 seconds
every5Minutes()  : Task
Set job schedule to every 5 minutes
every5Seconds()  : Task
Set job schedule to every 5 seconds
everyMinute()  : Task
Set job schedule to every minute
everySecond()  : Task
Set job schedule to every second
exec()  : static
Create a job object with a CLI executable command
failed()  : AbstractJob
Set job as failed
fridays()  : Task
Set job schedule to Fridays
generateJobId()  : string
Generate job ID
getAttempts()  : int
Get actual attempts
getBuffer()  : int
Get time buffer
getCallable()  : CallableObject|null
Get job callable
getCommand()  : string|null
Get job application command
getCompleted()  : int|null
Get completed timestamp
getCron()  : Cron|null
Get cron Task
getDaysOfTheMonth()  : array<string|int, mixed>
Get days of the month
getDaysOfTheWeek()  : array<string|int, mixed>
Get days of the week
getExec()  : string|null
Get job CLI executable command
getFailed()  : int|null
Get failed timestamp
getFailedMessages()  : array<string|int, mixed>
Get failed messages
getHours()  : array<string|int, mixed>
Get hours
getJobDescription()  : string|null
Get job description
getJobId()  : string|null
Get job ID
getMaxAttempts()  : int
Get max attempts
getMinutes()  : array<string|int, mixed>
Get minutes
getMonths()  : array<string|int, mixed>
Get months
getResults()  : mixed
Get job results
getRunUntil()  : int|string|null
Get run until value
getSeconds()  : array<string|int, mixed>
Get seconds
getStarted()  : int|null
Get started timestamp
getTaskId()  : string|null
Get task id (alias)
hasAttempts()  : bool
Has actual attempts
hasCallable()  : bool
Has job callable
hasCommand()  : bool
Has job application command
hasCron()  : bool
Has cron Task
hasExceededMaxAttempts()  : bool
Determine if the job has exceeded max attempts
hasExec()  : bool
Has job CLI executable command
hasFailed()  : bool
Has job failed
hasFailedMessages()  : bool
Has failed messages
hasJobDescription()  : bool
Has job description
hasJobId()  : bool
Has job ID
hasMaxAttempts()  : bool
Has max attempts
hasNotRun()  : bool
Has job run yet
hasResults()  : bool
Has job results
hasRunUntil()  : bool
Has run until
hasStarted()  : bool
Has job started
hasTaskId()  : bool
Has task ID (alias)
hourly()  : Task
Set job schedule to hourly
hours()  : Task
Set job schedule to by specific hours
isAttemptOnce()  : bool
Is job set for only one max attempt
isComplete()  : bool
Is job complete
isExpired()  : bool
Determine if the job has expired
isRunning()  : bool
Is job running and has not completed or failed yet
isValid()  : bool
Determine if the job is still valid
minutes()  : Task
Set job schedule to by specific minutes
mondays()  : Task
Set job schedule to Mondays
monthly()  : Task
Set job schedule to monthly
quarterly()  : Task
Set job schedule to quarterly
run()  : mixed
Run job
runUntil()  : AbstractJob
Set the run until property
saturdays()  : Task
Set job schedule to Saturdays
schedule()  : Task
Schedule cront
seconds()  : Task
Set job schedule to by specific seconds
setBuffer()  : Task
Set time buffer
setCallable()  : AbstractJob
Set job callable
setCommand()  : AbstractJob
Set job application command
setCron()  : Task
Set cron Task
setExec()  : AbstractJob
Set job CLI executable command
setJobDescription()  : AbstractJob
Set job description
setJobId()  : AbstractJob
Set job ID
setMaxAttempts()  : AbstractJob
Set max attempts
setTaskId()  : Task
Set task ID (alias)
start()  : AbstractJob
Start job
sundays()  : Task
Set job schedule to Sundays
thursdays()  : Task
Set job schedule to Thursdays
tuesdays()  : Task
Set job schedule to Tuesdays
wednesdays()  : Task
Set job schedule to Wednesdays
weekdays()  : Task
Set job schedule to weekdays
weekends()  : Task
Set job schedule to weekends
weekly()  : Task
Set job schedule to weekly
yearly()  : Task
Set job schedule to yearly
loadCallable()  : mixed
Load callable
runCommand()  : mixed
Run application command
runExec()  : mixed
Run CLI executable command

Properties

$command

Job application command

protected string|null $command = null

$completed

Job completed timestamp

protected int|null $completed = null

$cron

The cron Task

protected Cron|null $cron = null

$description

Job Description

protected string|null $description = null

$exec

Job CLI executable command

protected string|null $exec = null

$failed

Job failed timestamp

protected int|null $failed = null

$failedMessages

Job failed messages

protected array<string|int, mixed> $failedMessages = []

$maxAttempts

Max attempts

protected int $maxAttempts = 0

$results

Job results

protected mixed $results = null

$runUntil

Run until property

protected int|string|null $runUntil = null

$serializedClosure

Serialize closure

protected string|null $serializedClosure = null

$serializedParameters

Serialize parameters

protected array<string|int, mixed>|null $serializedParameters = null

$started

Job started timestamp

protected int|null $started = null

Methods

__construct()

Constructor

public __construct([mixed $callable = null ][, mixed $params = null ][, string|null $id = null ][, Cron $cron = new Cron() ]) : mixed

Instantiate the job object

Parameters
$callable : mixed = null
$params : mixed = null
$id : string|null = null
$cron : Cron = new Cron()

__sleep()

Sleep magic method

public __sleep() : array<string|int, mixed>
Return values
array<string|int, mixed>

__wakeup()

Wakeup magic method

public __wakeup() : void

between()

Set job schedule to between two hours

public between(int $start, int $end) : Task
Parameters
$start : int
$end : int
Return values
Task

buffer()

Set time buffer (alias)

public buffer(int $buffer) : Task
Parameters
$buffer : int
Return values
Task

command()

Create a job object with an application command

public static command(string $command[, string|null $id = null ]) : static
Parameters
$command : string
$id : string|null = null
Return values
static

create()

Create task

public static create([mixed $callable = null ][, mixed $params = null ][, string|null $id = null ][, Cron $cron = new Cron() ]) : Task
Parameters
$callable : mixed = null
$params : mixed = null
$id : string|null = null
$cron : Cron = new Cron()
Return values
Task

cron()

Get cron Task (alias)

public cron() : Cron|null
Return values
Cron|null

daily()

Set job schedule to daily

public daily(mixed $hours[, mixed $minutes = null ]) : Task
Parameters
$hours : mixed
$minutes : mixed = null
Return values
Task

dailyAt()

Set job schedule to daily at specific time, i.e. 14:30

public dailyAt(string $time) : Task
Parameters
$time : string
Return values
Task

every10Minutes()

Set job schedule to every 10 minutes

public every10Minutes() : Task
Return values
Task

every10Seconds()

Set job schedule to every 10 seconds

public every10Seconds() : Task
Return values
Task

every15Minutes()

Set job schedule to every 15 minutes

public every15Minutes() : Task
Return values
Task

every15Seconds()

Set job schedule to every 15 seconds

public every15Seconds() : Task
Return values
Task

every20Minutes()

Set job schedule to every 20 minutes

public every20Minutes() : Task
Return values
Task

every20Seconds()

Set job schedule to every 20 seconds

public every20Seconds() : Task
Return values
Task

every30Minutes()

Set job schedule to every 30 minutes

public every30Minutes() : Task
Return values
Task

every30Seconds()

Set job schedule to every 30 seconds

public every30Seconds() : Task
Return values
Task

every5Minutes()

Set job schedule to every 5 minutes

public every5Minutes() : Task
Return values
Task

every5Seconds()

Set job schedule to every 5 seconds

public every5Seconds() : Task
Return values
Task

everyMinute()

Set job schedule to every minute

public everyMinute() : Task
Return values
Task

everySecond()

Set job schedule to every second

public everySecond() : Task
Return values
Task

exec()

Create a job object with a CLI executable command

public static exec(string $command[, string|null $id = null ]) : static
Parameters
$command : string
$id : string|null = null
Return values
static

fridays()

Set job schedule to Fridays

public fridays() : Task
Return values
Task

generateJobId()

Generate job ID

public generateJobId() : string
Return values
string

getAttempts()

Get actual attempts

public getAttempts() : int
Return values
int

getBuffer()

Get time buffer

public getBuffer() : int
Return values
int

getCommand()

Get job application command

public getCommand() : string|null
Return values
string|null

getCompleted()

Get completed timestamp

public getCompleted() : int|null
Return values
int|null

getCron()

Get cron Task

public getCron() : Cron|null
Return values
Cron|null

getDaysOfTheMonth()

Get days of the month

public getDaysOfTheMonth() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDaysOfTheWeek()

Get days of the week

public getDaysOfTheWeek() : array<string|int, mixed>
Return values
array<string|int, mixed>

getExec()

Get job CLI executable command

public getExec() : string|null
Return values
string|null

getFailed()

Get failed timestamp

public getFailed() : int|null
Return values
int|null

getFailedMessages()

Get failed messages

public getFailedMessages() : array<string|int, mixed>
Return values
array<string|int, mixed>

getHours()

Get hours

public getHours() : array<string|int, mixed>
Return values
array<string|int, mixed>

getJobDescription()

Get job description

public getJobDescription() : string|null
Return values
string|null

getJobId()

Get job ID

public getJobId() : string|null
Return values
string|null

getMaxAttempts()

Get max attempts

public getMaxAttempts() : int
Return values
int

getMinutes()

Get minutes

public getMinutes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getMonths()

Get months

public getMonths() : array<string|int, mixed>
Return values
array<string|int, mixed>

getResults()

Get job results

public getResults() : mixed

getRunUntil()

Get run until value

public getRunUntil() : int|string|null
Return values
int|string|null

getSeconds()

Get seconds

public getSeconds() : array<string|int, mixed>
Return values
array<string|int, mixed>

getStarted()

Get started timestamp

public getStarted() : int|null
Return values
int|null

getTaskId()

Get task id (alias)

public getTaskId() : string|null
Return values
string|null

hasAttempts()

Has actual attempts

public hasAttempts() : bool
Return values
bool

hasCallable()

Has job callable

public hasCallable() : bool
Return values
bool

hasCommand()

Has job application command

public hasCommand() : bool
Return values
bool

hasCron()

Has cron Task

public hasCron() : bool
Return values
bool

hasExceededMaxAttempts()

Determine if the job has exceeded max attempts

public hasExceededMaxAttempts() : 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

hasFailedMessages()

Has failed messages

public hasFailedMessages() : bool
Return values
bool

hasJobDescription()

Has job description

public hasJobDescription() : bool
Return values
bool

hasJobId()

Has job ID

public hasJobId() : bool
Return values
bool

hasMaxAttempts()

Has max attempts

public hasMaxAttempts() : bool
Return values
bool

hasNotRun()

Has job run yet

public hasNotRun() : bool
Return values
bool

hasResults()

Has job results

public hasResults() : bool
Return values
bool

hasRunUntil()

Has run until

public hasRunUntil() : bool
Return values
bool

hasStarted()

Has job started

public hasStarted() : bool
Return values
bool

hasTaskId()

Has task ID (alias)

public hasTaskId() : bool
Return values
bool

hourly()

Set job schedule to hourly

public hourly([mixed $minutes = null ]) : Task
Parameters
$minutes : mixed = null
Return values
Task

hours()

Set job schedule to by specific hours

public hours(mixed $hours[, mixed $minutes = null ]) : Task
Parameters
$hours : mixed
$minutes : mixed = null
Return values
Task

isAttemptOnce()

Is job set for only one max attempt

public isAttemptOnce() : bool
Return values
bool

isComplete()

Is job complete

public isComplete() : bool
Return values
bool

isExpired()

Determine if the job has expired

public isExpired() : bool
Return values
bool

isRunning()

Is job running and has not completed or failed yet

public isRunning() : bool
Return values
bool

isValid()

Determine if the job is still valid

public isValid() : bool
Return values
bool

minutes()

Set job schedule to by specific minutes

public minutes(mixed $minutes) : Task
Parameters
$minutes : mixed
Return values
Task

mondays()

Set job schedule to Mondays

public mondays() : Task
Return values
Task

monthly()

Set job schedule to monthly

public monthly(mixed $day[, mixed $hours = null ][, mixed $minutes = null ]) : Task
Parameters
$day : mixed
$hours : mixed = null
$minutes : mixed = null
Return values
Task

quarterly()

Set job schedule to quarterly

public quarterly([mixed $hours = null ][, mixed $minutes = null ]) : Task
Parameters
$hours : mixed = null
$minutes : mixed = null
Return values
Task

saturdays()

Set job schedule to Saturdays

public saturdays() : Task
Return values
Task

schedule()

Schedule cront

public schedule( $schedule) : Task
Parameters
$schedule :
Return values
Task

seconds()

Set job schedule to by specific seconds

public seconds(mixed $seconds) : Task
Parameters
$seconds : mixed
Return values
Task

setBuffer()

Set time buffer

public setBuffer(int $buffer) : Task
Parameters
$buffer : int
Return values
Task

setCallable()

Set job callable

public setCallable(mixed $callable[, mixed $params = null ]) : AbstractJob
Parameters
$callable : mixed
$params : mixed = null
Return values
AbstractJob

setTaskId()

Set task ID (alias)

public setTaskId(string $id) : Task
Parameters
$id : string
Return values
Task

sundays()

Set job schedule to Sundays

public sundays() : Task
Return values
Task

thursdays()

Set job schedule to Thursdays

public thursdays() : Task
Return values
Task

tuesdays()

Set job schedule to Tuesdays

public tuesdays() : Task
Return values
Task

wednesdays()

Set job schedule to Wednesdays

public wednesdays() : Task
Return values
Task

weekdays()

Set job schedule to weekdays

public weekdays() : Task
Return values
Task

weekends()

Set job schedule to weekends

public weekends() : Task
Return values
Task

weekly()

Set job schedule to weekly

public weekly(mixed $day[, mixed $hours = null ][, mixed $minutes = null ]) : Task
Parameters
$day : mixed
$hours : mixed = null
$minutes : mixed = null
Return values
Task

yearly()

Set job schedule to yearly

public yearly([bool $endOfYear = false ][, mixed $hours = null ][, mixed $minutes = null ]) : Task
Parameters
$endOfYear : bool = false
$hours : mixed = null
$minutes : mixed = null
Return values
Task

runExec()

Run CLI executable command

protected runExec() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results