CodexShaper\Dumper\Drivers\MysqlDumper

Complexity

Total Complexity

43

Size/Duplication

Total Lines	208
Duplicated Lines	0 %

Test Coverage

Coverage

82.24%

Importance

Changes	11
Bugs	0	Features	0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	prepareSocket()	0	3	2
A	dump()	0	5	2
A	useQuick()	0	4	1
A	useSkipLockTables()	0	4	1
A	useSingleTransaction()	0	4	1
A	prepareCreateTables()	0	3	2
A	prepareSkipLockTables()	0	3	2
A	restore()	0	5	2
A	prepareAuthentication()	0	3	1
A	prepareQuick()	0	3	2
A	prepareDefaultCharSet()	0	3	2
A	prepareRestoreCommand()	0	14	2
A	doNotUseSkipComments()	0	4	1
A	prepareIncludeTables()	0	5	3
A	prepareDumpCommand()	0	24	2
A	getCredentials()	0	10	1
A	prepareIgnoreTables()	0	8	3
A	setDefaultCharacterSet()	0	4	1
A	prepareSkipComments()	0	3	2
A	prepareSingleTransaction()	0	3	2
A	doNotUseCreateTables()	0	4	1
A	prepareDatabase()	0	3	2
A	runCommand()	0	30	5

<?php

namespace CodexShaper\Dumper\Drivers;

use CodexShaper\Dumper\Dumper;
use Symfony\Component\Process\Exception\ProcessFailedException;

class MysqlDumper extends Dumper
{
    /*@var bool*/
    protected $singleTransaction = false;
    /*@var bool*/
    protected $skipLockTables = false;
    /*@var bool*/
    protected $quick = false;
    /*@var bool*/
    protected $skipComments = true;
    /*@var string*/
    protected $defaultCharacterSet = '';
    /*@var bool*/
    protected $createTables = true;

    public function useSingleTransaction()
    {
        $this->singleTransaction = true;
        return $this;
    }
    public function useSkipLockTables()
    {
        $this->skipLockTables = true;
        return $this;
    }
    public function useQuick()
    {
        $this->quick = true;
        return $this;
    }
    public function doNotUseSkipComments()
    {
        $this->skipComments = false;
        return $this;
    }
    public function doNotUseCreateTables()
    {
        $this->createTables = false;
        return $this;
    }
    public function setDefaultCharacterSet(string $charecterSet)
    {
        $this->defaultCharacterSet = $charecterSet;
        return $this;
    }

    public function dump(string $destinationPath = "")
    {
        $destinationPath = !empty($destinationPath) ? $destinationPath : $this->destinationPath;
        $this->runCommand($destinationPath, "dump");
        return $this;
    }

    public function restore(string $restorePath = "")
    {
        $restorePath = !empty($restorePath) ? $restorePath : $this->restorePath;
        $this->runCommand($restorePath, 'restore');
        return $this;
    }

    protected function prepareDumpCommand(string $credentialFile, string $destinationPath): string
    {
        $dumpCommand = sprintf(
            '%smysqldump %s %s %s %s %s %s %s %s %s %s %s',
            $this->dumpCommandPath,
            $this->prepareAuthentication($credentialFile),
            $this->prepareDatabase(),
            $this->prepareSocket(),
            $this->prepareSkipComments(),
            $this->prepareCreateTables(),
            $this->prepareSingleTransaction(),
            $this->prepareSkipLockTables(),
            $this->prepareQuick(),
            $this->prepareDefaultCharSet(),
            $this->prepareIncludeTables(),
            $this->prepareIgnoreTables()
        );

        if ($this->isCompress) {

            return "{$dumpCommand} | {$this->compressBinaryPath}{$this->compressCommand} > {$destinationPath}{$this->compressExtension}";
        }

        return "{$dumpCommand} > {$destinationPath}";
    }

    protected function prepareRestoreCommand(string $credentialFile, string $filePath): string
    {
        $restoreCommand = sprintf("%smysql %s %s",
            $this->dumpCommandPath,
            $this->prepareAuthentication($credentialFile),
            $this->prepareDatabase()
        );

        if ($this->isCompress) {

            return "{$this->compressBinaryPath}{$this->compressCommand} < {$filePath} | {$restoreCommand}";
        }

        return "{$restoreCommand} < {$filePath}";
    }

    protected function runCommand($filePath, $action)
    {
        try {

            $credentials    = $this->getCredentials();
            $this->tempFile = tempnam(sys_get_temp_dir(), 'mysqlpass');
            $handler        = fopen($this->tempFile, 'r+');
            fwrite($handler, $credentials);

It seems like $handler can also be of type false; however, parameter $handle of fwrite() does only seem to accept resource, maybe add an additional type check?

            if ($action == 'dump') {
                $dumpCommand   = $this->prepareDumpCommand($this->tempFile, $filePath);
                $this->command = $this->removeExtraSpaces($dumpCommand);
            } else if ($action == 'restore') {
                $dumpCommand   = $this->prepareRestoreCommand($this->tempFile, $filePath);
                $this->command = $this->removeExtraSpaces($dumpCommand);
            }

            $process = $this->prepareProcessCommand();

            if ($this->debug) {
                $process->mustRun();
            } else {
                $process->run();
            }

            fclose($handler);

It seems like $handler can also be of type false; however, parameter $handle of fclose() does only seem to accept resource, maybe add an additional type check?

            unlink($this->tempFile);

        } catch (ProcessFailedException $e) {
            throw new \Exception($e->getMessage());

        }
    }

    protected function getCredentials()
    {
        $contents = [
            '[client]',
            "user = '{$this->username}'",
            "password = '{$this->password}'",
            "host = '{$this->host}'",
            "port = '{$this->port}'",
        ];
        return implode(PHP_EOL, $contents);
    }

    public function prepareDatabase()
    {
        return $this->dbName ? $this->dbName : "";
    }

    public function prepareIncludeTables()
    {
        $includeTables    = (count($this->tables) > 0) ? implode(' ', $this->tables) : '';
        $includeTablesArg = !empty($includeTables) ? "--tables {$includeTables}" : '';
        return $includeTablesArg;
    }

    public function prepareIgnoreTables()
    {
        $ignoreTablesArgs = [];
        foreach ($this->ignoreTables as $tableName) {
            $ignoreTablesArgs[] = "--ignore-table={$databaseArg}.{$tableName}";

The variable $databaseArg seems to be never defined.

        }
        $ignoreTablesArg = (count($ignoreTablesArgs) > 0) ? implode(' ', $ignoreTablesArgs) : '';
        return $ignoreTablesArg;
    }

    public function prepareSingleTransaction()
    {
        return $this->singleTransaction ? '--single-transaction' : '';
    }

    public function prepareSkipLockTables()
    {
        return $this->skipLockTables ? '--skip-lock-tables' : '';
    }

    public function prepareQuick()
    {
        return $this->quick ? '--quick' : '';
    }

    public function prepareCreateTables()
    {
        return !$this->createTables ? '--no-create-info' : '';
    }

    public function prepareSkipComments()
    {
        return $this->skipComments ? '--skip-comments' : '';
    }

    public function prepareSocket()
    {
        return ($this->socket !== '') ? "--socket={$this->socket}" : '';
    }

    public function prepareDefaultCharSet()
    {
        return ($this->defaultCharacterSet !== '') ? "--default-character-set={$this->defaultCharacterSet}" : '';
    }

    public function prepareAuthentication(string $credentialFile)
    {
        return "--defaults-extra-file={$credentialFile}";
    }
}