Y0lk\SQLDumper\SQLDumper

Complexity

Total Complexity

10

Size/Duplication

Total Lines	185
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
A	connect()	0	11	1
A	getListTableDumpers()	0	4	1
A	table()	0	4	1
A	listTables()	0	4	1
A	allTables()	0	15	1
A	dump()	0	9	1
A	save()	0	7	1
A	groupDrops()	0	4	1
A	groupInserts()	0	4	1

<?php
namespace Y0lk\SQLDumper;

use PDO;

/**
 * SQLDumper is used to create a complete dump from a SQL database
 *
 * @author Gabriel Jean <gabriel@inkrebit.com>
 */
class SQLDumper
{
    /**
     * @var string  Host for the DB connection
     */
    protected $host = '';

    /**
     * @var string  Name of the DB
     */
    protected $dbname = '';

    /**
     * @var string  Username used for the DB connection
     */
    protected $username = '';

    /**
     * @var string  Password used for the DB connection
     */
    protected $password = '';

    /**
     * @var PDO PDO instance of the DB
     */
    protected $db = NULL;

    /**
     * @var TableDumperCollection   Contains all TableDumper objects that will be used for this dump
     */
    protected $listTableDumpers;

    /**
     * @var boolean Determines if DROP statements should be grouped together
     */
    protected $groupDrops = false;

    /**
     * @var boolean Determines if INSERT statements should be grouped together
     */
    protected $groupInserts = false;


    /**
     * @param string    Host for the DB connection
     * @param string    Name of the DB
     * @param string    Username used for the DB connection
     * @param string    Password used for the DB connection
     */
    public function __construct(string $host, string $dbname, string $username, string $password = '') 
    {
        $this->host = $host;
        $this->dbname = $dbname;
        $this->username = $username;
        $this->password = $password;

        //Init main TableDumperCollection
        $this->listTableDumpers = new TableDumperCollection;
        $this->connect();
    }

    /**
     * Connects to the SQL database
     * 
     * @return void
     */
    protected function connect(): void
    {
        $this->db = new PDO('mysql:host='.$this->host.';dbname='.$this->dbname, 
                            $this->username, 
                            $this->password,
                            [
                                PDO::MYSQL_ATTR_INIT_COMMAND => "SET NAMES utf8",
                                PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION
                            ]
        );
    }

    /**
     * Get the main list of TableDumper
     * 
     * @return TableDumperCollection Returns the list of table dumpers as TableDumperCollection
     */
    public function getListTableDumpers(): TableDumperCollection
    {
        return $this->listTableDumpers;
    }

    /**
     * Set a TableDumper for the given table in order to specify certain dump options on it
     * 
     * @param  Table|string The table to set
     * 
     * @return TableDumper  Returns a TableDumper
     */
    public function table($table): TableDumper
    {
        return $this->listTableDumpers->addTable($table);
    }

    /**
     * Set a TableDumperCollection for the given list of tables in order to specify certain dump options on them
     * 
     * @param  TableDumperCollection|array<TableDumper|Table|string>    The list of tables to set (either as a TableDumperCollection, or an array containing either TableDumper objects, Table objects or table names) 
     * 
     * @return TableDumperCollection    Returns a TableDumperCollection
     */
    public function listTables($listTables): TableDumperCollection
    {   
        return $this->listTableDumpers->addListTables($listTables);
    }

    /**
     * Set a TableDumperCollection for all the tables in the database, in order to specify certain dump options on them
     * 
     * @return TableDumperCollection    Returns a TableDumperCollection
     */
    public function allTables(): TableDumperCollection
    {
        //Fetch all table names
        $stmt = $this->db->prepare('SELECT table_name FROM information_schema.tables WHERE table_schema=:dbname');
        $stmt->bindValue(':dbname', $this->dbname, PDO::PARAM_STR);
        $stmt->execute();

        $listRows = $stmt->fetchAll(PDO::FETCH_COLUMN);
        $stmt->closeCursor();

        //Call list tables with returned table names
        $listDumpers = $this->listTables($listRows);

        return $listDumpers;
    }

    /**
     * Writes the complete dump of the database to the given stream
     * 
     * @param  resource Stream to write to
     * 
     * @return void
     */
    public function dump($stream): void
    {
        //TODO: Find a way to not use that an instead execute all foreign key constraints at the end
        fwrite($stream, "SET FOREIGN_KEY_CHECKS=0;\r\n");

        $this->listTableDumpers->dump($this->db, $stream, $this->groupDrops, $this->groupInserts);

        fwrite($stream, "SET FOREIGN_KEY_CHECKS=1;\r\n");
    }

    /**
     * Creates and saves the dump to a file
     * 
     * @param  string   File name for the dump
     * 
     * @return void
     */
    public function save(string $filename): void
    {
        $stream = fopen($filename, 'w');
        
        $this->dump($stream);
        fclose($stream);
    }

    /**
     * Set parameter that determines if DROP statements should be grouped together
     * @param  bool   $group Set to TRUE if it should be grouped, FALSE otherwise
     * @return void
     */
    public function groupDrops(bool $group): void
    {
        $this->groupDrops = $group;
    }

    /**
     * Set parameter that determines if INSERT statements should be grouped together
     * @param  bool   $group Set to TRUE if it should be grouped, FALSE otherwise
     * @return void
     */
    public function groupInserts(bool $group): void
    {
        $this->groupInserts = $group;
    }
}