PDO::setInstanceName() - Code Metrics - Inspection of "add constants" - gggeek/db-3v4l - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( bef62b...c1c8d5 )

by Gaetano

created 2019-12-21 12:13 UTC

PDO::setInstanceName() A

↳ Parent: PDO

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php


namespace Db3v4l\Core\SqlExecutor\Forked;

use Db3v4l\API\Interfaces\SqlExecutor\Forked\CommandExecutor;
use Db3v4l\Service\DatabaseConfigurationManager;
use Db3v4l\Util\Process;

/**
 * Executes sql queries via a separate symfony console command
 */

class PDO extends ForkedExecutor implements CommandExecutor
{
    const EXECUTION_STRATEGY = 'PDO';

    protected $instanceName;
    /** @var DatabaseConfigurationManager $dbConfigurationManager */

    protected $dbConfigurationManager;

    public function setInstanceName($instanceName)

    {
        $this->instanceName = $instanceName;
    }

    public function setDbConfigurationManager(DatabaseConfigurationManager $dbConfigurationManager)

    {
        $this->dbConfigurationManager = $dbConfigurationManager;
    }

    public function getExecuteStatementProcess($sql)

    {
        return $this->getProcess($sql, self::EXECUTE_COMMAND);
    }

    /**

     * @param string $filename

     * @return Process

     */
    public function getExecuteFileProcess($filename)
    {
        return $this->getProcess($filename, self::EXECUTE_FILE);
    }

    protected function getProcess($sqlOrFilename, $action = self::EXECUTE_COMMAND)

    {
        // pass on _all_ env vars, including PATH. Not doing so is deprecated...
        $env = null;

        $command = 'php';
        $options = [
            'bin/dbconsole',
            'sql:execute',
            '--only-instances=' . $this->instanceName,
            '--execute-in-process',
            '--execution-strategy=' . static::EXECUTION_STRATEGY,
            '--output-type=json',
        ];

        switch ($action) {
            case self::EXECUTE_COMMAND:

                $options[] = '--sql=' . $sqlOrFilename;
                break;
            case self::EXECUTE_FILE:

                $options[] = '--file=' . $sqlOrFilename;
                break;
            default:

                throw new \OutOfBoundsException('Unsupported action: $action');
        }

        $instanceConfiguration = $this->dbConfigurationManager->getInstanceConfiguration($this->instanceName);

        /// @todo add support for charset ?
        if ($instanceConfiguration != $this->databaseConfiguration) {
            if (isset($this->databaseConfiguration['dbname'])) {
                $options[] = '--database=' . $this->databaseConfiguration['dbname'];
            }
            if (isset($this->databaseConfiguration['user'])) {
                $options[] = '--user=' . $this->databaseConfiguration['user'];
            }
            if (isset($this->databaseConfiguration['password'])) {
                $options[] = '--password=' . $this->databaseConfiguration['password'];
            }
        }

        $commandLine = $this->buildCommandLine($command, $options);

        return new Process($commandLine, null, $env);
    }

    public function resultSetToArray($data)

    {
        $data = json_encode($data);
        return $data;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }
}


1			<?php
2
			0 ignored issues – show Coding Style introduced 2019-12-20 12:42 UTC by Report Bug Copy Issue Report Missing file doc comment Loading history...
3			namespace Db3v4l\Core\SqlExecutor\Forked;
4
5			use Db3v4l\API\Interfaces\SqlExecutor\Forked\CommandExecutor;
6			use Db3v4l\Service\DatabaseConfigurationManager;
7			use Db3v4l\Util\Process;
8
9			/**
10			* Executes sql queries via a separate symfony console command
11			*/
			0 ignored issues – show Coding Style introduced 2019-12-20 12:42 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2019-12-20 12:42 UTC by Report Bug Copy Issue Report Missing @package tag in class comment Loading history... Coding Style introduced 2019-12-20 12:42 UTC by Report Bug Copy Issue Report Missing @author tag in class comment Loading history... Coding Style introduced 2019-12-20 12:42 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2019-12-20 12:42 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
12			class PDO extends ForkedExecutor implements CommandExecutor
13			{
14			const EXECUTION_STRATEGY = 'PDO';
15
16			protected $instanceName;
17			/** @var DatabaseConfigurationManager $dbConfigurationManager */
			0 ignored issues – show Coding Style introduced 2019-12-21 12:19 UTC by Report Bug Copy Issue Report The open comment tag must be the only content on the line Loading history... Coding Style introduced 2019-12-21 12:19 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2019-12-21 12:19 UTC by Report Bug Copy Issue Report The close comment tag must be the only content on the line Loading history...
18			protected $dbConfigurationManager;
19
20			public function setInstanceName($instanceName)
			0 ignored issues – show Coding Style introduced 2019-12-21 12:19 UTC by Report Bug Copy Issue Report Missing doc comment for function setInstanceName() Loading history...
21			{
22			$this->instanceName = $instanceName;
23			}
24
25			public function setDbConfigurationManager(DatabaseConfigurationManager $dbConfigurationManager)
			0 ignored issues – show Coding Style introduced 2019-12-21 12:19 UTC by Report Bug Copy Issue Report Missing doc comment for function setDbConfigurationManager() Loading history...
26			{
27			$this->dbConfigurationManager = $dbConfigurationManager;
28			}
29
30			public function getExecuteStatementProcess($sql)
			0 ignored issues – show Coding Style introduced 2019-12-20 12:42 UTC by Report Bug Copy Issue Report Missing doc comment for function getExecuteStatementProcess() Loading history...
31			{
32			return $this->getProcess($sql, self::EXECUTE_COMMAND);
33			}
34
35			/**
			0 ignored issues – show Coding Style introduced 2019-12-20 12:42 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
36			* @param string $filename
			0 ignored issues – show Coding Style introduced 2019-12-20 12:42 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2019-12-20 12:42 UTC by Report Bug Copy Issue Report Tag value for @param tag indented incorrectly; expected 2 spaces but found 1 Loading history...
37			* @return Process
			0 ignored issues – show Coding Style introduced 2019-12-20 12:42 UTC by Report Bug Copy Issue Report Tag @return cannot be grouped with parameter tags in a doc comment Loading history...
38			*/
39			public function getExecuteFileProcess($filename)
40			{
41			return $this->getProcess($filename, self::EXECUTE_FILE);
42			}
43
44			protected function getProcess($sqlOrFilename, $action = self::EXECUTE_COMMAND)
			0 ignored issues – show Coding Style introduced 2019-12-21 12:19 UTC by Report Bug Copy Issue Report Missing doc comment for function getProcess() Loading history...
45			{
46			// pass on _all_ env vars, including PATH. Not doing so is deprecated...
47			$env = null;
48
49			$command = 'php';
50			$options = [
51			'bin/dbconsole',
52			'sql:execute',
53			'--only-instances=' . $this->instanceName,
54			'--execute-in-process',
55			'--execution-strategy=' . static::EXECUTION_STRATEGY,
56			'--output-type=json',
57			];
58
59			switch ($action) {
60			case self::EXECUTE_COMMAND:
			0 ignored issues – show Coding Style introduced 2019-12-21 12:19 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
61			$options[] = '--sql=' . $sqlOrFilename;
62			break;
63			case self::EXECUTE_FILE:
			0 ignored issues – show Coding Style introduced 2019-12-21 12:19 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
64			$options[] = '--file=' . $sqlOrFilename;
65			break;
66			default:
			0 ignored issues – show Coding Style introduced 2019-12-20 12:42 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
67			throw new \OutOfBoundsException('Unsupported action: $action');
68			}
69
70			$instanceConfiguration = $this->dbConfigurationManager->getInstanceConfiguration($this->instanceName);
71
72			/// @todo add support for charset ?
73			if ($instanceConfiguration != $this->databaseConfiguration) {
74			if (isset($this->databaseConfiguration['dbname'])) {
75			$options[] = '--database=' . $this->databaseConfiguration['dbname'];
76			}
77			if (isset($this->databaseConfiguration['user'])) {
78			$options[] = '--user=' . $this->databaseConfiguration['user'];
79			}
80			if (isset($this->databaseConfiguration['password'])) {
81			$options[] = '--password=' . $this->databaseConfiguration['password'];
82			}
83			}
84
85			$commandLine = $this->buildCommandLine($command, $options);
86
87			return new Process($commandLine, null, $env);
88			}
89
90			public function resultSetToArray($data)
			0 ignored issues – show Coding Style introduced 2019-12-21 12:19 UTC by Report Bug Copy Issue Report Missing doc comment for function resultSetToArray() Loading history...
91			{
92			$data = json_encode($data);
93			return $data;
			0 ignored issues – show Bug Best Practice introduced 2019-12-21 12:19 UTC by Report Bug Copy Issue Report The expression `return $data` returns the type `string` which is incompatible with the return type mandated by `Db3v4l\API\Interfaces\Sq...tor::resultSetToArray()` of `array`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
94			}
95			}
96

gggeek / db-3v4l

Push — master ( bef62b...c1c8d5 )

PDO::setInstanceName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like