cycle / migrations

src/Operation/Column/Column.php

<?php

declare(strict_types=1);

namespace Cycle\Migrations\Operation\Column;

use Cycle\Database\Schema\AbstractColumn;

The type Cycle\Database\Schema\AbstractColumn was not found. Maybe you did not declare it correctly or list all dependencies?

use Cycle\Database\Schema\AbstractTable;
use Cycle\Migrations\Exception\Operation\ColumnException;
use Cycle\Migrations\Operation\AbstractOperation;
use Cycle\Migrations\Operation\Traits\OptionsTrait;

abstract class Column extends AbstractOperation
{
    use OptionsTrait;

    /**
     * Some options has set of aliases.
     */
    protected array $aliases = [
        'size' => ['length', 'limit'],
        'default' => ['defaultValue'],
        'null' => ['nullable'],
    ];

    public function __construct(
        string $table,
        protected string $name,
        protected string $type = 'string',
        array $options = []
    ) {
        $this->options = $options;
        parent::__construct($table);
    }

    /**
     * @throws ColumnException
     */
    protected function declareColumn(AbstractTable $schema): AbstractColumn
    {
        $column = $schema->column($this->name);

        //Type configuring
        if (method_exists($column, $this->type)) {
            $arguments = [];
            $variadic = false;

            $method = new \ReflectionMethod($column, $this->type);
            foreach ($method->getParameters() as $parameter) {
                if ($this->hasOption($parameter->getName())) {
                    $arguments[$parameter->getName()] = $this->getOption($parameter->getName());
                } elseif (!$parameter->isOptional()) {
                    throw new ColumnException(
                        "Option '{$parameter->getName()}' are required to define column with type '{$this->type}'"
                    );
                } elseif ($parameter->isDefaultValueAvailable()) {
                    $arguments[$parameter->getName()] = $parameter->getDefaultValue();
                } elseif ($parameter->isVariadic()) {
                    $variadic = true;
                }
            }

            \call_user_func_array(
                [$column, $this->type],
                $variadic ? $arguments + $this->options + $column->getAttributes() : $arguments,
            );
        } else {
            $column->type($this->type);
        }

        $column->nullable($this->getOption('nullable', false));

        if ($this->hasOption('default')) {
            $column->defaultValue($this->getOption('default', null));
        }

        return $column;
    }
}