<?php
declare(strict_types=1);

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

namespace Migrations\Db\Action;

use Migrations\Db\Table\Column;
use Migrations\Db\Table\TableMetadata;

class RenameColumn extends Action
{
    /**
     * The column to be renamed
     *
     * @var \Migrations\Db\Table\Column
     */
    protected Column $column;

    /**
     * The new name for the column
     *
     * @var string
     */
    protected string $newName;

    /**
     * Constructor
     *
     * @param \Migrations\Db\Table\TableMetadata $table The table where the column is
     * @param \Migrations\Db\Table\Column $column The column to be renamed
     * @param string $newName The new name for the column
     */
    public function __construct(TableMetadata $table, Column $column, string $newName)
    {
        parent::__construct($table);
        $this->newName = $newName;
        $this->column = $column;
    }

    /**
     * Creates a new RenameColumn object after building the passed
     * arguments
     *
     * @param \Migrations\Db\Table\TableMetadata $table The table where the column is
     * @param string $columnName The name of the column to be changed
     * @param string $newName The new name for the column
     * @return self
     */
    public static function build(TableMetadata $table, string $columnName, string $newName): self
    {
        $column = new Column();
        $column->setName($columnName);

        return new RenameColumn($table, $column, $newName);
    }

    /**
     * Returns the column to be changed
     *
     * @return \Migrations\Db\Table\Column
     */
    public function getColumn(): Column
    {
        return $this->column;
    }

    /**
     * Returns the new name for the column
     *
     * @return string
     */
    public function getNewName(): string
    {
        return $this->newName;
    }
}
