Spatie\DbDumper\Databases\PostgreSql

Complexity

Total Complexity

14

Size/Duplication

Total Lines	150
Duplicated Lines	5.33 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	2
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getDbName()	0	4	1
A	setDbName()	0	6	1
A	setUserName()	0	6	1
A	setPassword()	0	6	1
A	setHost()	0	6	1
A	setPort()	0	6	1
A	setSocketDirectory()	0	6	1
A	dumpToFile()	0	12	1
A	getDumpCommand()	0	20	2
A	guardAgainstIncompleteCredentials()	8	8	3

<?php

namespace Spatie\DbDumper\Databases;

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

class PostgreSql extends DbDumper
{
    protected $socketDirectory = '';

    /**
     * PostgreSql constructor.
     */
    public function __construct()
    {
        $this->port = 5432;
    }

    /**
     * @return string
     */
    public function getDbName()
    {
        return $this->dbName;
    }

    /**
     * @param string $dbName
     *
     * @return \Spatie\DbDumper\Databases\PostgreSql
     */
    public function setDbName($dbName)
    {
        $this->dbName = $dbName;

        return $this;
    }

    /**
     * @param string $userName
     *
     * @return \Spatie\DbDumper\Databases\PostgreSql
     */
    public function setUserName($userName)
    {
        $this->userName = $userName;

        return $this;
    }

    /**
     * @param string $password
     *
     * @return \Spatie\DbDumper\Databases\PostgreSql
     */
    public function setPassword($password)
    {
        $this->password = $password;

        return $this;
    }

    /**
     * @param string $host
     *
     * @return \Spatie\DbDumper\Databases\PostgreSql
     */
    public function setHost($host)
    {
        $this->host = $host;

        return $this;
    }

    /**
     * @param int $port
     *
     * @return \Spatie\DbDumper\Databases\PostgreSql
     */
    public function setPort($port)
    {
        $this->port = $port;

        return $this;
    }

    /**
     * @param string $socketDirectory
     *
     * @return \Spatie\DbDumper\Databases\PostgreSql
     */
    public function setSocketDirectory($socketDirectory)
    {
        $this->socketDirectory = $socketDirectory;

        return $this;
    }

    /**
     * Dump the contents of the database to the given file.
     *
     * @param string $dumpFile
     *
     * @throws \Spatie\DbDumper\Exceptions\CannotStartDump
     * @throws \Spatie\DbDumper\Exceptions\DumpFailed
     */
    public function dumpToFile($dumpFile)
    {
        $this->guardAgainstIncompleteCredentials();

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

        $process = new Process($command);

        $process->run();

        $this->checkIfDumpWasSuccessFul($process, $dumpFile);
    }

    /**
     * Get the command that should be performed to dump the database.
     *
     * @param string $dumpFile
     *
     * @return string
     */
    public function getDumpCommand($dumpFile)
    {
        $command = [
            "{$this->dumpBinaryPath}pg_dump",
            "-d {$this->dbName}",
            "-U {$this->userName}",
            "-W {$this->password}",
        ];

        if ($this->socketDirectory === '') {
            $command[] = "-h {$this->host}";
        } else {
            $command[] = "-h {$this->socketDirectory}";
        }

        $command[] = "-p {$this->port}";
        $command[] = "--file={$dumpFile}";

        return implode(' ', $command);
    }

    protected function guardAgainstIncompleteCredentials()

This method seems to be duplicated in your project.

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