nystudio107\retour\migrations\Install

Complexity

Total Complexity

11

Size/Duplication

Total Lines	205
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	safeDown()	0	6	1
A	safeUp()	0	12	2
A	addForeignKeys()	0	10	1
B	createTables()	0	76	4
A	createIndexes()	0	21	1
A	insertDefaultData()	0	2	1
A	removeTables()	0	5	1

<?php
/**
 * Retour plugin for Craft CMS 3.x
 *
 * Retour allows you to intelligently redirect legacy URLs, so that you don't
 * lose SEO value when rebuilding & restructuring a website
 *
 * @link      https://nystudio107.com/
 * @copyright Copyright (c) 2018 nystudio107
 */

namespace nystudio107\retour\migrations;

use Craft;
use craft\config\DbConfig;
use craft\db\Migration;

/**
 * @author    nystudio107
 * @package   Retour
 * @since     3.0.0
 */
class Install extends Migration
{
    // Public Properties
    // =========================================================================

    /**
     * @var string The database driver to use
     */
    public $driver;

    // Public Methods
    // =========================================================================

    /**
     * @inheritdoc
     */
    public function safeUp()
    {
        $this->driver = Craft::$app->getConfig()->getDb()->driver;
        if ($this->createTables()) {
            $this->createIndexes();
            $this->addForeignKeys();
            // Refresh the db schema caches
            Craft::$app->db->schema->refresh();
            $this->insertDefaultData();
        }

        return true;
    }

    /**
     * @inheritdoc
     */
    public function safeDown()
    {
        $this->driver = Craft::$app->getConfig()->getDb()->driver;
        $this->removeTables();

        return true;
    }

    // Protected Methods
    // =========================================================================

    /**
     * @return bool
     */
    protected function createTables(): bool
    {
        $tablesCreated = false;

        $tableSchema = Craft::$app->db->schema->getTableSchema('{{%retour_redirects}}');
        if ($tableSchema === null) {
            $tablesCreated = true;
            $this->createTable(
                '{{%retour_redirects}}',
                [
                    'id'          => $this->primaryKey(),
                    'dateCreated' => $this->dateTime()->notNull(),
                    'dateUpdated' => $this->dateTime()->notNull(),
                    'uid'         => $this->uid(),

                    'locale'               => $this->string(12)->defaultValue('en-US'),
                    'associatedElementId'  => $this->integer()->notNull(),
                    'redirectSrcUrl'       => $this->string(255)->defaultValue(''),
                    'redirectSrcUrlParsed' => $this->string(255)->defaultValue(''),
                    'redirectSrcMatch'     => $this->string(32)->defaultValue('pathonly'),
                    'redirectMatchType'    => $this->string(32)->defaultValue('exactmatch'),
                    'redirectDestUrl'      => $this->string(255)->defaultValue(''),
                    'redirectHttpCode'     => $this->integer()->defaultValue(301),
                    'hitCount'             => $this->integer()->defaultValue(1),
                    'hitLastTime'          => $this->dateTime(),
                ]
            );
        }

        $tableSchema = Craft::$app->db->schema->getTableSchema('{{%retour_static_redirects}}');
        if ($tableSchema === null) {
            $tablesCreated = true;
            $this->createTable(
                '{{%retour_static_redirects}}',
                [
                    'id'          => $this->primaryKey(),
                    'dateCreated' => $this->dateTime()->notNull(),
                    'dateUpdated' => $this->dateTime()->notNull(),
                    'uid'         => $this->uid(),

                    'locale'               => $this->string(12)->defaultValue('en-US'),
                    'associatedElementId'  => $this->integer()->notNull(),
                    'redirectSrcUrl'       => $this->string(255)->defaultValue(''),
                    'redirectSrcUrlParsed' => $this->string(255)->defaultValue(''),
                    'redirectSrcMatch'     => $this->string(32)->defaultValue('pathonly'),
                    'redirectMatchType'    => $this->string(32)->defaultValue('exactmatch'),
                    'redirectDestUrl'      => $this->string(255)->defaultValue(''),
                    'redirectHttpCode'     => $this->integer()->defaultValue(301),
                    'hitCount'             => $this->integer()->defaultValue(1),
                    'hitLastTime'          => $this->dateTime(),
                ]
            );
        }

        $tableSchema = Craft::$app->db->schema->getTableSchema('{{%retour_stats}}');
        if ($tableSchema === null) {
            $tablesCreated = true;
            $this->createTable(
                '{{%retour_stats}}',
                [
                    'id'          => $this->primaryKey(),
                    'dateCreated' => $this->dateTime()->notNull(),
                    'dateUpdated' => $this->dateTime()->notNull(),
                    'uid'         => $this->uid(),

                    'redirectSrcUrl'  => $this->string(255)->defaultValue(''),
                    'referrerUrl'     => $this->string(2000)->defaultValue(''),
                    'remoteIp'        => $this->string(45)->defaultValue(''),
                    'hitCount'        => $this->integer()->defaultValue(1),
                    'hitLastTime'     => $this->dateTime(),
                    'handledByRetour' => $this->boolean()->defaultValue(false),
                ]
            );
        }

        return $tablesCreated;
    }

    /**
     * @return void
     */
    protected function createIndexes()
    {
        $this->createIndex(
            $this->db->getIndexName(
                '{{%retour_static_redirects}}',
                'redirectSrcUrlParsed',
                true
            ),
            '{{%retour_static_redirects}}',
            'redirectSrcUrlParsed',
            true
        );
        $this->createIndex(
            $this->db->getIndexName(
                '{{%retour_redirects}}',
                'redirectSrcUrlParsed',
                true
            ),
            '{{%retour_redirects}}',
            'redirectSrcUrlParsed',
            true
        );
    }

    /**
     * @return void
     */
    protected function addForeignKeys()
    {
        $this->addForeignKey(
            $this->db->getForeignKeyName('{{%retour_redirects}}', 'siteId'),
            '{{%retour_redirects}}',
            'associatedElementId',
            '{{%elements}}',
            'id',
            'CASCADE',
            'CASCADE'
        );

        /*
        $this->addForeignKey(
            $this->db->getForeignKeyName('{{%retour_redirects}}', 'siteId'),
            '{{%retour_redirects}}',
            'siteId',
            '{{%sites}}',
            'id',
            'CASCADE',
            'CASCADE'
        );

        $this->addForeignKey(
            $this->db->getForeignKeyName('{{%retour_stats}}', 'siteId'),
            '{{%retour_stats}}',
            'siteId',
            '{{%sites}}',
            'id',
            'CASCADE',
            'CASCADE'
        );
        */
    }

    /**
     * @return void
     */
    protected function insertDefaultData()
    {
    }

    /**
     * @return void
     */
    protected function removeTables()
    {
        $this->dropTableIfExists('{{%retour_redirects}}');
        $this->dropTableIfExists('{{%retour_static_redirects}}');
        $this->dropTableIfExists('{{%retour_stats}}');
    }
}