Mysql::describe() - Code Metrics - Inspection of "Feature validator" - tflori/orm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#38)

by Thomas

created 2017-06-01 05:56 UTC

Mysql::describe() A

↳ Parent: Mysql

Complexity

Conditions	3
Paths	3

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	15
ccs	8
cts	8
cp	1
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	9
nc	3
nop	1
crap	3

<?php

namespace ORM\Dbal;

use ORM\Exception;

/**
 * Database abstraction for MySQL databases
 *
 * @package ORM\Dbal
 * @author  Thomas Flori <[email protected]>
 */
class Mysql extends Dbal
{
    protected static $typeMapping = [
        'tinyint' => Type\Number::class,
        'smallint' => Type\Number::class,
        'mediumint' => Type\Number::class,
        'int' => Type\Number::class,
        'bigint' => Type\Number::class,
        'decimal' => Type\Number::class,
        'float' => Type\Number::class,
        'double' => Type\Number::class,

        'varchar' => Type\VarChar::class,
        'char' => Type\VarChar::class,

        'text' => Type\Text::class,
        'tinytext' => Type\Text::class,
        'mediumtext' => Type\Text::class,
        'longtext' => Type\Text::class,

        'datetime' => Type\DateTime::class,
        'date' => Type\DateTime::class,
        'timestamp' => Type\DateTime::class,

        'time' => Type\Time::class,
        'enum' => Type\Enum::class,
        'set' => Type\Set::class,
        'json' => Type\Json::class,
    ];

    public function insert($entity, $useAutoIncrement = true)
    {
        $statement = $this->buildInsertStatement($entity);
        $pdo = $this->entityManager->getConnection();

        if ($useAutoIncrement && $entity::isAutoIncremented()) {
            $pdo->query($statement);
            return $pdo->query("SELECT LAST_INSERT_ID()")->fetchColumn();
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        $pdo->query($statement);
        $this->entityManager->sync($entity, true);
        return true;
    }

    public function describe($table)
    {
        try {
            $result = $this->entityManager->getConnection()->query('DESCRIBE ' . $this->escapeIdentifier($table));
        } catch (\PDOException $exception) {
            throw new Exception('Unknown table ' . $table, 0, $exception);
        }

        $cols = [];
        while ($rawColumn = $result->fetch(\PDO::FETCH_ASSOC)) {
            $cols[] = new Column($this, $this->normalizeColumnDefinition($rawColumn));
        }

        return new Table($cols);
    }

    /**
     * Normalize a column definition
     *
     * The column definition from "DESCRIBE <table>" is to special as useful. Here we normalize it to a more
     * ANSI-SQL style.
     *
     * @param array $rawColumn
     * @return array
     */
    protected function normalizeColumnDefinition($rawColumn)
    {
        $definition = [];

        $definition['data_type'] = $this->normalizeType($rawColumn['Type']);
        if (isset(static::$typeMapping[$definition['data_type']])) {
            $definition['type'] = static::$typeMapping[$definition['data_type']];
        }

        $definition['column_name'] = $rawColumn['Field'];
        $definition['is_nullable'] = $rawColumn['Null'] === 'YES';
        $definition['column_default'] = $rawColumn['Default'] !== null ? $rawColumn['Default'] :
            ($rawColumn['Extra'] === 'auto_increment' ? 'sequence(AUTO_INCREMENT)' : null);
        $definition['character_maximum_length'] = null;
        $definition['datetime_precision'] = null;

        switch ($definition['data_type']) {
            case 'varchar':
            case 'char':
                $definition['character_maximum_length'] = $this->extractParenthesis($rawColumn['Type']);
                break;
            case 'datetime':
            case 'timestamp':
            case 'time':
                $definition['datetime_precision'] = $this->extractParenthesis($rawColumn['Type']);
                break;
            case 'set':
            case 'enum':
                $definition['enumeration_values'] = $this->extractParenthesis($rawColumn['Type']);
                break;
        }

        return $definition;
    }
}


1		<?php
2
3		namespace ORM\Dbal;
4
5		use ORM\Exception;
6
7		/**
8		* Database abstraction for MySQL databases
9		*
10		* @package ORM\Dbal
11		* @author Thomas Flori <[email protected]>
12		*/
13		class Mysql extends Dbal
14		{
15		protected static $typeMapping = [
16		'tinyint' => Type\Number::class,
17		'smallint' => Type\Number::class,
18		'mediumint' => Type\Number::class,
19		'int' => Type\Number::class,
20		'bigint' => Type\Number::class,
21		'decimal' => Type\Number::class,
22		'float' => Type\Number::class,
23		'double' => Type\Number::class,
24
25		'varchar' => Type\VarChar::class,
26		'char' => Type\VarChar::class,
27
28		'text' => Type\Text::class,
29		'tinytext' => Type\Text::class,
30		'mediumtext' => Type\Text::class,
31		'longtext' => Type\Text::class,
32
33		'datetime' => Type\DateTime::class,
34		'date' => Type\DateTime::class,
35		'timestamp' => Type\DateTime::class,
36
37		'time' => Type\Time::class,
38		'enum' => Type\Enum::class,
39		'set' => Type\Set::class,
40		'json' => Type\Json::class,
41		];
42
43	5	public function insert($entity, $useAutoIncrement = true)
44		{
45	5	$statement = $this->buildInsertStatement($entity);
46	5	$pdo = $this->entityManager->getConnection();
47
48	5	if ($useAutoIncrement && $entity::isAutoIncremented()) {
49	3	$pdo->query($statement);
50	1	return $pdo->query("SELECT LAST_INSERT_ID()")->fetchColumn();
		1 ignored issue – show Bug Best Practice introduced 2017-05-18 06:25 UTC by Report Bug Copy Issue Report The return type of `return $pdo->query('SELE..._ID()')->fetchColumn();` (`string`) is incompatible with the return type of the parent method `ORM\Dbal\Dbal::insert` of type `boolean`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
51		}
52
53	2	$pdo->query($statement);
54	2	$this->entityManager->sync($entity, true);
55	2	return true;
56		}
57
58	50	public function describe($table)
59		{
60		try {
61	50	$result = $this->entityManager->getConnection()->query('DESCRIBE ' . $this->escapeIdentifier($table));
62	1	} catch (\PDOException $exception) {
63	1	throw new Exception('Unknown table ' . $table, 0, $exception);
64		}
65
66	49	$cols = [];
67	49	while ($rawColumn = $result->fetch(\PDO::FETCH_ASSOC)) {
68	49	$cols[] = new Column($this, $this->normalizeColumnDefinition($rawColumn));
69		}
70
71	49	return new Table($cols);
72		}
73
74		/**
75		* Normalize a column definition
76		*
77		* The column definition from "DESCRIBE <table>" is to special as useful. Here we normalize it to a more
78		* ANSI-SQL style.
79		*
80		* @param array $rawColumn
81		* @return array
82		*/
83	49	protected function normalizeColumnDefinition($rawColumn)
84		{
85	49	$definition = [];
86
87	49	$definition['data_type'] = $this->normalizeType($rawColumn['Type']);
88	49	if (isset(static::$typeMapping[$definition['data_type']])) {
89	44	$definition['type'] = static::$typeMapping[$definition['data_type']];
90		}
91
92	49	$definition['column_name'] = $rawColumn['Field'];
93	49	$definition['is_nullable'] = $rawColumn['Null'] === 'YES';
94	49	$definition['column_default'] = $rawColumn['Default'] !== null ? $rawColumn['Default'] :
95	46	($rawColumn['Extra'] === 'auto_increment' ? 'sequence(AUTO_INCREMENT)' : null);
96	49	$definition['character_maximum_length'] = null;
97	49	$definition['datetime_precision'] = null;
98
99	49	switch ($definition['data_type']) {
100	49	case 'varchar':
101	47	case 'char':
102	4	$definition['character_maximum_length'] = $this->extractParenthesis($rawColumn['Type']);
103	4	break;
104	45	case 'datetime':
105	41	case 'timestamp':
106	37	case 'time':
107	12	$definition['datetime_precision'] = $this->extractParenthesis($rawColumn['Type']);
108	12	break;
109	33	case 'set':
110	31	case 'enum':
111	4	$definition['enumeration_values'] = $this->extractParenthesis($rawColumn['Type']);
112	4	break;
113		}
114
115	49	return $definition;
116		}
117		}
118

tflori / orm

Pull Request — master (#38)

Mysql::describe() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like