InteractsWithSignals.php

TLDR

The file InteractsWithSignals.php is a trait in the Illuminate\Console\Concerns namespace. It contains methods for defining callbacks for signal events and unregistering signal handlers.

Methods

trap

This method is used to define a callback to be run when the given signal(s) occur. It accepts two parameters:

• $signals (iterable<array-key, int>|int): The signal(s) to trap.
• $callback (callable(int $signal): void): The callback to be executed when the signal occurs.

untrap

This method is used to untrap signal handlers set within the command's handler. It has no parameters.

<?php

namespace Illuminate\Console\Concerns;

use Illuminate\Console\Signals;
use Illuminate\Support\Arr;

trait InteractsWithSignals
{
    /**
     * The signal registrar instance.
     *
     * @var \Illuminate\Console\Signals|null
     */
    protected $signals;

    /**
     * Define a callback to be run when the given signal(s) occurs.
     *
     * @param  iterable<array-key, int>|int  $signals
     * @param  callable(int $signal): void  $callback
     * @return void
     */
    public function trap($signals, $callback)
    {
        Signals::whenAvailable(function () use ($signals, $callback) {
            $this->signals ??= new Signals(
                $this->getApplication()->getSignalRegistry(),
            );

            collect(Arr::wrap($signals))
                ->each(fn ($signal) => $this->signals->register($signal, $callback));
        });
    }

    /**
     * Untrap signal handlers set within the command's handler.
     *
     * @return void
     *
     * @internal
     */
    public function untrap()
    {
        if (! is_null($this->signals)) {
            $this->signals->unregister();

            $this->signals = null;
        }
    }
}