Rougin\Describe\Table

Complexity

Total Complexity

7

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	primary()	0	9	4
A	columns()	0	3	1
A	name()	0	3	1

<?php

namespace Rougin\Describe;

use Rougin\Describe\Driver\DriverInterface;

/**
 * Table
 *
 * Stores the table information from the given results.
 *
 * @package Describe
 * @author  Rougin Gutib <rougingutib@gmail.com>
 */
class Table
{
    /**
     * @var \Rougin\Describe\Driver\DriverInterface
     */
    protected $driver;

    /**
     * @var string
     */
    protected $name;

    /**
     * Initializes the table instance.
     *
     * @param string                                  $name
     * @param \Rougin\Describe\Driver\DriverInterface $driver
     */
    public function __construct($name, DriverInterface $driver)
    {
        $this->driver = $driver;

        $this->name = (string) $name;
    }

    /**
     * Returns an array of Column instances.
     *
     * @return \Rougin\Describe\Column[]
     */
    public function columns()
    {
        return $this->driver->columns($this->name);
    }

    /**
     * Returns the name of the table.
     *
     * @return string
     */
    public function name()
    {
        return $this->name;
    }

    /**
     * Returns the primary key of a table.
     *
     * @return \Rougin\Describe\Column|null
     */
    public function primary()
    {
        foreach ($this->columns() as $column) {
            $primary = $column->isPrimaryKey();

            $primary && $result = $column;
        }

        return isset($result) ? $result : null;
    }
}