Arrilot\BitrixMigrations\Storages\BitrixDatabaseStorage

Complexity

Total Complexity

11

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	checkMigrationTableExistence()	0	4	1
A	createMigrationTable()	0	4	1
A	getRanMigrations()	0	11	2
A	logSuccessfulMigration()	0	6	1
A	removeSuccessfulMigrationFromLog()	0	4	1
A	startTransaction()	0	4	1
A	commitTransaction()	0	4	1
A	rollbackTransaction()	0	4	1
A	getTableName()	0	4	1

<?php

namespace Arrilot\BitrixMigrations\Storages;

use Arrilot\BitrixMigrations\Interfaces\DatabaseStorageInterface;
use Bitrix\Main\Application;
use CDatabase;

class BitrixDatabaseStorage implements DatabaseStorageInterface
{
    /**
     * Bitrix $DB object.
     *
     * @var CDatabase
     */
    protected $db;

    /**
     * Table in DB to store migrations that have been already ran.
     *
     * @var string
     */
    protected $table;

    /**
     * BitrixDatabaseStorage constructor.
     *
     * @param $table
     */
    public function __construct($table)
    {
        global $DB;

        $this->db = $DB;
        $this->table = $table;
    }

    /**
     * Check if a given table already exists.
     *
     * @return bool
     */
    public function checkMigrationTableExistence()
    {
        return (bool) $this->db->query('SHOW TABLES LIKE "'.$this->table.'"')->fetch();
    }

    /**
     * Create migration table.
     *
     * @return void
     */
    public function createMigrationTable()
    {
        $this->db->query("CREATE TABLE {$this->table} (ID INT NOT NULL AUTO_INCREMENT, MIGRATION VARCHAR(255) NOT NULL, PRIMARY KEY (ID))");
    }

    /**
     * Get an array of migrations the have been ran previously.
     * Must be ordered by order asc.
     *
     * @return array
     */
    public function getRanMigrations()
    {
        $migrations = [];

        $dbRes = $this->db->query("SELECT MIGRATION FROM {$this->table} ORDER BY ID ASC");
        while ($result = $dbRes->fetch()) {
            $migrations[] = $result['MIGRATION'];
        }

        return $migrations;
    }

    /**
     * Save migration name to the database to prevent it from running again.
     *
     * @param string $name
     *
     * @return void
     */
    public function logSuccessfulMigration($name)
    {
        $this->db->insert($this->table, [
            'MIGRATION' => "'".$this->db->forSql($name)."'",
        ]);
    }

    /**
     * Remove a migration name from the database so it can be run again.
     *
     * @param string $name
     *
     * @return void
     */
    public function removeSuccessfulMigrationFromLog($name)
    {
        $this->db->query("DELETE FROM {$this->table} WHERE MIGRATION = '".$this->db->forSql($name)."'");
    }

    /**
     * Start transaction
     */
    public function startTransaction()
    {
        $this->db->StartTransaction();
    }

    /**
     * Commit transaction
     */
    public function commitTransaction()
    {
        $this->db->Commit();
    }

    /**
     * Rollback transaction
     */
    public function rollbackTransaction()
    {
        $this->db->Rollback();
    }

    /**
     * @inheritDoc
     */
    public function getTableName()
    {
        return $this->table;
    }
}