El archivo Cron.php

Si quieres que tu plugin ejecute tareas periódicamente, puedes hacerlo en el archivo Cron.php de tu plugin. El cron de FacturaScripts ejecutará todos los procesos cron de los plugins activos, siempre y cuando haya sido configurado en el sistema o hosting. Así que si necesita ejecutar algo de forma periódica, el mejor lugar es el cron de su plugin.

Ejemplo de Cron.php

Este sería un cron de ejemplo para el plugin MiPlugin.

<?php
namespace FacturaScripts\Plugins\MiPlugin;

use FacturaScripts\Core\Template\CronClass;

class Cron extends CronClass
{
    public function run(): void
    {
        // su código aquí
    }
}

Todo lo que coloque en la función run() se ejecutará cada vez que ejecute el cron. Por lo que si ejecuta el cron cada minuto, se ejecutará cada minuto. Para controlar cuando se debe ejecutar algo puede asignarle un nombre a ese trabajo e indicar cada cuanto se debe ejecutar.

Ejecutar un trabajo cada hora

En este ejemplo crearemos un trabajo llamado mi-trabajo llamando a la función job(), indicaremos que se realice cada hora con la función every() y finalmente pondremos el código a ejecutar en la función run().

<?php
namespace FacturaScripts\Plugins\MiPlugin;

use FacturaScripts\Core\Template\CronClass;

class Cron extends CronClass
{
    public function run(): void
    {
        $this->job('mi-trabajo')
            ->every('1 hour')
            ->run(function () {
                // tu código aquí
                // esto se ejecutará cada hora
            });
    }
}

Si queremos ejecutar el trabajo cada 6 horas, indicaríamos '6 hours' como parámetro en la función every(). Y si queremos cada 10 días, pondríamos '10 days'.

Ejecutar cada día a una hora concreta

Para ejecutar un trabajo cada día a una hora determinada podemos usar la función everyDayAt().

$this->job('mi-trabajo')
    ->everyDayAt(8)
    ->run(function () {
        // tu código aquí
        // esto se ejecutará cada día a las 8h
    });

Si el cron no se ha ejecutado a las 8, por ejemplo porque el servidor estaba apagado. Cuando el cron se vuelva a ejecutar, por ejemplo a las 10, este trabajo se ejecutaría a las 10, ya que a las 8 no se comprobó y no se pudo ejecutar. Para hacer una comprobación más estricta podemos poner a true el segundo parámetro de la función.

$this->job('mi-trabajo')
    ->everyDayAt(8, true)
    ->run(function () {
        // tu código aquí
        // esto se ejecutará cada día a las 8, y solamente a las 8h
    });

Ejecutar cada lunes, martes...

Si queremos que un trabajo se ejecute todas las semanas un día concreto, por ejemplo el lunes, podemos llamar a la correspondiente función.

$this->job('mi-trabajo')
    ->everyMondayAt(8)
    ->run(function () {
        // tu código aquí
        // esto se ejecutará cada lunes a las 8h
    });

• everyMondayAt() : ejecutar cada lunes.
• everyTuesdayAt() : ejecutar cada martes
• everyWednesdayAt() : ejecutar cada miércoles
• everyThursdayAt() : ejecutar cada jueves
• everyFridayAt() : ejecutar cada viernes
• everySaturdayAt() : ejecutar cada sábado
• everySundayAt() : ejecutar cada domingo

Ejecutar un día concreto de cada mes

Para ejecutar un día concreto de cada mes podemos usar la función everyDay().

$this->job('mi-trabajo')
    ->everyDay(15, 7)
    ->run(function () {
        // tu código aquí
        // esto se ejecutará cada día 15 a las 7h
    });

Ejecutar cada último día del mes

Para ejecutar un trabajo el último día de cada mes podemos usar la función everyLastDayOfMonthAt().

$this->job('mi-trabajo')
    ->everyLastDayOfMonthAt(8)
    ->run(function () {
        // tu código aquí
        // esto se ejecutará el último día de cada mes, a las 8h
    });

Evitar solapamiento

Podemos ejecutar el cron de FacturaScripts tantas veces como queramos. Si lo ejecutamos varias veces en paralelo, cada hilo procesará un trabajo distinto. Pero si necesitamos que un trabajo se ejecute en solitario, podemos usar el método withoutOverlapping() para evitar que este trabajo se ejecute mientras lo hjacen otros.

$this->job('mi-trabajo')
    ->everyDayAt(8)
    ->withoutOverlapping()
    ->run(function () {
        // tu código aquí
        // esto se ejecutará cada día a las 8h y no se podrá ejecutar a la vez que otro trabajo
    });

Si queremos evitar que el trabajo se ejecute a la vez que otro trabajo concreto, por ejemplo: queremos que el trabajo2 no se ejecute a la vez que el trabajo3, pero nos da igual que se ejecute a la vez que trabajo1 o cualquier otro que no sea trabajo3. Podemos pasar el nombre del trabajo como parámetro del método withoutOverlapping().

$this->job('trabajo2')
    ->everyDayAt(8)
    ->withoutOverlapping('trabajo3')
    ->run(function () {
        // tu código aquí
        // esto se ejecutará cada día a las 8h y no se podrá ejecutar a la vez que trabajo3
    });

Si queremos evitar que se ejecute a la vez que trabajo3 o trabajo4, lo indicamos como parámetros:

$this->job('trabajo2')
    ->everyDayAt(8)
    ->withoutOverlapping('trabajo3', 'trabajo4')
    ->run(function () {
        // tu código aquí
        // esto se ejecutará cada día a las 8h y no se podrá ejecutar a la vez que trabajo3 o trabajo4
    });

Limitaciones

• Si tenemos una tarea que se ejecuta cada minuto y otra que se ejecuta cada más tiempo y sin solapamiento, puede darse el caso que nunca llegue a ejecutarse la segunda, porque siempre coincidirá cuando se está ejecutando la primera.
• Si tenemos una tarea que queremos que se ejecute todos los días a las 23h, y el cron se ejecuta a las 23:59, puede ser que nunca se ejecute.