Sqlite::normalizeColumnDefinition() - 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

Sqlite::normalizeColumnDefinition() C

↳ Parent: Sqlite

Complexity

Conditions	11
Paths	16

Size

Total Lines	34
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	25
CRAP Score	11

Importance

Changes

Metric	Value
dl	0
loc	34
ccs	25
cts	25
cp	1
rs	5.2653
c	0
b	0
f	0
cc	11
eloc	25
nc	16
nop	2
crap	11

How to fix Complexity

<?php

namespace ORM\Dbal;

use ORM\Exception;

/**
 * Database abstraction for SQLite databases
 *
 * @package ORM\Dbal
 * @author  Thomas Flori <[email protected]>
 */
class Sqlite extends Dbal
{
    protected static $typeMapping = [
        'integer' => Type\Number::class,
        'int' => Type\Number::class,
        'double' => Type\Number::class,
        'real' => Type\Number::class,
        'float' => Type\Number::class,
        'numeric' => Type\Number::class,
        'decimal' => Type\Number::class,

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

        'text' => Type\Text::class,

        'boolean' => Type\Boolean::class,
        'json' => Type\Json::class,

        'datetime' => Type\DateTime::class,
        'date' => Type\DateTime::class,
        'time' => Type\Time::class,
    ];

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

        if ($useAutoIncrement && $entity::isAutoIncremented()) {
            $pdo->query($statement);
            return $pdo->lastInsertId();
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($schemaTable)
    {
        $table = explode($this->identifierDivider, $schemaTable);
        list($schema, $table) = count($table) === 2 ? $table : [null, $table[0]];
        $schema = $schema !== null ? $this->escapeIdentifier($schema) . '.' : '';

        $result = $this->entityManager->getConnection()->query(
            'PRAGMA ' . $schema . 'table_info(' . $this->escapeIdentifier($table) . ')'
        );
        $rawColumns = $result->fetchAll(\PDO::FETCH_ASSOC);

        if (count($rawColumns) === 0) {
            throw new Exception('Unknown table '  . $table);
        }

        $hasMultiplePrimaryKey = $this->hasMultiplePrimaryKey($rawColumns);

        $cols = array_map(function ($rawColumn) use ($hasMultiplePrimaryKey) {
            $columnDefinition = $this->normalizeColumnDefinition($rawColumn, $hasMultiplePrimaryKey);
            return new Column($this, $columnDefinition);
        }, $rawColumns);

        return new Table($cols);
    }

    /**
     * Checks $rawColumns for a multiple primary key
     *
     * @param array $rawColumns
     * @return bool
     */
    protected function hasMultiplePrimaryKey($rawColumns)
    {
        return count(array_filter(array_map(function ($rawColumn) {
            return $rawColumn['pk'];
        }, $rawColumns))) > 1;
    }

    /**
     * Normalize a column definition
     *
     * The column definition from "PRAGMA table_info(<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, $hasMultiplePrimaryKey = false)
    {
        $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['name'];
        $definition['is_nullable'] = $rawColumn['notnull'] === '0';
        $definition['column_default'] = $rawColumn['dflt_value'];
        $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 'integer':
                if (!$definition['column_default'] && $rawColumn['pk'] === '1' && !$hasMultiplePrimaryKey) {
                    $definition['column_default'] = 'sequence(rowid)';
                }
                break;
        }

        return $definition;
    }
}


1		<?php
2
3		namespace ORM\Dbal;
4
5		use ORM\Exception;
6
7		/**
8		* Database abstraction for SQLite databases
9		*
10		* @package ORM\Dbal
11		* @author Thomas Flori <[email protected]>
12		*/
13		class Sqlite extends Dbal
14		{
15		protected static $typeMapping = [
16		'integer' => Type\Number::class,
17		'int' => Type\Number::class,
18		'double' => Type\Number::class,
19		'real' => Type\Number::class,
20		'float' => Type\Number::class,
21		'numeric' => Type\Number::class,
22		'decimal' => Type\Number::class,
23
24		'varchar' => Type\VarChar::class,
25		'character' => Type\VarChar::class,
26
27		'text' => Type\Text::class,
28
29		'boolean' => Type\Boolean::class,
30		'json' => Type\Json::class,
31
32		'datetime' => Type\DateTime::class,
33		'date' => Type\DateTime::class,
34		'time' => Type\Time::class,
35		];
36
37	2	public function insert($entity, $useAutoIncrement = true)
38		{
39	2	$statement = $this->buildInsertStatement($entity);
40	2	$pdo = $this->entityManager->getConnection();
41
42	2	if ($useAutoIncrement && $entity::isAutoIncremented()) {
43	1	$pdo->query($statement);
44	1	return $pdo->lastInsertId();
		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->lastInsertId();` (`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...
45		}
46
47	1	$pdo->query($statement);
48	1	$this->entityManager->sync($entity, true);
49	1	return true;
50		}
51
52	32	public function describe($schemaTable)
53		{
54	32	$table = explode($this->identifierDivider, $schemaTable);
55	32	list($schema, $table) = count($table) === 2 ? $table : [null, $table[0]];
56	32	$schema = $schema !== null ? $this->escapeIdentifier($schema) . '.' : '';
57
58	32	$result = $this->entityManager->getConnection()->query(
59	32	'PRAGMA ' . $schema . 'table_info(' . $this->escapeIdentifier($table) . ')'
60		);
61	32	$rawColumns = $result->fetchAll(\PDO::FETCH_ASSOC);
62
63	32	if (count($rawColumns) === 0) {
64	2	throw new Exception('Unknown table ' . $table);
65		}
66
67	30	$hasMultiplePrimaryKey = $this->hasMultiplePrimaryKey($rawColumns);
68
69		$cols = array_map(function ($rawColumn) use ($hasMultiplePrimaryKey) {
70	30	$columnDefinition = $this->normalizeColumnDefinition($rawColumn, $hasMultiplePrimaryKey);
71	30	return new Column($this, $columnDefinition);
72	30	}, $rawColumns);
73
74	30	return new Table($cols);
75		}
76
77		/**
78		* Checks $rawColumns for a multiple primary key
79		*
80		* @param array $rawColumns
81		* @return bool
82		*/
83		protected function hasMultiplePrimaryKey($rawColumns)
84		{
85	30	return count(array_filter(array_map(function ($rawColumn) {
86	30	return $rawColumn['pk'];
87	30	}, $rawColumns))) > 1;
88		}
89
90		/**
91		* Normalize a column definition
92		*
93		* The column definition from "PRAGMA table_info(<table>)" is to special as useful. Here we normalize it to a more
94		* ANSI-SQL style.
95		*
96		* @param array $rawColumn
97		* @return array
98		*/
99	30	protected function normalizeColumnDefinition($rawColumn, $hasMultiplePrimaryKey = false)
100		{
101	30	$definition = [];
102
103	30	$definition['data_type'] = $this->normalizeType($rawColumn['type']);
104	30	if (isset(static::$typeMapping[$definition['data_type']])) {
105	29	$definition['type'] = static::$typeMapping[$definition['data_type']];
106		}
107
108	30	$definition['column_name'] = $rawColumn['name'];
109	30	$definition['is_nullable'] = $rawColumn['notnull'] === '0';
110	30	$definition['column_default'] = $rawColumn['dflt_value'];
111	30	$definition['character_maximum_length'] = null;
112	30	$definition['datetime_precision'] = null;
113
114	30	switch ($definition['data_type']) {
115	30	case 'varchar':
116	28	case 'char':
117	2	$definition['character_maximum_length'] = $this->extractParenthesis($rawColumn['type']);
118	2	break;
119	28	case 'datetime':
120	27	case 'timestamp':
121	27	case 'time':
122	2	$definition['datetime_precision'] = $this->extractParenthesis($rawColumn['type']);
123	2	break;
124	26	case 'integer':
125	9	if (!$definition['column_default'] && $rawColumn['pk'] === '1' && !$hasMultiplePrimaryKey) {
126	1	$definition['column_default'] = 'sequence(rowid)';
127		}
128	9	break;
129		}
130
131	30	return $definition;
132		}
133		}
134

tflori / orm

Pull Request — master (#38)

Sqlite::normalizeColumnDefinition() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like