WebinoDbDump\Db\Dump\Dump

Complexity

Total Complexity

18

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getDumpPlatform()	0	7	2
A	setDumpPlatform()	0	12	2
A	setAdapter()	0	12	3
A	createOutputFile()	0	12	2
A	createInputFile()	0	12	2
A	save()	0	6	1
A	write()	0	16	2
A	load()	0	6	1
A	read()	0	7	2

<?php
/**
 * Webino (http://webino.sk)
 *
 * @link        https://github.com/webino/WebinoDbDump/ for the canonical source repository
 * @copyright   Copyright (c) 2014-2017 Webino, s. r. o. (http://webino.sk)
 * @author      Peter Bačinský <peter@bacinsky.sk>
 * @license     BSD-3-Clause
 */

namespace WebinoDbDump\Db\Dump;

use SplFileObject as File;
use WebinoDbDump\Db\Dump\Platform\PlatformInterface;
use WebinoDbDump\Db\Sql\SqlFile;
use WebinoDbDump\Db\Sql\SqlInterface;
use WebinoDbDump\Exception;
use WebinoDbDump\Module;
use Zend\Db\Adapter\AdapterInterface;

/**
 * Database dump utility
 */
class Dump implements DumpInterface
{
    /**
     * SQL chunk size
     */
    const MAX_SQL_SIZE = 1e6;

    /**
     * @var Adapter
     */
    protected $adapter;

    /**
     * @var PlatformInterface
     */
    protected $dumpPlatform;

    /**
     * @param AdapterInterface|Adapter $adapter
     */
    public function __construct($adapter)
    {
        $this->setAdapter($adapter);
    }

    /**
     * @param AdapterInterface|Adapter $adapter
     * @return $this
     * @throws Exception\InvalidArgumentException
     */
    protected function setAdapter($adapter)
    {
        if ($adapter instanceof AdapterInterface) {
            $adapter = new Adapter($adapter);

        } elseif (!($adapter instanceof Adapter)) {
            throw new Exception\InvalidArgumentException('Expected Db\Adapter or Dump\Adapter');
        }

        $this->adapter = $adapter;
        return $this;
    }

    /**
     * @return PlatformInterface
     */
    public function getDumpPlatform()
    {
        if (null === $this->dumpPlatform) {
            $this->setDumpPlatform();
        }
        return $this->dumpPlatform;
    }

    /**
     * @param PlatformInterface $dumpPlatform
     * @return $this
     */
    public function setDumpPlatform(PlatformInterface $dumpPlatform = null)
    {
        if (null === $dumpPlatform) {
            $parts         = explode('\\', get_class($this->adapter->getPlatform()));
            $platformName  = end($parts);
            $platformClass = __NAMESPACE__ . '\Platform\\' . $platformName . '\\' . $platformName;
            $dumpPlatform  = new $platformClass($this->adapter);
        }

        $this->dumpPlatform = $dumpPlatform;
        return $this;
    }

    /**
     * Return new file object
     *
     * Prepend file path with `compress.zlib://` wrapper to use compression.
     *
     * @param string $filePath
     * @return File
     * @throws Exception\RuntimeException
     */
    public function createOutputFile($filePath)
    {
        try {
            return new File($filePath, 'wb');
        } catch (\Exception $exc) {
            throw new Exception\RuntimeException(
                sprintf('Can\'t open file for writing `%s`', $filePath),
                $exc->getCode(),
                $exc
            );
        }
    }

    /**
     * Return new sql file object
     *
     * Prepend file path with `compress.zlib://` wrapper to use compression.
     *
     * @param string $filePath
     * @return SqlFile
     * @throws Exception\RuntimeException
     */
    public function createInputFile($filePath)
    {
        try {
            return new SqlFile($filePath, 'rb');
        } catch (\Exception $exc) {
            throw new Exception\RuntimeException(
                sprintf('Can\'t open file for reading `%s`', $filePath),
                $exc->getCode(),
                $exc
            );
        }
    }

    /**
     * @param string $filePath
     * @return $this
     */
    public function save($filePath)
    {
        $file = $this->createOutputFile($filePath);
        $this->write($file);
        return $this;
    }

    /**
     * @param File $file
     * @return $this
     */
    public function write(File $file)
    {
        $file->fwrite('-- WebinoDbDump ' . Module::VERSION . PHP_EOL . PHP_EOL);

        $dumpPlatform = $this->getDumpPlatform();
        $file->fwrite($dumpPlatform->header());

        foreach ($dumpPlatform->showTables() as $table) {
            $dumpPlatform->createTable($table)->write($file);

It seems like $table defined by $table on line 161 can also be of type array or null; however, WebinoDbDump\Db\Dump\Platform\PlatformInterface::createTable() does only seem to accept object<ArrayObject>, maybe add an additional type check?

        }

        $file->fwrite($dumpPlatform->footer());
        $file->fwrite('-- ' . date('Y-m-d H:i:s') . PHP_EOL);

        return $this;
    }

    /**
     * @param string $filePath
     * @return $this
     */
    public function load($filePath)
    {
        $file = $this->createInputFile($filePath);
        $this->read($file);
        return $this;
    }

    /**
     * @param SqlInterface $file
     * @return $this
     */
    public function read(SqlInterface $file)
    {
        foreach ($file as $sql) {
            $this->adapter->executeQuery($sql);
        }
        return $this;
    }
}