Laravel
Pianificazione delle attività

Creare un'attività

Puoi creare un'attività (Console Command) in Laravel usando Artisan. Dalla tua riga di comando:

php artisan make:console MyTaskName

Questo crea il file in app / Console / Comandi / MyTaskName.php . Sembrerà così:

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class MyTaskName extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'command:name';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Command description';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        //
    }
}

Alcune parti importanti di questa definizione sono:

• La proprietà $signature è ciò che identifica il tuo comando. Sarai in grado di eseguire questo comando in un secondo momento tramite la riga di comando usando Artisan eseguendo il php artisan command:name (dove command:name corrisponde alla $signature del tuo comando)
• La proprietà $description è l'help / display di utilizzo di Artisan accanto al tuo comando quando viene reso disponibile.
• Il metodo handle() è dove scrivi il codice per il tuo comando.

Alla fine, il tuo compito sarà reso disponibile alla linea di comando attraverso Artisan. The protected $signature = 'command:name'; la proprietà di questa classe è ciò che useresti per eseguirla.

Rendere disponibile un compito

Puoi rendere un compito disponibile ad Artisan e alla tua applicazione nel file app / Console / Kernel.php .

La classe Kernel contiene un array chiamato $commands che rende i tuoi comandi disponibili per la tua applicazione.

Aggiungi il tuo comando a questo array, per renderlo disponibile ad Artisan e alla tua applicazione.

<?php

namespace App\Console;

use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

class Kernel extends ConsoleKernel
{
    /**
     * The Artisan commands provided by your application.
     *
     * @var array
     */
    protected $commands = [
        Commands\Inspire::class,
        Commands\MyTaskName::class // This line makes MyTaskName available
    ];

    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
    
    }
}

Una volta fatto, puoi ora accedere al tuo comando tramite la riga di comando, usando Artisan. Supponendo che il tuo comando abbia la proprietà $signature impostata su my:task , puoi eseguire il seguente comando per eseguire l'attività:

php artisan my:task

Pianificazione del tuo compito

Quando il comando è reso disponibile per la tua applicazione, puoi utilizzare Laravel per programmarlo per l'esecuzione a intervalli predefiniti, proprio come faresti con un CRON.

Nel file App / Console / Kernel.php troverai un metodo di schedule che puoi utilizzare per pianificare il tuo compito.

<?php

namespace App\Console;

use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

class Kernel extends ConsoleKernel
{
    /**
     * The Artisan commands provided by your application.
     *
     * @var array
     */
    protected $commands = [
        Commands\Inspire::class,
        Commands\MyTaskName::class
    ];

    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
        $schedule->command('my:task')->everyMinute();
        // $schedule->command('my:task')->everyFiveMinutes();
        // $schedule->command('my:task')->daily();
        // $schedule->command('my:task')->monthly();
        // $schedule->command('my:task')->sundays();
    }
}

Supponendo che la $signature della tua attività sia my:task puoi programmarla come mostrato sopra, usando l'oggetto Schedule $schedule . Laravel offre molti modi diversi per programmare il tuo comando, come mostrato nelle righe sopra commentate.

Impostazione dello scheduler da eseguire

Lo scheduler può essere eseguito utilizzando il comando:

php artisan schedule:run

Lo scheduler deve essere eseguito ogni minuto per funzionare correttamente. È possibile impostarlo creando un cron job con la seguente riga, che esegue lo scheduler ogni minuto in background.

* * * * * php /path/to/artisan schedule:run >> /dev/null 2>&1