Yiisoft\Db\Mysql\Column

Complexity

Total Complexity

5

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	buildCommentString()	0	7	2
A	buildUnsignedString()	0	3	2
A	asString()	0	11	1

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Mysql;

use Exception;
use Yiisoft\Db\Schema\Builder\AbstractColumn;

/**
 * Provides a convenient way to create column schema for use with {@see `\Yiisoft\Db\Mysql\Schema`}
 * for MySQL, MariaDB.
 *
 * It has methods for specifying the properties of a column, such as its type, size, default value, and whether it
 * is nullable or not. It also provides a method for creating a column schema based on the specified properties.
 *
 * For example, the following code creates a column schema for an integer column:
 *
 * ```php
 * $column = (new Column(SchemaInterface::TYPE_INTEGER))->notNull()->defaultValue(0);
 * ```
 *
 * Provides a fluent interface, which means that the methods can be chained together to create a column schema with
 * many properties in a single line of code.
 */
final class Column extends AbstractColumn
{
    /**
     * Builds the unsigned string for column. Defaults to unsupported.
     *
     * @return string A string containing `UNSIGNED` keyword.
     */
    protected function buildUnsignedString(): string
    {
        return $this->isUnsigned() ? ' UNSIGNED' : '';
    }

    /**
     * Builds the comment specification for the column.
     *
     * @throws Exception
     *
     * @return string A string containing the `COMMENT` keyword and the comment itself.
     */
    protected function buildCommentString(): string
    {
        if ($this->getComment() === null) {
            return '';
        }

        return ' COMMENT ' . (string) (new Quoter('`', '`'))->quoteValue($this->getComment());
    }

    public function asString(): string
    {
        $format = match ($this->getTypeCategory()) {
            self::TYPE_CATEGORY_PK => '{type}{length}{comment}{check}{append}',
            self::TYPE_CATEGORY_NUMERIC => '{type}{length}{unsigned}{notnull}{default}{unique}{comment}{append}{check}',
            self::TYPE_CATEGORY_UUID => '{type}{notnull}{unique}{default}{check}{comment}{append}',
            self::TYPE_CATEGORY_UUID_PK => '{type}{notnull}{default}{check}{comment}{append}',
            default => '{type}{length}{notnull}{default}{unique}{comment}{append}{check}',
        };

        return $this->buildCompleteString($format);
    }
}