Yiisoft\Db\Schema\TableSchema

Complexity

Total Complexity

24

Size/Duplication

Total Lines	196
Duplicated Lines	0 %

Test Coverage

Coverage

77.27%

Importance

Changes	2
Bugs	0	Features	0

24 Methods

Rating	Name	Duplication	Size	Complexity
A	getPrimaryKey()	0	3	1
A	getColumnNames()	0	3	1
A	foreignKeys()	0	3	1
A	serverName()	0	3	1
A	name()	0	3	1
A	getSequenceName()	0	3	1
A	compositeFK()	0	3	1
A	schemaName()	0	3	1
A	getCreateSql()	0	3	1
A	getName()	0	3	1
A	getServerName()	0	3	1
A	sequenceName()	0	3	1
A	getColumns()	0	3	1
A	getForeignKeys()	0	3	1
A	createSql()	0	3	1
A	foreignKey()	0	3	1
A	catalogName()	0	3	1
A	getColumn()	0	3	1
A	getSchemaName()	0	3	1
A	getFullName()	0	3	1
A	columns()	0	3	1
A	primaryKey()	0	3	1
A	fullName()	0	3	1
A	getCatalogName()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Schema;

use Yiisoft\Db\Exception\NotSupportedException;
use function array_keys;

/**
 * TableSchema represents the metadata of a database table.
 *
 * @property array $columnNames List of column names. This property is read-only.
 */
abstract class TableSchema implements TableSchemaInterface
{
    private ?string $schemaName = null;
    private string $name = '';
    private ?string $fullName = null;
    private ?string $sequenceName = null;
    /** @psalm-var string[] */
    private array $primaryKey = [];
    /** @psalm-var ColumnSchemaInterface[] */
    private array $columns = [];
    /** @psalm-var array<array-key, array> */
    protected array $foreignKeys = [];
    protected ?string $createSql = null;
    private ?string $catalogName = null;
    private ?string $serverName = null;

    /**
     * Gets the named column metadata.
     *
     * This is a convenient method for retrieving a named column even if it does not exist.
     *
     * @param string $name column name
     *
     * @return ColumnSchemaInterface|null metadata of the named column. Null if the named column does not exist.
     */
    public function getColumn(string $name): ?ColumnSchemaInterface
    {
        return $this->columns[$name] ?? null;
    }

    /**
     * Returns the names of all columns in this table.
     *
     * @return array list of column names
     */
    public function getColumnNames(): array
    {
        return array_keys($this->columns);
    }

    /**
     * @return string|null the name of the schema that this table belongs to.
     */
    public function getSchemaName(): ?string
    {
        return $this->schemaName;
    }

    /**
     * @return string the name of this table. The schema name is not included. Use {@see fullName} to get the name with
     * schema name prefix.
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * @return string|null the full name of this table, which includes the schema name prefix, if any. Note that if the
     * schema name is the same as the {@see Schema::defaultSchema|default schema name}, the schema name will not be
     * included.
     */
    public function getFullName(): ?string
    {
        return $this->fullName;
    }

    /**
     * @return string|null sequence name for the primary key. Null if no sequence.
     */
    public function getSequenceName(): ?string
    {
        return $this->sequenceName;
    }

    /**
     * @return array primary keys of this table.
     *
     * @psalm-return string[]
     */
    public function getPrimaryKey(): array
    {
        return $this->primaryKey;
    }

    /**
     * @return array column metadata of this table. Each array element is a {@see ColumnSchemaInterface} object, indexed by
     * column names.
     *
     * @psalm-return ColumnSchemaInterface[]
     */
    public function getColumns(): array
    {
        return $this->columns;
    }

    public function schemaName(?string $value): void
    {
        $this->schemaName = $value;
    }

    public function name(string $value): void
    {
        $this->name = $value;
    }

    public function fullName(?string $value): void
    {
        $this->fullName = $value;
    }

    public function sequenceName(?string $value): void
    {
        $this->sequenceName = $value;
    }

    public function primaryKey(string $value): void
    {
        $this->primaryKey[] = $value;
    }

    public function columns(string $index, ColumnSchemaInterface $value): void
    {
        $this->columns[$index] = $value;
    }

    public function getCatalogName(): ?string
    {
        return $this->catalogName;
    }

    /**
     * @param string|null name of the catalog (database) that this table belongs to. Defaults to null, meaning no

The type Yiisoft\Db\Schema\name was not found. Maybe you did not declare it correctly or list all dependencies?

     * catalog (or the current database).
     */
    public function catalogName(?string $value): void
    {
        $this->catalogName = $value;
    }

    public function getServerName(): ?string
    {
        return $this->serverName;
    }

    /**
     * @param string|null name of the server
     */
    public function serverName(?string $value): void
    {
        $this->serverName = $value;
    }

    public function getCreateSql(): ?string
    {
        return $this->createSql;
    }

    public function createSql(string $sql): void
    {
        $this->createSql = $sql;
    }

    /**
     * ```php
     * [
     *  'ForeignTableName',
     *  'fk1' => 'pk1',  // pk1 is in foreign table
     *  'fk2' => 'pk2',  // if composite foreign key
     * ]
     * ```
     *
     * @return array foreign keys of this table. Each array element is of the following structure:
     * @psalm-return array<array-key, array>
     */
    public function getForeignKeys(): array
    {
        return $this->foreignKeys;
    }

    /**
     * @psalm-param array<array-key, array> $value
     */
    public function foreignKeys(array $value): void
    {
        $this->foreignKeys = $value;
    }

    public function foreignKey(string|int $id, array $to): void
    {
        $this->foreignKeys[$id] = $to;
    }

    public function compositeFK(int $id, string $from, string $to): void
    {
        throw new NotSupportedException('Composite foreign key not supported');
    }
}