Driver::getName() - Code Metrics - Inspection of "update dbal setup" - crate/crate-dbal - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#28)

unknown

created 2016-11-04 14:46 UTC

Driver::getName() A

↳ Parent: Driver

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
/**
 * Licensed to CRATE Technology GmbH("Crate") under one or more contributor
 * license agreements.  See the NOTICE file distributed with this work for
 * additional information regarding copyright ownership.  Crate licenses
 * this file to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.  You may
 * obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * However, if you have executed another commercial license agreement
 * with Crate these terms will supersede the license and you may use the
 * software solely pursuant to the terms of the relevant commercial agreement.
 */
namespace Crate\DBAL\Driver\PDOCrate;

use Crate\DBAL\Platforms\Crate057Platform;
use Crate\DBAL\Platforms\CratePlatform;
use Doctrine\DBAL\VersionAwarePlatformDriver;

class Driver implements \Doctrine\DBAL\Driver, VersionAwarePlatformDriver
{
    const VERSION = '0.2.1';
    const NAME = 'crate';
    const SCHEMA_MIN_VERSION = '0.57.0';

    /**
     * {@inheritDoc}
     * @return PDOConnection The database connection.
     */
    public function connect(array $params, $username = null, $password = null, array $driverOptions = array())
    {
        return new PDOConnection($this->constructPdoDsn($params), $username, $password, $driverOptions);
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());
}
    }

    /**
     * Constructs the Crate PDO DSN.
     *
     * @return string The DSN.
     */
    private function constructPdoDsn(array $params)
    {
        $dsn = self::NAME . ':';
        if (isset($params['host']) && $params['host'] != '') {
            $dsn .= $params['host'];
        } else {
            $dsn .= 'localhost';
        }
        $dsn .= ':' . (isset($params['port']) ? $params['port'] : '4200');

        return $dsn;
    }

    /**
     * {@inheritDoc}
     */
    public function getDatabasePlatform()
    {
        return new \Crate\DBAL\Platforms\CratePlatform();
    }

    /**
     * {@inheritDoc}
     */
    public function getSchemaManager(\Doctrine\DBAL\Connection $conn)
    {
        return new \Crate\DBAL\Schema\CrateSchemaManager($conn);
    }

    /**
     * {@inheritDoc}
     */
    public function getName()
    {
        return self::NAME;
    }

    /**
     * {@inheritDoc}
     */
    public function getDatabase(\Doctrine\DBAL\Connection $conn)
    {
        return null;
    }

    /**
     * {@inheritDoc}
     */
    public function createDatabasePlatformForVersion($version)
    {
        if (version_compare($version, self::SCHEMA_MIN_VERSION, ">=")) {
            return new Crate057Platform();
        } else {
            return new CratePlatform();
        }
    }
}


1		<?php
2		/**
3		* Licensed to CRATE Technology GmbH("Crate") under one or more contributor
4		* license agreements. See the NOTICE file distributed with this work for
5		* additional information regarding copyright ownership. Crate licenses
6		* this file to you under the Apache License, Version 2.0 (the "License");
7		* you may not use this file except in compliance with the License. You may
8		* obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14		* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15		* License for the specific language governing permissions and limitations
16		* under the License.
17		*
18		* However, if you have executed another commercial license agreement
19		* with Crate these terms will supersede the license and you may use the
20		* software solely pursuant to the terms of the relevant commercial agreement.
21		*/
22		namespace Crate\DBAL\Driver\PDOCrate;
23
24		use Crate\DBAL\Platforms\Crate057Platform;
25		use Crate\DBAL\Platforms\CratePlatform;
26		use Doctrine\DBAL\VersionAwarePlatformDriver;
27
28		class Driver implements \Doctrine\DBAL\Driver, VersionAwarePlatformDriver
29		{
30		const VERSION = '0.2.1';
31		const NAME = 'crate';
32		const SCHEMA_MIN_VERSION = '0.57.0';
33
34		/**
35		* {@inheritDoc}
36		* @return PDOConnection The database connection.
37		*/
38	6	public function connect(array $params, $username = null, $password = null, array $driverOptions = array())
39		{
40	6	return new PDOConnection($this->constructPdoDsn($params), $username, $password, $driverOptions);
		0 ignored issues – show Bug Best Practice introduced 2016-01-12 08:42 UTC by Report Bug Copy Issue Report The return type of `return new \Crate\DBAL\D...sword, $driverOptions);` (`Crate\DBAL\Driver\PDOCrate\PDOConnection`) is incompatible with the return type declared by the interface `Doctrine\DBAL\Driver::connect` of type `Doctrine\DBAL\Driver\Connection`. 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...
41		}
42
43		/**
44		* Constructs the Crate PDO DSN.
45		*
46		* @return string The DSN.
47		*/
48	6	private function constructPdoDsn(array $params)
49		{
50	6	$dsn = self::NAME . ':';
51	6	if (isset($params['host']) && $params['host'] != '') {
52	6	$dsn .= $params['host'];
53	6	} else {
54		$dsn .= 'localhost';
55		}
56	6	$dsn .= ':' . (isset($params['port']) ? $params['port'] : '4200');
57
58	6	return $dsn;
59		}
60
61		/**
62		* {@inheritDoc}
63		*/
64		public function getDatabasePlatform()
65		{
66		return new \Crate\DBAL\Platforms\CratePlatform();
67		}
68
69		/**
70		* {@inheritDoc}
71		*/
72	2	public function getSchemaManager(\Doctrine\DBAL\Connection $conn)
73		{
74	2	return new \Crate\DBAL\Schema\CrateSchemaManager($conn);
75		}
76
77		/**
78		* {@inheritDoc}
79		*/
80		public function getName()
81		{
82		return self::NAME;
83		}
84
85		/**
86		* {@inheritDoc}
87		*/
88	2	public function getDatabase(\Doctrine\DBAL\Connection $conn)
89		{
90	2	return null;
91		}
92
93		/**
94		* {@inheritDoc}
95		*/
96	6	public function createDatabasePlatformForVersion($version)
97		{
98	6	if (version_compare($version, self::SCHEMA_MIN_VERSION, ">=")) {
99		return new Crate057Platform();
100		} else {
101	6	return new CratePlatform();
102		}
103		}
104		}
105

crate / crate-dbal

Pull Request — master (#28)

Driver::getName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like