MySQLDriver::getColumns() - Code Metrics - Inspection of "Add getColumns and getTableNames" - rougin/describe - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5)

by Rougin

created 2017-01-04 04:42 UTC

MySQLDriver::getColumns() A

↳ Parent: MySQLDriver

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php

namespace Rougin\Describe\Driver;

use Rougin\Describe\Column;

/**
 * MySQL Driver
 *
 * A database driver extension for MySQL.
 *
 * @package  Describe
 * @category Driver
 * @author   Rougin Royce Gutib <[email protected]>
 */
class MySQLDriver extends AbstractDriver implements DriverInterface
{
    /**
     * @var string
     */
    protected $database;

    /**
     * @var \PDO
     */
    protected $pdo;

    /**
     * @param PDO    $pdo
     * @param string $database
     */
    public function __construct(\PDO $pdo, $database)
    {
        $this->database = $database;
        $this->pdo = $pdo;
    }

    /**
     * Returns a listing of columns from the specified table.
     *
     * @param  string $tableName
     * @return array
     * @throws \Rougin\Describe\Exceptions\TableNameNotFoundException
     */
    public function getColumns($tableName)
    {
        return $this->getColumnsFromQuery($tableName, 'DESCRIBE ' . $tableName);
    }

    /**
     * Returns a listing of columns from the specified table.
     * NOTE: To be removed in v2.0.0.
     *
     * @param  string $tableName
     * @return array
     * @throws \Rougin\Describe\Exceptions\TableNameNotFoundException
     */
    public function getTable($tableName)
    {
        return $this->getColumns($tableName);
    }

    /**
     * Returns a listing of tables from the specified database.
     *
     * @return array
     */
    public function getTableNames()
    {
        return $this->showTables();
    }

    /**
     * Shows the list of tables.
     * NOTE: To be removed in v2.0.0.
     *
     * @return array
     */
    public function showTables()
    {
        $tables = [];

        $information = $this->pdo->prepare('SHOW TABLES');
        $information->execute();

        while ($row = $information->fetch()) {
            array_push($tables, $row[0]);
        }

        return $tables;
    }

    /**
     * Prepares the defined columns.
     *
     * @param  string $tableName
     * @param  mixed  $row
     * @return \Rougin\Describe\Column
     */
    protected function setColumn($tableName, $row)
    {
        preg_match('/(.*?)\((.*?)\)/', $row->Type, $match);

        $column = new Column;


        $column->setDataType($row->Type);
        $column->setDefaultValue($row->Default);
        $column->setField($row->Field);

        if (isset($match[1])) {
            $column->setDataType($match[1]);
            $column->setLength($match[2]);
        }

        $column = $this->setProperties($row, $column);
        $column = $this->setKey($row, $column);
        $column = $this->setForeignColumn($tableName, $row, $column);

        return $column;
    }

    /**
     * Sets the key of the specified column.
     *
     * @param  mixed                   $row
     * @param  \Rougin\Describe\Column $column
     * @return \Rougin\Describe\Column
     */
    protected function setKey($row, Column $column)
    {
        switch ($row->Key) {
            case 'PRI':
                $column->setPrimary(true);

                break;
            
            case 'MUL':
                $column->setForeign(true);

                break;

            case 'UNI':
                $column->setUnique(true);

                break;
        }

        return $column;
    }

    /**
     * Sets the properties of the specified column if it does exists.
     *
     * @param  string                  $tableName
     * @param  mixed                   $row
     * @param  \Rougin\Describe\Column $column
     * @return \Rougin\Describe\Column
     */
    protected function setForeignColumn($tableName, $row, Column $column)
    {
        $query = 'SELECT COLUMN_NAME as "column", REFERENCED_COLUMN_NAME as "referenced_column",' .
            'CONCAT(REFERENCED_TABLE_SCHEMA, ".", REFERENCED_TABLE_NAME) as "referenced_table"' .
            'FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE ' .
            'WHERE CONSTRAINT_SCHEMA = "' . $this->database . '" AND TABLE_NAME = "' . $tableName . '";';

        $foreignTable = $this->pdo->prepare($query);

        $foreignTable->execute();
        $foreignTable->setFetchMode(\PDO::FETCH_OBJ);

        while ($foreignRow = $foreignTable->fetch()) {
            if ($foreignRow->column == $row->Field) {
                $referencedTable = $this->stripTableSchema($foreignRow->referenced_table);

                $column->setReferencedField($foreignRow->referenced_column);
                $column->setReferencedTable($referencedTable);
            }
        }

        return $column;
    }

    /**
     * Sets the properties of the specified column.
     *
     * @param  mixed                   $row
     * @param  \Rougin\Describe\Column $column
     * @return \Rougin\Describe\Column
     */
    protected function setProperties($row, Column $column)
    {
        $null = 'Null';

        if ($row->Extra == 'auto_increment') {
            $column->setAutoIncrement(true);
        }

        if ($row->$null == 'YES') {
            $column->setNull(true);
        }

        return $column;
    }

    /**
     * Strips the table schema from the table name.
     *
     * @param  string $table
     * @return string
     */
    protected function stripTableSchema($table)
    {
        return (strpos($table, '.') !== false) ? substr($table, strpos($table, '.') + 1) : $table;
    }
}


1		<?php
2
3		namespace Rougin\Describe\Driver;
4
5		use Rougin\Describe\Column;
6
7		/**
8		* MySQL Driver
9		*
10		* A database driver extension for MySQL.
11		*
12		* @package Describe
13		* @category Driver
14		* @author Rougin Royce Gutib <[email protected]>
15		*/
16		class MySQLDriver extends AbstractDriver implements DriverInterface
17		{
18		/**
19		* @var string
20		*/
21		protected $database;
22
23		/**
24		* @var \PDO
25		*/
26		protected $pdo;
27
28		/**
29		* @param PDO $pdo
30		* @param string $database
31		*/
32	60	public function __construct(\PDO $pdo, $database)
33		{
34	60	$this->database = $database;
35	60	$this->pdo = $pdo;
36	60	}
37
38		/**
39		* Returns a listing of columns from the specified table.
40		*
41		* @param string $tableName
42		* @return array
43		* @throws \Rougin\Describe\Exceptions\TableNameNotFoundException
44		*/
45	51	public function getColumns($tableName)
46		{
47	51	return $this->getColumnsFromQuery($tableName, 'DESCRIBE ' . $tableName);
48		}
49
50		/**
51		* Returns a listing of columns from the specified table.
52		* NOTE: To be removed in v2.0.0.
53		*
54		* @param string $tableName
55		* @return array
56		* @throws \Rougin\Describe\Exceptions\TableNameNotFoundException
57		*/
58	51	public function getTable($tableName)
59		{
60	51	return $this->getColumns($tableName);
61		}
62
63		/**
64		* Returns a listing of tables from the specified database.
65		*
66		* @return array
67		*/
68	9	public function getTableNames()
69		{
70	9	return $this->showTables();
71		}
72
73		/**
74		* Shows the list of tables.
75		* NOTE: To be removed in v2.0.0.
76		*
77		* @return array
78		*/
79	9	public function showTables()
80		{
81	9	$tables = [];
82
83	9	$information = $this->pdo->prepare('SHOW TABLES');
84	9	$information->execute();
85
86	9	while ($row = $information->fetch()) {
87	9	array_push($tables, $row[0]);
88	9	}
89
90	9	return $tables;
91		}
92
93		/**
94		* Prepares the defined columns.
95		*
96		* @param string $tableName
97		* @param mixed $row
98		* @return \Rougin\Describe\Column
99		*/
100	48	protected function setColumn($tableName, $row)
101		{
102	48	preg_match('/(.?)\((.?)\)/', $row->Type, $match);
103
104	48	$column = new Column;
105
106
107	48	$column->setDataType($row->Type);
108	48	$column->setDefaultValue($row->Default);
109	48	$column->setField($row->Field);
110
111	48	if (isset($match[1])) {
112	48	$column->setDataType($match[1]);
113	48	$column->setLength($match[2]);
114	48	}
115
116	48	$column = $this->setProperties($row, $column);
117	48	$column = $this->setKey($row, $column);
118	48	$column = $this->setForeignColumn($tableName, $row, $column);
119
120	48	return $column;
121		}
122
123		/**
124		* Sets the key of the specified column.
125		*
126		* @param mixed $row
127		* @param \Rougin\Describe\Column $column
128		* @return \Rougin\Describe\Column
129		*/
130	48	protected function setKey($row, Column $column)
131		{
132	48	switch ($row->Key) {
133	48	case 'PRI':
134	48	$column->setPrimary(true);
135
136	48	break;
137
138	48	case 'MUL':
139	48	$column->setForeign(true);
140
141	48	break;
142
143	48	case 'UNI':
144	48	$column->setUnique(true);
145
146	48	break;
147	48	}
148
149	48	return $column;
150		}
151
152		/**
153		* Sets the properties of the specified column if it does exists.
154		*
155		* @param string $tableName
156		* @param mixed $row
157		* @param \Rougin\Describe\Column $column
158		* @return \Rougin\Describe\Column
159		*/
160	48	protected function setForeignColumn($tableName, $row, Column $column)
161		{
162		$query = 'SELECT COLUMN_NAME as "column", REFERENCED_COLUMN_NAME as "referenced_column",' .
163	48	'CONCAT(REFERENCED_TABLE_SCHEMA, ".", REFERENCED_TABLE_NAME) as "referenced_table"' .
164	48	'FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE ' .
165	48	'WHERE CONSTRAINT_SCHEMA = "' . $this->database . '" AND TABLE_NAME = "' . $tableName . '";';
166
167	48	$foreignTable = $this->pdo->prepare($query);
168
169	48	$foreignTable->execute();
170	48	$foreignTable->setFetchMode(\PDO::FETCH_OBJ);
171
172	48	while ($foreignRow = $foreignTable->fetch()) {
173	45	if ($foreignRow->column == $row->Field) {
174	45	$referencedTable = $this->stripTableSchema($foreignRow->referenced_table);
175
176	45	$column->setReferencedField($foreignRow->referenced_column);
177	45	$column->setReferencedTable($referencedTable);
178	45	}
179	45	}
180
181	48	return $column;
182		}
183
184		/**
185		* Sets the properties of the specified column.
186		*
187		* @param mixed $row
188		* @param \Rougin\Describe\Column $column
189		* @return \Rougin\Describe\Column
190		*/
191	48	protected function setProperties($row, Column $column)
192		{
193	48	$null = 'Null';
194
195	48	if ($row->Extra == 'auto_increment') {
196	48	$column->setAutoIncrement(true);
197	48	}
198
199	48	if ($row->$null == 'YES') {
200	48	$column->setNull(true);
201	48	}
202
203	48	return $column;
204		}
205
206		/**
207		* Strips the table schema from the table name.
208		*
209		* @param string $table
210		* @return string
211		*/
212	45	protected function stripTableSchema($table)
213		{
214	45	return (strpos($table, '.') !== false) ? substr($table, strpos($table, '.') + 1) : $table;
215		}
216		}
217

rougin / describe

Pull Request — master (#5)

MySQLDriver::getColumns() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like