master

laravel/framework

Last updated at: 29/12/2023 09:20

CommandFinished.php

TLDR

This file contains the CommandFinished class within the Illuminate\Console\Events namespace. This class represents an event that is fired when a console command is finished. It holds information about the command name, command input, command output, and exit code.

Classes

CommandFinished

This class represents an event that is fired when a console command is finished. It contains the following properties:

  • $command: The command name (string).
  • $input: The console input implementation (InputInterface object, nullable).
  • $output: The command output implementation (OutputInterface object, nullable).
  • $exitCode: The command exit code (integer).

This class has a constructor which accepts the following parameters:

  • $command: The command name (string).
  • $input: The console input implementation (InputInterface object).
  • $output: The command output implementation (OutputInterface object).
  • $exitCode: The command exit code (integer).

Note: There are no methods in this file.

<?php

namespace Illuminate\Console\Events;

use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class CommandFinished
{
    /**
     * The command name.
     *
     * @var string
     */
    public $command;

    /**
     * The console input implementation.
     *
     * @var \Symfony\Component\Console\Input\InputInterface|null
     */
    public $input;

    /**
     * The command output implementation.
     *
     * @var \Symfony\Component\Console\Output\OutputInterface|null
     */
    public $output;

    /**
     * The command exit code.
     *
     * @var int
     */
    public $exitCode;

    /**
     * Create a new event instance.
     *
     * @param  string  $command
     * @param  \Symfony\Component\Console\Input\InputInterface  $input
     * @param  \Symfony\Component\Console\Output\OutputInterface  $output
     * @param  int  $exitCode
     * @return void
     */
    public function __construct($command, InputInterface $input, OutputInterface $output, $exitCode)
    {
        $this->input = $input;
        $this->output = $output;
        $this->command = $command;
        $this->exitCode = $exitCode;
    }
}