FacturaScripts

CronClass
in package

AbstractYes

Clase base para el cron de los plugins. Cada plugin puede tener una clase Cron en su raíz que extienda de esta, y su método run() se ejecutará en cada pasada del cron.

Table of Contents

Properties

$pluginName  : string

Methods

__construct()  : mixed
run()  : void
Punto de entrada del cron del plugin. Aquí se definen y ejecutan los jobs.
job()  : CronJob
Devuelve el job del plugin con el nombre indicado, creándolo si no existe, para programarlo y ejecutarlo. Si el job estaba en ejecución desde hace demasiado tiempo (proceso zombie), lo libera.

Properties

Methods

__construct()

public __construct(string $pluginName) : mixed
Parameters
$pluginName : string

Nombre del plugin al que pertenece este cron.

run()

Punto de entrada del cron del plugin. Aquí se definen y ejecutan los jobs.

public abstract run() : void

Ejemplo: $this->job('mi-job')->everyDayAt(3)->run(function() { ... });

job()

Devuelve el job del plugin con el nombre indicado, creándolo si no existe, para programarlo y ejecutarlo. Si el job estaba en ejecución desde hace demasiado tiempo (proceso zombie), lo libera.

protected job(string $name) : CronJob
Parameters
$name : string

Nombre identificativo del job dentro del plugin.

Return values
CronJob
On this page

Search results