PhpMyAdmin\SqlParser\Components\AlterOperation

Complexity

Total Complexity

8

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Test Coverage

Coverage

90.48%

Importance

Changes	4
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	3	1
A	__construct()	0	10	1
A	build()	0	23	6

<?php

declare(strict_types=1);

namespace PhpMyAdmin\SqlParser\Components;

use PhpMyAdmin\SqlParser\Component;
use PhpMyAdmin\SqlParser\Parsers\PartitionDefinitions;
use PhpMyAdmin\SqlParser\Token;
use PhpMyAdmin\SqlParser\TokensList;

use function trim;

/**
 * Parses an alter operation.
 */
final class AlterOperation implements Component
{
    /**
     * Options of this operation.
     *
     * @var OptionsArray
     */
    public $options;

    /**
     * The altered field.
     *
     * @var Expression|string|null
     */
    public $field;

    /**
     * The partitions.
     *
     * @var PartitionDefinition[]|null
     */
    public $partitions;

    /**
     * @param OptionsArray               $options    options of alter operation
     * @param Expression|string|null     $field      altered field
     * @param PartitionDefinition[]|null $partitions partitions definition found in the operation
     * @param Token[]                    $unknown    unparsed tokens found at the end of operation
     */
    public function __construct(
        OptionsArray|null $options = null,
        Expression|string|null $field = null,
        array|null $partitions = null,
        public array $unknown = [],
    ) {
        $this->partitions = $partitions;
        $this->options = $options;
        $this->field = $field;
        $this->unknown = $unknown;
    }

    public function build(): string
    {
        // Specific case of RENAME COLUMN that insert the field between 2 options.
        $afterFieldsOptions = new OptionsArray();
        if ($this->options->has('RENAME') && $this->options->has('COLUMN')) {
            $afterFieldsOptions = clone $this->options;
            $afterFieldsOptions->remove('RENAME');
            $afterFieldsOptions->remove('COLUMN');
            $this->options->remove('TO');
        }

        $ret = $this->options . ' ';
        if (isset($this->field) && ($this->field !== '')) {
            $ret .= $this->field . ' ';
        }

        $ret .= $afterFieldsOptions . TokensList::buildFromArray($this->unknown);

        if (isset($this->partitions)) {
            $ret .= PartitionDefinitions::buildAll($this->partitions);

It seems like $this->partitions can also be of type null; however, parameter $component of PhpMyAdmin\SqlParser\Parsers\PartitionDefinitions::buildAll() does only seem to accept array, maybe add an additional type check?

        }

        return trim($ret);
    }

    public function __toString(): string
    {
        return $this->build();
    }
}