studioespresso/craft-seo-fields

<?php

namespace studioespresso\seofields\migrations;

use Craft;
use craft\db\Migration;
use studioespresso\seofields\records\DefaultsRecord;
use studioespresso\seofields\records\NotFoundRecord;
use studioespresso\seofields\records\RedirectRecord;

/***
 * @author    Studio Espresso
 * @package   SeoFields
 * @since     1.0.0
 */
class Install extends Migration
{
    // Public Properties
    // =========================================================================
    public $driver;

    // Public Methods
    // =========================================================================
    public function safeUp()
    {
        $this->driver = Craft::$app->getConfig()->getDb()->driver;
        if ($this->createTables()) {
            $this->addForeignKeys();
            // Refresh the db schema caches
            Craft::$app->db->schema->refresh();
            $this->createSiteDefaults();
        }

        return true;
    }

    public function safeDown()
    {
        $this->driver = Craft::$app->getConfig()->getDb()->driver;
        $this->removeTables();
        return true;
    }

    // Protected Methods
    // =========================================================================
    protected function createSiteDefaults()
    {
        $sites = Craft::$app->getSites()->getAllSiteIds();
        foreach ($sites as $siteId) {
            $default = new DefaultsRecord();
            $default->setAttribute('siteId', $siteId);
            $default->setAttribute('enableRobots', true);
            $default->setAttribute('robots', file_get_contents(Craft::$app->getVendorPath() . '/studioespresso/craft-seo-fields/src/templates/_placeholder/_robots.twig'));
            if ($default->validate()) {
                $default->save();
            }
        }
    }

    protected function createTables()
    {
        $tablesCreated = false;
        $tableSchema = Craft::$app->db->schema->getTableSchema(DefaultsRecord::tableName());
        if ($tableSchema === null) {
            $tablesCreated = true;
            $this->createTable(
                DefaultsRecord::tableName(),
                [
                    'id' => $this->primaryKey(),
                    'siteId' => $this->integer(11)->notNull(),
                    'defaultMeta' => $this->text(),
                    'enableRobots' => $this->boolean()->defaultValue(1),
                    'robots' => $this->text(),
                    'schema' => $this->text(),
                    'sitemap' => $this->text(),
                    'dateCreated' => $this->dateTime()->notNull(),
                    'dateUpdated' => $this->dateTime()->notNull(),
                    'uid' => $this->uid(),
                ]
            );

            $this->createTable(
                RedirectRecord::tableName(),
                [
                    'id' => $this->primaryKey(),
                    'siteId' => $this->integer(11)->defaultValue(null),
                    'pattern' => $this->string(255)->notNull(),
                    'sourceMatch' => $this->string(),
                    'redirect' => $this->string(255)->notNull(),
                    'matchType' => $this->string(),
                    'counter' => $this->bigInteger(),
                    'method' => $this->integer(3)->notNull(),
                    'dateLastHit' => $this->dateTime(),
                    'dateCreated' => $this->dateTime()->notNull(),
                    'dateUpdated' => $this->dateTime()->notNull(),
                    'uid' => $this->uid(),
                ]
            );

            $this->createTable(
                NotFoundRecord::tableName(),
                [
                    'id' => $this->primaryKey(),
                    'siteId' => $this->integer(11)->notNull(),
                    'fullUrl' => $this->text(),
                    'urlPath' => $this->text(),
                    'urlParams' => $this->text(),
                    'referrer' => $this->text(),
                    'handled' => $this->boolean()->defaultValue(0),
                    'counter' => $this->bigInteger(),
                    'redirect' => $this->integer(11),
                    'dateLastHit' => $this->dateTime()->notNull(),
                    'dateCreated' => $this->dateTime()->notNull(),
                    'dateUpdated' => $this->dateTime()->notNull(),
                    'uid' => $this->uid(),
                ]
            );
        }
        return $tablesCreated;
    }

    protected function addForeignKeys()
    {
        // $name, $table, $columns, $refTable, $refColumns, $delete = null, $update = null)
        $this->addForeignKey(
            $this->db->getForeignKeyName(DefaultsRecord::tableName(), 'siteId'),
            DefaultsRecord::tableName(),
            'siteId',
            '{{%sites}}',
            'id',
            'CASCADE'
        );

        $this->addForeignKey(
            $this->db->getForeignKeyName(RedirectRecord::tableName(), 'siteId'),
            RedirectRecord::tableName(),
            'siteId',
            '{{%sites}}',
            'id',
            'CASCADE'
        );

        $this->addForeignKey(
            $this->db->getForeignKeyName(NotFoundRecord::tableName(), 'siteId'),
            NotFoundRecord::tableName(),
            'siteId',
            '{{%sites}}',
            'id',
            'CASCADE'
        );

        $this->addForeignKey(
            $this->db->getForeignKeyName(NotFoundRecord::tableName(), 'redirect'),
            NotFoundRecord::tableName(),
            'redirect',
            '{{%seofields_redirects}}',
            'id',
            'SET NULL'
        );
    }

    protected function removeTables()
    {
        $this->dropTableIfExists(DefaultsRecord::tableName());
        $this->dropTableIfExists(NotFoundRecord::tableName());
        $this->dropTableIfExists(RedirectRecord::tableName());
    }
}