Rougin\Describe\Describe

Complexity

Total Complexity

10

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

92%

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getPrimaryKey()	0	16	4
A	showTables()	0	4	1
A	getTable()	0	12	3
A	__call()	0	4	1

<?php

namespace Rougin\Describe;

/**
 * Describe
 *
 * Gets information of a table schema from a database.
 *
 * @package Describe
 * @author  Rougin Royce Gutib <rougingutib@gmail.com>
 */
class Describe
{
    /**
     * @var array
     */
    protected $columns = [];

    /**
     * @var \Rougin\Describe\Driver\DriverInterface
     */
    protected $driver;

    /**
     * @param \Rougin\Describe\Driver\DriverInterface $driver
     */
    public function __construct(\Rougin\Describe\Driver\DriverInterface $driver)
    {
        $this->driver = $driver;
    }

    /**
     * Gets the primary key in the specified table.
     *
     * @param  string $tableName
     * @return string
     */
    public function getPrimaryKey($tableName)
    {
        $result = '';

        if (empty($this->columns)) {
            $this->columns = $this->driver->getTable($tableName);
        }

        foreach ($this->columns as $column) {
            if ($column->isPrimaryKey()) {
                $result = $column->getField();
            }
        }

        return $result;
    }

    /**
     * Returns the result.
     *
     * @param  string $tableName
     * @return array
     * @throws \Rougin\Describe\Exceptions\TableNameNotFoundException
     */
    public function getTable($tableName)
    {
        $table = $this->driver->getTable($tableName);

        if (empty($table) || is_null($table)) {
            $message = '"' . $tableName . '" table not found in database!';

            throw new Exceptions\TableNameNotFoundException($message);
        }

        return $table;
    }

    /**
     * Shows the list of tables.
     *
     * @return array
     */
    public function showTables()
    {
        return $this->driver->showTables();
    }

    /**
     * Calls methods from this class in underscore case.
     *
     * @param  string $method
     * @param  mixed  $parameters
     * @return mixed
     */
    public function __call($method, $parameters)
    {
        return MagicMethodHelper::call($this, $method, $parameters);
    }
}