PhinxApplication.php

<?php
declare(strict_types=1);

/**
 * MIT License
 * For full license information, please view the LICENSE file that was distributed with this source code.
 */

namespace Phinx\Console;

use Composer\InstalledVersions;
use Phinx\Console\Command\Breakpoint;
use Phinx\Console\Command\Create;
use Phinx\Console\Command\Init;
use Phinx\Console\Command\ListAliases;
use Phinx\Console\Command\Migrate;
use Phinx\Console\Command\Rollback;
use Phinx\Console\Command\SeedCreate;
use Phinx\Console\Command\SeedRun;
use Phinx\Console\Command\Status;
use Phinx\Console\Command\Test;
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputDefinition;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Phinx console application.
 */
class PhinxApplication extends Application
{
    /**
     * @var string The current application version as determined by the getVersion() function.
     */
    private string $version;

    /**
     * Initialize the Phinx console application.
     */
    public function __construct()
    {
        parent::__construct('Phinx by CakePHP - https://phinx.org.', $this->getVersion());

        $this->addCommands([
            new Init(),
            new Create(),
            new Migrate(),
            new Rollback(),
            new Status(),
            new Breakpoint(),
            new Test(),
            new SeedCreate(),
            new SeedRun(),
            new ListAliases(),
        ]);
    }

    /**
     * Setup default input definition.
     *
     * @return \Symfony\Component\Console\Input\InputDefinition the overridden input definition.
     */
    protected function getDefaultInputDefinition(): InputDefinition
    {
        $definition = parent::getDefaultInputDefinition();
        $definition->addOption(new InputOption('--configuration', '-c', InputOption::VALUE_REQUIRED, 'The configuration file to load'));

        return $definition;
    }

    /**
     * Runs the current application.
     *
     * @param \Symfony\Component\Console\Input\InputInterface $input An Input instance
     * @param \Symfony\Component\Console\Output\OutputInterface $output An Output instance
     * @return int 0 if everything went fine, or an error code
     */
    public function doRun(InputInterface $input, OutputInterface $output): int
    {
        // always show the version information except when the user invokes the help
        // command as that already does it
        if ($input->hasParameterOption('--no-info') === false) {
            if (($input->hasParameterOption(['--help', '-h']) !== false) || ($input->getFirstArgument() !== null && $input->getFirstArgument() !== 'list')) {
                $output->writeln($this->getLongVersion());
                $output->writeln('');
            }
        }

        return parent::doRun($input, $output);
    }

    /**
     * Adds a command object.
     *
     * Provides backwards compatibility for Symfony Console 6.x/7.x where
     * the add() method exists, and Symfony 8.x where it was removed in
     * favor of addCommand().
     *
     * @param \Symfony\Component\Console\Command\Command $command A Command object
     * @return \Symfony\Component\Console\Command\Command|null
     */
    public function add(Command $command): ?Command
    {
        if (method_exists(Application::class, 'addCommand')) {
            return parent::addCommand($command);
        }

        return parent::add($command);
    }

    /**
     * Get the current application version.
     *
     * @return string The application version if it could be found, otherwise 'UNKNOWN'
     */
    public function getVersion(): string
    {
        if (isset($this->version)) {
            return $this->version;
        }

        // humbug/box will replace this with actual version when building
        // so use that if available
        $gitTag = '@git_tag@';
        if (!str_starts_with($gitTag, '@')) {
            return $this->version = $gitTag;
        }

        // Otherwise fallback to the version as reported by composer
        if (class_exists(InstalledVersions::class)) {
            return $this->version = InstalledVersions::getPrettyVersion('robmorgan/phinx') ?? 'UNKNOWN';
        }

        return $this->version = 'UNKNOWN';
    }
}