Install - Code Metrics - nystudio107/craft-retour - Measure and Improve Code Quality continuously with Scrutinizer

Install A
last analyzed 2025-02-12 21:22 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	266
Duplicated Lines	0 %

Importance

Changes	3
Bugs	3	Features	0

Metric	Value
wmc	11
eloc	156
c	3
b	3
f	0
dl	0
loc	266
rs	10

7 Methods

Rating	Name	Size	Complexity
A	safeDown()	6	1
B	createTables()	85	4
A	safeUp()	17	2
A	addForeignKeys()	30	1
A	createIndexes()	70	1
A	insertDefaultData()	2	1
A	removeTables()	5	1

<?php
/**
 * Retour plugin for Craft CMS
 *
 * 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\db\Migration;
use nystudio107\retour\widgets\RetourWidget;

/**

 * @author    nystudio107

 * @package   Retour

 * @since     3.0.0

 */

class Install extends Migration
{
    // Public Properties
    // =========================================================================

    /**

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

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

    /**

     * @inheritdoc
     */

    public function safeUp(): bool
    {
        $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();
        }

        // Update retour widget type
        $this->update('{{%widgets}}', [

            'type' => RetourWidget::class,
        ], ['type' => 'Retour']);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.

        return true;
    }

    /**

     * @inheritdoc
     */

    public function safeDown(): bool
    {
        $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(),

                    'siteId' => $this->integer()->null()->defaultValue(null),
                    'associatedElementId' => $this->integer()->notNull(),
                    'enabled' => $this->boolean()->defaultValue(true),
                    '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),
                    'priority' => $this->integer()->null()->defaultValue(5),
                    '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(),

                    'siteId' => $this->integer()->null()->defaultValue(null),
                    'associatedElementId' => $this->integer()->notNull(),
                    'enabled' => $this->boolean()->defaultValue(true),
                    '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),
                    'priority' => $this->integer()->null()->defaultValue(5),
                    '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(),

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

        return $tablesCreated;
    }

    /**

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

        $this->createIndex(
            $this->db->getIndexName(),
            '{{%retour_redirects}}',
            'redirectSrcUrlParsed',
            false
        );

        $this->createIndex(
            $this->db->getIndexName(),
            '{{%retour_static_redirects}}',
            'redirectSrcUrl',
            false
        );

        $this->createIndex(
            $this->db->getIndexName(),
            '{{%retour_redirects}}',
            'redirectSrcUrl',
            false
        );

        $this->createIndex(
            $this->db->getIndexName(),
            '{{%retour_stats}}',
            'redirectSrcUrl',
            false
        );

        $this->createIndex(
            $this->db->getIndexName(),
            '{{%retour_static_redirects}}',
            'redirectMatchType',
            false
        );

        $this->createIndex(
            $this->db->getIndexName(),
            '{{%retour_redirects}}',
            'redirectMatchType',
            false
        );

        $this->createIndex(
            $this->db->getIndexName(),
            '{{%retour_redirects}}',
            'siteId',
            false
        );

        $this->createIndex(
            $this->db->getIndexName(),
            '{{%retour_static_redirects}}',
            'siteId',
            false
        );

        $this->createIndex(
            $this->db->getIndexName(),
            '{{%retour_stats}}',
            'siteId',
            false
        );
    }

    /**

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

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

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

    /**

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

    /**

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


1			<?php
2			/**
3			* Retour plugin for Craft CMS
4			*
5			* Retour allows you to intelligently redirect legacy URLs, so that you don't
6			* lose SEO value when rebuilding & restructuring a website
7			*
8			* @link https://nystudio107.com/
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @copyright tag Loading history...
9			* @copyright Copyright (c) 2018 nystudio107
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
10			*/
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history...
11
12			namespace nystudio107\retour\migrations;
13
14			use Craft;
15			use craft\db\Migration;
16			use nystudio107\retour\widgets\RetourWidget;
17
18			/**
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
19			* @author nystudio107
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @package tag Loading history... Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history... Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Tag value for @author tag indented incorrectly; expected 2 spaces but found 4 Loading history...
20			* @package Retour
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Tag value for @package tag indented incorrectly; expected 1 spaces but found 3 Loading history...
21			* @since 3.0.0
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report The tag in position 3 should be the @author tag Loading history... Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Tag value for @since tag indented incorrectly; expected 3 spaces but found 5 Loading history...
22			*/
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
23			class Install extends Migration
24			{
25			// Public Properties
26			// =========================================================================
27
28			/**
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
29			* @var ?string The database driver to use
30			*/
31			public ?string $driver = null;
32
33			// Public Methods
34			// =========================================================================
35
36			/**
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
37			* @inheritdoc
38			*/
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
39			public function safeUp(): bool
40			{
41			$this->driver = Craft::$app->getConfig()->getDb()->driver;
42			if ($this->createTables()) {
43			$this->createIndexes();
44			$this->addForeignKeys();
45			// Refresh the db schema caches
46			Craft::$app->db->schema->refresh();
47			$this->insertDefaultData();
48			}
49
50			// Update retour widget type
51			$this->update('{{%widgets}}', [
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report The opening parenthesis of a multi-line function call should be the last content on the line. Loading history...
52			'type' => RetourWidget::class,
53			], ['type' => 'Retour']);
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report For multi-line function calls, the closing parenthesis should be on a new line. If a function call spawns multiple lines, the coding standard suggests to move the closing parenthesis to a new line: someFunctionCall( $firstArgument, $secondArgument, $thirdArgument ); // Closing parenthesis on a new line. Loading history...
54
55			return true;
56			}
57
58			/**
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
59			* @inheritdoc
60			*/
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
61			public function safeDown(): bool
62			{
63			$this->driver = Craft::$app->getConfig()->getDb()->driver;
64			$this->removeTables();
65
66			return true;
67			}
68
69			// Protected Methods
70			// =========================================================================
71
72			/**
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
73			* @return bool
74			*/
75			protected function createTables(): bool
76			{
77			$tablesCreated = false;
78
79			$tableSchema = Craft::$app->db->schema->getTableSchema('{{%retour_redirects}}');
80			if ($tableSchema === null) {
81			$tablesCreated = true;
82			$this->createTable(
83			'{{%retour_redirects}}',
84			[
85			'id' => $this->primaryKey(),
86			'dateCreated' => $this->dateTime()->notNull(),
87			'dateUpdated' => $this->dateTime()->notNull(),
88			'uid' => $this->uid(),
89
90			'siteId' => $this->integer()->null()->defaultValue(null),
91			'associatedElementId' => $this->integer()->notNull(),
92			'enabled' => $this->boolean()->defaultValue(true),
93			'redirectSrcUrl' => $this->string(255)->defaultValue(''),
94			'redirectSrcUrlParsed' => $this->string(255)->defaultValue(''),
95			'redirectSrcMatch' => $this->string(32)->defaultValue('pathonly'),
96			'redirectMatchType' => $this->string(32)->defaultValue('exactmatch'),
97			'redirectDestUrl' => $this->string(255)->defaultValue(''),
98			'redirectHttpCode' => $this->integer()->defaultValue(301),
99			'priority' => $this->integer()->null()->defaultValue(5),
100			'hitCount' => $this->integer()->defaultValue(1),
101			'hitLastTime' => $this->dateTime(),
102			]
103			);
104			}
105
106			$tableSchema = Craft::$app->db->schema->getTableSchema('{{%retour_static_redirects}}');
107			if ($tableSchema === null) {
108			$tablesCreated = true;
109			$this->createTable(
110			'{{%retour_static_redirects}}',
111			[
112			'id' => $this->primaryKey(),
113			'dateCreated' => $this->dateTime()->notNull(),
114			'dateUpdated' => $this->dateTime()->notNull(),
115			'uid' => $this->uid(),
116
117			'siteId' => $this->integer()->null()->defaultValue(null),
118			'associatedElementId' => $this->integer()->notNull(),
119			'enabled' => $this->boolean()->defaultValue(true),
120			'redirectSrcUrl' => $this->string(255)->defaultValue(''),
121			'redirectSrcUrlParsed' => $this->string(255)->defaultValue(''),
122			'redirectSrcMatch' => $this->string(32)->defaultValue('pathonly'),
123			'redirectMatchType' => $this->string(32)->defaultValue('exactmatch'),
124			'redirectDestUrl' => $this->string(255)->defaultValue(''),
125			'redirectHttpCode' => $this->integer()->defaultValue(301),
126			'priority' => $this->integer()->null()->defaultValue(5),
127			'hitCount' => $this->integer()->defaultValue(1),
128			'hitLastTime' => $this->dateTime(),
129			]
130			);
131			}
132
133			$tableSchema = Craft::$app->db->schema->getTableSchema('{{%retour_stats}}');
134			if ($tableSchema === null) {
135			$tablesCreated = true;
136			$this->createTable(
137			'{{%retour_stats}}',
138			[
139			'id' => $this->primaryKey(),
140			'dateCreated' => $this->dateTime()->notNull(),
141			'dateUpdated' => $this->dateTime()->notNull(),
142			'uid' => $this->uid(),
143
144			'siteId' => $this->integer()->null()->defaultValue(null),
145			'redirectSrcUrl' => $this->string(255)->defaultValue(''),
146			'referrerUrl' => $this->string(2000)->defaultValue(''),
147			'remoteIp' => $this->string(45)->defaultValue(''),
148			'userAgent' => $this->string(255)->defaultValue(''),
149			'exceptionMessage' => $this->string(255)->defaultValue(''),
150			'exceptionFilePath' => $this->string(255)->defaultValue(''),
151			'exceptionFileLine' => $this->integer()->defaultValue(0),
152			'hitCount' => $this->integer()->defaultValue(1),
153			'hitLastTime' => $this->dateTime(),
154			'handledByRetour' => $this->boolean()->defaultValue(false),
155			]
156			);
157			}
158
159			return $tablesCreated;
160			}
161
162			/**
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
163			* @return void
164			*/
165			protected function createIndexes(): void
166			{
167			$this->createIndex(
168			$this->db->getIndexName(),
169			'{{%retour_static_redirects}}',
170			'redirectSrcUrlParsed',
171			false
172			);
173
174			$this->createIndex(
175			$this->db->getIndexName(),
176			'{{%retour_redirects}}',
177			'redirectSrcUrlParsed',
178			false
179			);
180
181			$this->createIndex(
182			$this->db->getIndexName(),
183			'{{%retour_static_redirects}}',
184			'redirectSrcUrl',
185			false
186			);
187
188			$this->createIndex(
189			$this->db->getIndexName(),
190			'{{%retour_redirects}}',
191			'redirectSrcUrl',
192			false
193			);
194
195			$this->createIndex(
196			$this->db->getIndexName(),
197			'{{%retour_stats}}',
198			'redirectSrcUrl',
199			false
200			);
201
202			$this->createIndex(
203			$this->db->getIndexName(),
204			'{{%retour_static_redirects}}',
205			'redirectMatchType',
206			false
207			);
208
209			$this->createIndex(
210			$this->db->getIndexName(),
211			'{{%retour_redirects}}',
212			'redirectMatchType',
213			false
214			);
215
216			$this->createIndex(
217			$this->db->getIndexName(),
218			'{{%retour_redirects}}',
219			'siteId',
220			false
221			);
222
223			$this->createIndex(
224			$this->db->getIndexName(),
225			'{{%retour_static_redirects}}',
226			'siteId',
227			false
228			);
229
230			$this->createIndex(
231			$this->db->getIndexName(),
232			'{{%retour_stats}}',
233			'siteId',
234			false
235			);
236			}
237
238			/**
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
239			* @return void
240			*/
241			protected function addForeignKeys(): void
242			{
243			$this->addForeignKey(
244			$this->db->getForeignKeyName(),
245			'{{%retour_redirects}}',
246			'associatedElementId',
247			'{{%elements}}',
248			'id',
249			'CASCADE',
250			'CASCADE'
251			);
252
253			$this->addForeignKey(
254			$this->db->getForeignKeyName(),
255			'{{%retour_static_redirects}}',
256			'siteId',
257			'{{%sites}}',
258			'id',
259			'CASCADE',
260			'CASCADE'
261			);
262
263			$this->addForeignKey(
264			$this->db->getForeignKeyName(),
265			'{{%retour_stats}}',
266			'siteId',
267			'{{%sites}}',
268			'id',
269			'CASCADE',
270			'CASCADE'
271			);
272			}
273
274			/**
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
275			* @return void
276			*/
277			protected function insertDefaultData(): void
278			{
279			}
280
281			/**
			0 ignored issues – show Coding Style introduced 2020-07-05 03:50 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
282			* @return void
283			*/
284			protected function removeTables(): void
285			{
286			$this->dropTableIfExists('{{%retour_redirects}}');
287			$this->dropTableIfExists('{{%retour_static_redirects}}');
288			$this->dropTableIfExists('{{%retour_stats}}');
289			}
290			}
291

nystudio107 / craft-retour

Install A last analyzed 2025-02-12 21:22 UTC

Complexity

Size/Duplication

Importance

7 Methods

Duplication Side-by-Side

Filter issues like

Install A
last analyzed 2025-02-12 21:22 UTC