NormalistModels::getRelations() - Code Metrics - Inspection of "Updated to latest soluble/schema" - belgattitude/solublecomponents - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 023690...819b2d )

by Sébastien

created 2015-12-30 18:51 UTC

NormalistModels::getRelations() A

↳ Parent: NormalistModels

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Metric	Value
dl	0
loc	5
ccs	3
cts	3
cp	1
rs	9.4286
cc	1
eloc	3
nc	1
nop	1
crap	1

<?php
namespace Soluble\Normalist\Driver\Metadata;

use Soluble\Schema\Source;
use Soluble\Schema\Exception;

class NormalistModels extends Source\AbstractSource

{
    /**
     * Current class version
     */
    const VERSION = '1.0';

    /**
     * @var array
     */
    protected $model_definition;

    /**
     * @param array $model_definition
     */
    public function __construct(array $model_definition)
    {
        $this->model_definition = $model_definition;
    }


    /**
     * Get unique keys on table
     *
     * @param string $table table name
     * @param boolean $include_primary include primary keys in the list
     * @throws Exception\InvalidArgumentException
     * @throws Exception\ErrorException
     * @throws Exception\NoPrimaryKeyException
     * @throws Exception\ExceptionInterface
     * @throws Exception\TableNotFoundException
     * @return array
     */
    public function getUniqueKeys($table, $include_primary = false)
    {
        $this->checkTableArgument($table);
        return $this->model_definition['tables'][$table]['unique_keys'];
    }


    /**
     * Return indexes information on a table
     *
     * @param string $table table name
     * @throws Exception\InvalidArgumentException
     * @throws Exception\ErrorException
     * @throws Exception\ExceptionInterface
     * @throws Exception\TableNotFoundException
     *
     * @return array
     */
    public function getIndexesInformation($table)
    {
        $this->checkTableArgument($table);
        return $this->model_definition['tables'][$table]['indexes'];
    }

    /**
     * Return unique table primary key
     *
     * @throws Exception\InvalidArgumentException
     * @throws Exception\ErrorException
     * @throws Exception\NoPrimaryKeyException when no pk
     * @throws Exception\MultiplePrimaryKeyException when multiple pk found
     * @throws Exception\ExceptionInterface
     * @throws Exception\TableNotFoundException
     *
     * @param string $table
     * @return string|int primary key
     */
    public function getPrimaryKey($table)
    {
        $this->checkTableArgument($table);
        $pks = $this->getPrimaryKeys($table);
        if (count($pks) > 1) {
            $keys = join(',', $pks);
            throw new Exception\MultiplePrimaryKeyException(__METHOD__ . ". Multiple primary keys found on table '$table':  $keys");
        }
        return $pks[0];
    }


    /**
     * Return composite primary keys
     *
     * @throws Exception\InvalidArgumentException
     * @throws Exception\ErrorException
     * @throws Exception\NoPrimaryKeyException
     * @throws Exception\ExceptionInterface
     * @throws Exception\TableNotFoundException
     *
     * @param string $table
     * @return array primary keys
     */
    public function getPrimaryKeys($table)
    {
        $this->checkTableArgument($table);
        $pks = $this->model_definition['tables'][$table]['primary_keys'];
        if (count($pks) == 0) {
            throw new Exception\NoPrimaryKeyException(__METHOD__ . ". No primary keys found on table '$table'.");
        }
        return $pks;
    }


    /**
     * Return column information
     *
     * @throws Exception\InvalidArgumentException
     * @throws Exception\ErrorException
     * @throws Exception\ExceptionInterface
     * @throws Exception\TableNotFoundException
     *
     * @param string $table
     * @return array associative array [column_name => infos]
     */
    public function getColumnsInformation($table)
    {
        $this->checkTableArgument($table);
        return $this->model_definition['tables'][$table]['columns'];
    }


    /**
     * {@inheritdoc}
     */
    public function getForeignKeys($table)
    {
        $this->checkTableArgument($table);
        return $this->model_definition['tables'][$table]['foreign_keys'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSchemaConfig()
    {
        return $this->model_definition;
    }

    /**
     * {@inheritdoc}
     */    
    public function getReferences($table)
    {
        $this->checkTableArgument($table);
        return $this->model_definition['tables'][$table]['references'];
    }
    

    /**
     * Return table informations
     *
     * @throws Exception\InvalidArgumentException
     * @throws Exception\ErrorException
     * @throws Exception\ExceptionInterface
     *
     * @return array associative array indexed by table_name
     */
    public function getTablesInformation()
    {
        return $this->model_definition['tables'];
    }
}


1		<?php
2		namespace Soluble\Normalist\Driver\Metadata;
3
4		use Soluble\Schema\Source;
5		use Soluble\Schema\Exception;
6
7		class NormalistModels extends Source\AbstractSource
		0 ignored issues – show Bug introduced 2015-12-30 18:57 UTC by Report Bug Copy Issue Report There is one abstract method `getRelations` in this class; you could implement it, or declare this class as abstract. Loading history...
8		{
9		/**
10		* Current class version
11		*/
12		const VERSION = '1.0';
13
14		/**
15		* @var array
16		*/
17		protected $model_definition;
18
19		/**
20		* @param array $model_definition
21		*/
22	17	public function __construct(array $model_definition)
23		{
24	17	$this->model_definition = $model_definition;
25	17	}
26
27
28		/**
29		* Get unique keys on table
30		*
31		* @param string $table table name
32		* @param boolean $include_primary include primary keys in the list
33		* @throws Exception\InvalidArgumentException
34		* @throws Exception\ErrorException
35		* @throws Exception\NoPrimaryKeyException
36		* @throws Exception\ExceptionInterface
37		* @throws Exception\TableNotFoundException
38		* @return array
39		*/
40	1	public function getUniqueKeys($table, $include_primary = false)
41		{
42	1	$this->checkTableArgument($table);
43	1	return $this->model_definition['tables'][$table]['unique_keys'];
44		}
45
46
47		/**
48		* Return indexes information on a table
49		*
50		* @param string $table table name
51		* @throws Exception\InvalidArgumentException
52		* @throws Exception\ErrorException
53		* @throws Exception\ExceptionInterface
54		* @throws Exception\TableNotFoundException
55		*
56		* @return array
57		*/
58		public function getIndexesInformation($table)
59		{
60		$this->checkTableArgument($table);
61		return $this->model_definition['tables'][$table]['indexes'];
62		}
63
64		/**
65		* Return unique table primary key
66		*
67		* @throws Exception\InvalidArgumentException
68		* @throws Exception\ErrorException
69		* @throws Exception\NoPrimaryKeyException when no pk
70		* @throws Exception\MultiplePrimaryKeyException when multiple pk found
71		* @throws Exception\ExceptionInterface
72		* @throws Exception\TableNotFoundException
73		*
74		* @param string $table
75		* @return string\|int primary key
76		*/
77	4	public function getPrimaryKey($table)
78		{
79	4	$this->checkTableArgument($table);
80	3	$pks = $this->getPrimaryKeys($table);
81	2	if (count($pks) > 1) {
82	1	$keys = join(',', $pks);
83	1	throw new Exception\MultiplePrimaryKeyException(__METHOD__ . ". Multiple primary keys found on table '$table': $keys");
84		}
85	1	return $pks[0];
86		}
87
88
89		/**
90		* Return composite primary keys
91		*
92		* @throws Exception\InvalidArgumentException
93		* @throws Exception\ErrorException
94		* @throws Exception\NoPrimaryKeyException
95		* @throws Exception\ExceptionInterface
96		* @throws Exception\TableNotFoundException
97		*
98		* @param string $table
99		* @return array primary keys
100		*/
101	6	public function getPrimaryKeys($table)
102		{
103	6	$this->checkTableArgument($table);
104	5	$pks = $this->model_definition['tables'][$table]['primary_keys'];
105	5	if (count($pks) == 0) {
106	2	throw new Exception\NoPrimaryKeyException(__METHOD__ . ". No primary keys found on table '$table'.");
107		}
108	3	return $pks;
109		}
110
111
112		/**
113		* Return column information
114		*
115		* @throws Exception\InvalidArgumentException
116		* @throws Exception\ErrorException
117		* @throws Exception\ExceptionInterface
118		* @throws Exception\TableNotFoundException
119		*
120		* @param string $table
121		* @return array associative array [column_name => infos]
122		*/
123	1	public function getColumnsInformation($table)
124		{
125	1	$this->checkTableArgument($table);
126	1	return $this->model_definition['tables'][$table]['columns'];
127		}
128
129
130		/**
131		* {@inheritdoc}
132		*/
133	1	public function getForeignKeys($table)
134		{
135	1	$this->checkTableArgument($table);
136	1	return $this->model_definition['tables'][$table]['foreign_keys'];
137		}
138
139		/**
140		* {@inheritdoc}
141		*/
142		public function getSchemaConfig()
143		{
144		return $this->model_definition;
145		}
146
147		/**
148		* {@inheritdoc}
149		*/
150		public function getReferences($table)
151		{
152		$this->checkTableArgument($table);
153		return $this->model_definition['tables'][$table]['references'];
154		}
155
156
157		/**
158		* Return table informations
159		*
160		* @throws Exception\InvalidArgumentException
161		* @throws Exception\ErrorException
162		* @throws Exception\ExceptionInterface
163		*
164		* @return array associative array indexed by table_name
165		*/
166	1	public function getTablesInformation()
167		{
168	1	return $this->model_definition['tables'];
169		}
170		}
171

belgattitude / solublecomponents

Push — master ( 023690...819b2d )

NormalistModels::getRelations() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like