MySQLColumn::getComment() - Code Metrics - Inspection of "chore(2.x): release 2.13.0 (#221)" - cycle/database - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 2.x ( a18c78...0f4623 )

by Aleksei
created 2025-03-27 15:50 UTC
MySQLColumn::getComment() A

↳ Parent: MySQLColumn
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	0
cp	0
crap	2
rs	10
<?php

/**
 * This file is part of Cycle ORM package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Cycle\Database\Driver\MySQL\Schema;

use Cycle\Database\Driver\DriverInterface;
use Cycle\Database\Exception\DefaultValueException;
use Cycle\Database\Exception\SchemaException;
use Cycle\Database\Injection\Fragment;
use Cycle\Database\Injection\FragmentInterface;
use Cycle\Database\Schema\AbstractColumn;
filter:
    dependency_paths: ["lib/*"]
use Cycle\Database\Schema\Attribute\ColumnAttribute;

/**
 * Attention! You can use only one timestamp or datetime with DATETIME_NOW setting! Thought, it will
 * work on multiple fields with MySQL 5.6.6+ version.
 *
 * @method $this|AbstractColumn primary(int $size, bool $unsigned = false, $zerofill = false)
 * @method $this|AbstractColumn smallPrimary(int $size, bool $unsigned = false, $zerofill = false)
 * @method $this|AbstractColumn bigPrimary(int $size, bool $unsigned = false, $zerofill = false)
 * @method $this|AbstractColumn integer(int $size, bool $unsigned = false, $zerofill = false)
 * @method $this|AbstractColumn tinyInteger(int $size, bool $unsigned = false, $zerofill = false)
 * @method $this|AbstractColumn smallInteger(int $size, bool $unsigned = false, $zerofill = false)
 * @method $this|AbstractColumn bigInteger(int $size, bool $unsigned = false, $zerofill = false)
 * @method $this|AbstractColumn unsigned(bool $value)
 * @method $this|AbstractColumn zerofill(bool $value)
 * @method $this|AbstractColumn comment(string $value)
 */
class MySQLColumn extends AbstractColumn
{
    /**
     * Default timestamp expression ().
     */
    public const DATETIME_NOW = 'CURRENT_TIMESTAMP';

    public const EXCLUDE_FROM_COMPARE = ['size', 'timezone', 'userType', 'attributes'];
    protected const INTEGER_TYPES = ['tinyint', 'smallint', 'mediumint', 'int', 'bigint'];

    protected array $mapping = [
        //Primary sequences
        'primary'     => [
            'type'          => 'int',
            'size'          => 11,
            'autoIncrement' => true,
            'nullable'      => false,
        ],
        'smallPrimary'  => [
            'type'          => 'smallint',
            'size'          => 6,
            'autoIncrement' => true,
            'nullable'      => false,
        ],
        'bigPrimary'  => [
            'type'          => 'bigint',
            'size'          => 20,
            'autoIncrement' => true,
            'nullable'      => false,
        ],

        //Enum type (mapped via method)
        'enum'        => 'enum',

        //Set type (mapped via method)
        'set'         => 'set',

        //Logical types
        'boolean'     => ['type' => 'tinyint', 'size' => 1],

        //Integer types (size can always be changed with size method), longInteger has method alias
        //bigInteger
        'integer'     => ['type' => 'int', 'size' => 11, 'unsigned' => false, 'zerofill' => false],
        'tinyInteger' => ['type' => 'tinyint', 'size' => 4, 'unsigned' => false, 'zerofill' => false],
        'smallInteger' => ['type' => 'smallint', 'size' => 6, 'unsigned' => false, 'zerofill' => false],
        'bigInteger'  => ['type' => 'bigint', 'size' => 20, 'unsigned' => false, 'zerofill' => false],

        //String with specified length (mapped via method)
        'string'      => ['type' => 'varchar', 'size' => 255],

        //Generic types
        'text'        => 'text',
        'tinyText'    => 'tinytext',
        'mediumText'  => 'mediumtext',
        'longText'    => 'longtext',

        //Real types
        'double'      => 'double',
        'float'       => 'float',

        //Decimal type (mapped via method)
        'decimal'     => 'decimal',

        //Date and Time types
        'datetime'    => 'datetime',
        'date'        => 'date',
        'time'        => 'time',
        'timestamp'   => ['type' => 'timestamp', 'defaultValue' => null],

        //Binary types
        'binary'      => 'blob',
        'tinyBinary'  => 'tinyblob',
        'longBinary'  => 'longblob',
        'varbinary'   => ['type' => 'varbinary', 'size' => 255],

        //Additional types
        'json'        => 'json',
        'uuid'        => ['type' => 'varchar', 'size' => 36],
    ];
    protected array $reverseMapping = [
        'primary'     => [['type' => 'int', 'autoIncrement' => true]],
        'bigPrimary'  => ['serial', ['type' => 'bigint', 'size' => 20, 'autoIncrement' => true]],
        'enum'        => ['enum'],
        'set'         => ['set'],
        'boolean'     => ['bool', 'boolean', ['type' => 'tinyint', 'size' => 1]],
        'integer'     => ['int', 'integer', 'mediumint'],
        'tinyInteger' => ['tinyint'],
        'smallInteger' => ['smallint'],
        'bigInteger'  => ['bigint'],
        'string'      => ['varchar', 'char'],
        'text'        => ['text'],
        'tinyText'    => ['tinytext'],
        'mediumText'  => ['mediumtext'],
        'longText'    => ['longtext'],
        'double'      => ['double'],
        'float'       => ['float', 'real'],
        'decimal'     => ['decimal'],
        'datetime'    => ['datetime'],
        'date'        => ['date'],
        'time'        => ['time'],
        'timestamp'   => ['timestamp'],
        'binary'      => ['blob', 'binary', 'varbinary'],
        'tinyBinary'  => ['tinyblob'],
        'longBinary'  => ['longblob'],
        'json'        => ['json'],
    ];

    /**
     * List of types forbids default value set.
     */
    protected array $forbiddenDefaults = [
        'text',
        'mediumtext',
        'tinytext',
        'longtext',
        'blob',
        'tinyblob',
        'longblob',
        'json',
    ];

    #[ColumnAttribute(
        ['int', 'tinyint', 'smallint', 'bigint', 'varchar', 'varbinary', 'time', 'datetime', 'timestamp'],
    )]
    protected int $size = 0;

    /**
     * Column is auto incremental.
     */
    #[ColumnAttribute(self::INTEGER_TYPES)]
    protected bool $autoIncrement = false;

    /**
     * Unsigned integer type. Related to {@see INTEGER_TYPES} only.
     */
    #[ColumnAttribute(self::INTEGER_TYPES)]
    protected bool $unsigned = false;

    /**
     * Zerofill option. Related to {@see INTEGER_TYPES} only.
     */
    #[ColumnAttribute(self::INTEGER_TYPES)]
    protected bool $zerofill = false;

    /**
     * Column comment.
     */
    #[ColumnAttribute]
    protected string $comment = '';

    /**
     * @psalm-param non-empty-string $table
     */
    public static function createInstance(string $table, array $schema, ?\DateTimeZone $timezone = null): self
    {
        $column = new self($table, $schema['Field'], $timezone);

        $column->type = $schema['Type'];

        $column->comment = $schema['Comment'];
        $column->nullable = \strtolower($schema['Null']) === 'yes';

        $column->defaultValue = $schema['Default'];

        $column->autoIncrement = \stripos($schema['Extra'], 'auto_increment') !== false;

        if (
            !\preg_match(
                '/^(?P<type>[a-z]+)(?:\((?P<options>[^)]+)\))?(?: (?P<attr>[a-z ]+))?/',
                $column->type,
                $matches,
            )
        ) {
            //No extra definitions
            return $column;
        }

        $column->type = $matches['type'];

        $options = [];
        if (!empty($matches['options'])) {
            $options = \explode(',', $matches['options']);

            if (\count($options) > 1) {
                $column->precision = (int) $options[0];

                $column->scale = (int) $options[1];

            } else {
                $column->size = (int) $options[0];
            }
        }

        if (!empty($matches['attr'])) {
            if (\in_array($column->type, self::INTEGER_TYPES, true)) {
                $intAttr = \array_map('trim', \explode(' ', $matches['attr']));
                if (\in_array('unsigned', $intAttr, true)) {
                    $column->unsigned = true;
                }
                if (\in_array('zerofill', $intAttr, true)) {
                    $column->zerofill = true;
                }
                unset($intAttr);
            }
        }

        // since 8.0 database does not provide size for some columns
        if ($column->size === 0) {
            switch ($column->type) {
                case 'int':
                    $column->size = 11;
                    break;
                case 'bigint':
                    $column->size = 20;
                    break;
                case 'tinyint':
                    $column->size = 4;
                    break;
                case 'smallint':
                    $column->size = 6;
                    break;
            }
        }

        //Fetching enum and set values
        if ($options !== [] && static::isEnum($column)) {
            $column->enumValues = \array_map(static fn($value) => \trim($value, $value[0]), $options);


            return $column;
        }

        //Default value conversions
        if ($column->type === 'bit' && $column->hasDefaultValue()) {
            //Cutting b\ and '
            $column->defaultValue = new Fragment($column->defaultValue);
        }

        if (
            $column->defaultValue === '0000-00-00 00:00:00'
            && $column->getAbstractType() === 'timestamp'
        ) {
            //Normalizing default value for timestamps
            $column->defaultValue = 0;
        }

        return $column;
    }

    /**
     * @psalm-return non-empty-string
     */
    public function sqlStatement(DriverInterface $driver): string
    {
        if (\in_array($this->type, self::INTEGER_TYPES, true)) {
            return $this->sqlStatementInteger($driver);
        }

        $defaultValue = $this->defaultValue;

        if (\in_array($this->type, $this->forbiddenDefaults, true)) {
            //Flushing default value for forbidden types
            $this->defaultValue = null;

        }

        $statement = parent::sqlStatement($driver);

        $this->defaultValue = $defaultValue;

        if ($this->comment !== '') {
            return "{$statement} COMMENT {$driver->quote($this->comment)}";
        }

        return $statement;
    }

    public function compare(AbstractColumn $initial): bool
    {
        $result = parent::compare($initial);

        if ($this->type === 'varchar' || $this->type === 'varbinary') {
            return $result && $this->size === $initial->size;
        }

        return $result;
    }

    public function isUnsigned(): bool
    {
        return $this->unsigned;
    }

    public function isZerofill(): bool
    {
        return $this->zerofill;
    }

    public function set(string|array $values): self
    {
        $this->type('set');
        $this->enumValues = \array_map('strval', \is_array($values) ? $values : \func_get_args());


        return $this;
    }

    /**
     * @param int<0, max> $size
     */
    public function varbinary(int $size = 255): self
    {
        $this->type('varbinary');

        $size < 0 && throw new SchemaException('Invalid varbinary size value');

        $this->size = $size;

        return $this;
    }

    /**
     * If a size is provided, a varbinary column of the specified size will be created.
     * Otherwise, a blob type column will be created.
     *
     * @param int<0, max> $size
     */
    public function binary(int $size = 0): self
    {
        if ($size > 0) {
            return $this->varbinary($size);
        }

        $this->type('blob');

        return $this;
    }

    public function getComment(): string
    {
        return $this->comment;
    }

    protected static function isEnum(AbstractColumn $column): bool
    {
        return $column->getAbstractType() === 'enum' || $column->getAbstractType() === 'set';
    }

    /**
     * Ensure that datetime fields are correctly formatted.
     *
     * @psalm-param non-empty-string $type
     *
     * @throws DefaultValueException
     */
    protected function formatDatetime(
        string $type,
        string|int|\DateTimeInterface $value,
    ): \DateTimeInterface|FragmentInterface|string {
        if ($value === 'current_timestamp()') {
            $value = self::DATETIME_NOW;
        }

        return parent::formatDatetime($type, $value);
    }

    private function sqlStatementInteger(DriverInterface $driver): string
    {
        return \sprintf(
            '%s %s(%s)%s%s%s%s%s%s',
            $driver->identifier($this->name),
                     identifier($this->name),
            $this->type,
            $this->size,
            $this->unsigned ? ' UNSIGNED' : '',
            $this->comment !== '' ? " COMMENT {$driver->quote($this->comment)}" : '',
            $this->zerofill ? ' ZEROFILL' : '',
            $this->nullable ? ' NULL' : ' NOT NULL',
            $this->defaultValue !== null ? " DEFAULT {$this->quoteDefault($driver)}" : '',
            $this->autoIncrement ? ' AUTO_INCREMENT' : '',
        );
    }
}

cycle / database

Push — 2.x ( a18c78...0f4623 )

MySQLColumn::getComment() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
