<?php
declare(strict_types=1);

/**
 * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 * @link          https://cakephp.org CakePHP(tm) Project
 * @license       https://www.opensource.org/licenses/mit-license.php MIT License
 */
namespace Migrations\Command\Phinx;

use Cake\Event\EventDispatcherTrait;
use Migrations\ConfigurationTrait;
use Phinx\Console\Command\Migrate as MigrateCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * @deprecated 4.5.0 This command is deprecated alongside phinx compatibility.
 */
class Migrate extends MigrateCommand
{
    use CommandTrait {
        execute as parentExecute;
    }
    use ConfigurationTrait;
    /**
     * @use \Cake\Event\EventDispatcherTrait<\Migrations\Command\Phinx\Migrate>
     */
    use EventDispatcherTrait;

    /**
     * Configures the current command.
     *
     * @return void
     */
    protected function configure(): void
    {
        $this->setName('migrate')
            ->setDescription('Migrate the database')
            ->setHelp('runs all available migrations, optionally up to a specific version')
            ->addOption('--target', '-t', InputOption::VALUE_REQUIRED, 'The version number to migrate to')
            ->addOption('--date', '-d', InputOption::VALUE_REQUIRED, 'The date to migrate to')
            ->addOption(
                '--dry-run',
                '-x',
                InputOption::VALUE_NONE,
                'Dump queries to standard output instead of executing it',
            )
            ->addOption(
                '--plugin',
                '-p',
                InputOption::VALUE_REQUIRED,
                'The plugin containing the migrations',
            )
            ->addOption('--connection', '-c', InputOption::VALUE_REQUIRED, 'The datasource connection to use')
            ->addOption('--source', '-s', InputOption::VALUE_REQUIRED, 'The folder where migrations are in')
            ->addOption(
                '--fake',
                null,
                InputOption::VALUE_NONE,
                "Mark any migrations selected as run, but don't actually execute them",
            )
            ->addOption(
                '--no-lock',
                null,
                InputOption::VALUE_NONE,
                'If present, no lock file will be generated after migrating',
            );
    }

    /**
     * Overrides the action execute method in order to vanish the idea of environments
     * from phinx. CakePHP does not believe in the idea of having in-app environments
     *
     * @param \Symfony\Component\Console\Input\InputInterface $input the input object
     * @param \Symfony\Component\Console\Output\OutputInterface $output the output object
     * @return int
     */
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $event = $this->dispatchEvent('Migration.beforeMigrate');
        if ($event->isStopped()) {
            return $event->getResult() ? BaseCommand::CODE_SUCCESS : BaseCommand::CODE_ERROR;
        }
        $result = $this->parentExecute($input, $output);
        $this->dispatchEvent('Migration.afterMigrate');

        return $result;
    }
}
