MySql::getContentsOfCredentialsFile() - Code Metrics - Inspection of "appease the human scrutinizer" - spatie/db-dumper - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ca8257...5c71d6 )

by Freek

created 2016-01-19 17:11 UTC

MySql::getContentsOfCredentialsFile() A

↳ Parent: MySql

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	12
rs	9.4285
cc	1
eloc	8
nc	1
nop	0

<?php

namespace Spatie\DbDumper\Databases;

use Spatie\DbDumper\DbDumper;
use Spatie\DbDumper\Exceptions\CannotStartDump;
use Symfony\Component\Process\Process;

class MySql extends DbDumper
{
    protected $dbName;
    protected $userName;
    protected $password;
    protected $host = 'localhost';
    protected $port = 3306;
    protected $socket;
    protected $dumpBinaryPath = '';
    protected $useExtendedInserts = true;

    public function setDbName(string $dbName) : MySql
    {
        $this->dbName = $dbName;

        return $this;
    }

    public function setUserName(string $userName) : MySql
    {
        $this->userName = $userName;

        return $this;
    }

    public function setPassword(string $password) : MySql
    {
        $this->password = $password;

        return $this;
    }

    public function setHost(string $host) : MySql
    {
        $this->host = $host;

        return $this;
    }

    public function setPort(int $port) : MySql
    {
        $this->port = $port;

        return $this;
    }

    public function setSocket(int $socket) : MySql
    {
        $this->socket = $socket;

        return $this;
    }

    public function setDumpBinaryPath(string $dumpBinaryPath) : MySql
    {
        if ($dumpBinaryPath !== '' && substr($dumpBinaryPath, -1) !== '/') {
            $dumpBinaryPath .= '/';
        }

        $this->dumpBinaryPath = $dumpBinaryPath;

        return $this;
    }

    public function useExtendedInserts() : MySql
    {
        $this->useExtendedInserts = true;

        return $this;
    }

    public function dontUseExtendedInserts() : MySql
    {
        $this->useExtendedInserts = false;

        return $this;
    }

    /**
     * Dump the contents of the database to the given file.
     */
    public function dumpToFile(string $dumpFile)
    {
        $this->guardAgainstIncompleteCredentials();

        $tempFileHandle = tmpfile();

        fwrite($tempFileHandle, $this->getContentsOfCredentialsFile());

        $temporaryCredentialsFile = stream_get_meta_data($tempFileHandle)['uri'];

        $command = $this->getDumpCommand($dumpFile, $temporaryCredentialsFile);

        $process = (new Process($command))->run();

        $this->checkIfDumpWasSuccessFull($process, $dumpFile);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Get the command that should be performed to dump the database.
     */
    public function getDumpCommand(string $dumpFile, string $temporaryCredentialsFile) : string
    {
        $command = [
            "{$this->dumpBinaryPath}mysqldump",
            "--defaults-extra-file={$temporaryCredentialsFile}",
            '--skip-comments',
            $this->useExtendedInserts ? '--extended-insert' : '--skip-extended-insert',
        ];

        if ($this->socket != '') {
            $command[] = "--socket={$this->socket}";
        }

        $command[] = "{$this->dbName} > {$dumpFile}";

        return implode(' ', $command);
    }

    public function getContentsOfCredentialsFile() : string
    {
        $contents = [
            '[client]',
            "user = '{$this->userName}'",
            "password = '{$this->password}'",
            "host = '{$this->host}'",
            "port = '{$this->port}'",
        ];

        return implode(PHP_EOL, $contents);
    }

    protected function guardAgainstIncompleteCredentials()
    {
        foreach (['userName', 'dbName', 'host'] as $requiredProperty) {
            if (strlen($this->$requiredProperty) === 0) {
                throw CannotStartDump::emptyParameter($requiredProperty);
            }
        }
    }
}


1			<?php
2
3			namespace Spatie\DbDumper\Databases;
4
5			use Spatie\DbDumper\DbDumper;
6			use Spatie\DbDumper\Exceptions\CannotStartDump;
7			use Symfony\Component\Process\Process;
8
9			class MySql extends DbDumper
10			{
11			protected $dbName;
12			protected $userName;
13			protected $password;
14			protected $host = 'localhost';
15			protected $port = 3306;
16			protected $socket;
17			protected $dumpBinaryPath = '';
18			protected $useExtendedInserts = true;
19
20			public function setDbName(string $dbName) : MySql
21			{
22			$this->dbName = $dbName;
23
24			return $this;
25			}
26
27			public function setUserName(string $userName) : MySql
28			{
29			$this->userName = $userName;
30
31			return $this;
32			}
33
34			public function setPassword(string $password) : MySql
35			{
36			$this->password = $password;
37
38			return $this;
39			}
40
41			public function setHost(string $host) : MySql
42			{
43			$this->host = $host;
44
45			return $this;
46			}
47
48			public function setPort(int $port) : MySql
49			{
50			$this->port = $port;
51
52			return $this;
53			}
54
55			public function setSocket(int $socket) : MySql
56			{
57			$this->socket = $socket;
58
59			return $this;
60			}
61
62			public function setDumpBinaryPath(string $dumpBinaryPath) : MySql
63			{
64			if ($dumpBinaryPath !== '' && substr($dumpBinaryPath, -1) !== '/') {
65			$dumpBinaryPath .= '/';
66			}
67
68			$this->dumpBinaryPath = $dumpBinaryPath;
69
70			return $this;
71			}
72
73			public function useExtendedInserts() : MySql
74			{
75			$this->useExtendedInserts = true;
76
77			return $this;
78			}
79
80			public function dontUseExtendedInserts() : MySql
81			{
82			$this->useExtendedInserts = false;
83
84			return $this;
85			}
86
87			/**
88			* Dump the contents of the database to the given file.
89			*/
90			public function dumpToFile(string $dumpFile)
91			{
92			$this->guardAgainstIncompleteCredentials();
93
94			$tempFileHandle = tmpfile();
95
96			fwrite($tempFileHandle, $this->getContentsOfCredentialsFile());
97
98			$temporaryCredentialsFile = stream_get_meta_data($tempFileHandle)['uri'];
99
100			$command = $this->getDumpCommand($dumpFile, $temporaryCredentialsFile);
101
102			$process = (new Process($command))->run();
103
104			$this->checkIfDumpWasSuccessFull($process, $dumpFile);
			0 ignored issues – show Documentation introduced 2016-01-19 17:14 UTC by Report Bug Copy Issue Report `$process` is of type `integer\|null`, but the function expects a `object<Symfony\Component\Process\Process>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
105			}
106
107			/**
108			* Get the command that should be performed to dump the database.
109			*/
110			public function getDumpCommand(string $dumpFile, string $temporaryCredentialsFile) : string
111			{
112			$command = [
113			"{$this->dumpBinaryPath}mysqldump",
114			"--defaults-extra-file={$temporaryCredentialsFile}",
115			'--skip-comments',
116			$this->useExtendedInserts ? '--extended-insert' : '--skip-extended-insert',
117			];
118
119			if ($this->socket != '') {
120			$command[] = "--socket={$this->socket}";
121			}
122
123			$command[] = "{$this->dbName} > {$dumpFile}";
124
125			return implode(' ', $command);
126			}
127
128			public function getContentsOfCredentialsFile() : string
129			{
130			$contents = [
131			'[client]',
132			"user = '{$this->userName}'",
133			"password = '{$this->password}'",
134			"host = '{$this->host}'",
135			"port = '{$this->port}'",
136			];
137
138			return implode(PHP_EOL, $contents);
139			}
140
141			protected function guardAgainstIncompleteCredentials()
142			{
143			foreach (['userName', 'dbName', 'host'] as $requiredProperty) {
144			if (strlen($this->$requiredProperty) === 0) {
145			throw CannotStartDump::emptyParameter($requiredProperty);
146			}
147			}
148			}
149			}
150

spatie / db-dumper

Push — master ( ca8257...5c71d6 )

MySql::getContentsOfCredentialsFile() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like