Backpack\CRUD\app\Library\Database\TableSchema

Complexity

Total Complexity

21

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	schemaExists()	0	7	2
A	hasColumn()	0	7	2
A	columnExists()	0	7	2
A	columnIsNullable()	0	9	3
A	columnHasDefault()	0	9	3
A	getColumnDefault()	0	9	2
A	__construct()	0	3	1
A	getColumnType()	0	9	3
A	getColumnsNames()	0	6	1
A	getColumns()	0	7	2

<?php

namespace Backpack\CRUD\app\Library\Database;

class TableSchema
{
    /** @var Doctrine\DBAL\Schema\Table|Backpack\CRUD\app\Library\Database\Table */

The type Backpack\CRUD\app\Library\Database\Doctrine\DBAL\Schema\Table was not found. Did you mean Doctrine\DBAL\Schema\Table? If so, make sure to prefix the type with \.

The type Backpack\CRUD\app\Library\Database\Backpack\CRUD\app\Library\Database\Table was not found. Did you mean Backpack\CRUD\app\Library\Database\Table? If so, make sure to prefix the type with \.

    public $schema;

    public function __construct(string $connection, string $table)
    {
        $this->schema = app('DatabaseSchema')->getForTable($connection, $table);
    }

    /**
     * Return an array of column names in database.
     *
     * @return array
     */
    public function getColumnsNames()
    {
        return array_values(
            array_map(function ($item) {
                return $item->getName();
            }, $this->getColumns())
        );
    }

    /**
     * Return the column type in database.
     *
     * @param  string  $columnName
     * @return string
     */
    public function getColumnType(string $columnName)
    {
        if (! $this->schemaExists() || ! $this->schema->hasColumn($columnName)) {
            return 'varchar';
        }

        $column = $this->schema->getColumn($columnName);

        return $column->getType()->getName();
    }

    /**
     * Check if the column exists in the database.
     *
     * @param  string  $columnName
     * @return bool
     */
    public function hasColumn($columnName)
    {
        if (! $this->schemaExists()) {
            return false;
        }

        return $this->schema->hasColumn($columnName);
    }

    /**
     * Check if the column is nullable in database.
     *
     * @param  string  $columnName
     * @return bool
     */
    public function columnIsNullable($columnName)
    {
        if (! $this->columnExists($columnName)) {
            return true;
        }

        $column = $this->schema->getColumn($columnName);

        return $column->getNotnull() ? false : true;
    }

    /**
     * Check if the column has default value set on database.
     *
     * @param  string  $columnName
     * @return bool
     */
    public function columnHasDefault($columnName)
    {
        if (! $this->columnExists($columnName)) {
            return false;
        }

        $column = $this->schema->getColumn($columnName);

        return $column->getDefault() !== null ? true : false;
    }

    /**
     * Get the default value for a column on database.
     *
     * @param  string  $columnName
     * @return bool
     */
    public function getColumnDefault($columnName)
    {
        if (! $this->columnExists($columnName)) {
            return false;
        }

        $column = $this->schema->getColumn($columnName);

        return $column->getDefault();
    }

    /**
     * Get the table schema columns.
     *
     * @return array
     */
    public function getColumns()
    {
        if (! $this->schemaExists()) {
            return [];
        }

        return $this->schema->getColumns();
    }

    /**
     * Make sure column exists or throw an exception.
     *
     * @param  string  $columnName
     * @return bool
     */
    private function columnExists($columnName)
    {
        if (! $this->schemaExists()) {
            return false;
        }

        return $this->schema->hasColumn($columnName);
    }

    /**
     * Make sure the schema for the connection is initialized.
     *
     * @return bool
     */
    private function schemaExists()
    {
        if (! empty($this->schema)) {
            return true;
        }

        return false;
    }
}