nystudio107 / craft-retour

src/models/Settings.php

Spacing +17 added lines, -17 removed lines

@@ -135,8 +135,8 @@ 
     public function rules()
     {
         return [
-            ['pluginName', 'string'],
-            ['pluginName', 'default', 'value' => 'Retour'],
+            [ 'pluginName', 'string' ],
+            [ 'pluginName', 'default', 'value' => 'Retour' ],
             [
                 [
                     'createUriChangeRedirects',
@@ -147,22 +147,22 @@ 
                 ],
                 'boolean',
             ],
-            ['uriChangeRedirectSrcMatch', 'default', 'value' => 'pathonly'],
-            ['uriChangeRedirectSrcMatch', 'string'],
-            ['uriChangeRedirectSrcMatch', 'in', 'range' => [
+            [ 'uriChangeRedirectSrcMatch', 'default', 'value' => 'pathonly' ],
+            [ 'uriChangeRedirectSrcMatch', 'string' ],
+            [ 'uriChangeRedirectSrcMatch', 'in', 'range' => [
                 'pathonly',
                 'fullurl'
-            ]],
-            ['staticRedirectDisplayLimit', 'integer', 'min' => 1],
-            ['staticRedirectDisplayLimit', 'default', 'value' => 100],
-            ['dynamicRedirectDisplayLimit', 'integer', 'min' => 1],
-            ['dynamicRedirectDisplayLimit', 'default', 'value' => 100],
-            ['statsStoredLimit', 'integer', 'min' => 1],
-            ['statsStoredLimit', 'default', 'value' => 1000],
-            ['refreshIntervalSecs', 'integer', 'min' => 0],
-            ['refreshIntervalSecs', 'default', 'value' => 3],
-            ['statsDisplayLimit', 'integer', 'min' => 1],
-            ['statsDisplayLimit', 'default', 'value' => 1000],
+            ] ],
+            [ 'staticRedirectDisplayLimit', 'integer', 'min' => 1 ],
+            [ 'staticRedirectDisplayLimit', 'default', 'value' => 100 ],
+            [ 'dynamicRedirectDisplayLimit', 'integer', 'min' => 1 ],
+            [ 'dynamicRedirectDisplayLimit', 'default', 'value' => 100 ],
+            [ 'statsStoredLimit', 'integer', 'min' => 1 ],
+            [ 'statsStoredLimit', 'default', 'value' => 1000 ],
+            [ 'refreshIntervalSecs', 'integer', 'min' => 0 ],
+            [ 'refreshIntervalSecs', 'default', 'value' => 3 ],
+            [ 'statsDisplayLimit', 'integer', 'min' => 1 ],
+            [ 'statsDisplayLimit', 'default', 'value' => 1000 ],
             [
                 [
                     'excludePatterns',
@@ -178,7 +178,7 @@ 
      */
     public function behaviors()
     {
-        $craft31Behaviors = [];
+        $craft31Behaviors = [ ];
         if (Retour::$craft31) {
             $craft31Behaviors = [
                 'parser' => [

src/config.php

Indentation +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
     // Determines whether the Retour API endpoint should be enabled for anonymous frontend access
     'enableApiEndpoint' => false,
 
-     // [Regular expressions](https://regexr.com/) to match URLs to exclude from tracking
+        // [Regular expressions](https://regexr.com/) to match URLs to exclude from tracking
     'excludePatterns' => [
     ],
 

src/services/Redirects.php

Spacing +67 added lines, -67 removed lines

@@ -190,7 +190,7 @@ 
                 Craft::t(
                     'retour',
                     '404 full URL: {fullUrl}, 404 path only: {pathOnly}',
-                    ['fullUrl' => $fullUrl, 'pathOnly' => $pathOnly]
+                    [ 'fullUrl' => $fullUrl, 'pathOnly' => $pathOnly ]
                 ),
                 __METHOD__
             );
@@ -224,7 +224,7 @@ 
         $response = Craft::$app->getResponse();
         if ($redirect !== null) {
             // Figure out what type of source matching was done
-            $redirectSrcMatch = $redirect['redirectSrcMatch'] ?? 'pathonly';
+            $redirectSrcMatch = $redirect[ 'redirectSrcMatch' ] ?? 'pathonly';
             switch ($redirectSrcMatch) {
                 case 'pathonly':
                     $url = $pathOnly;
@@ -236,13 +236,13 @@ 
                     $url = $pathOnly;
                     break;
             }
-            $dest = $redirect['redirectDestUrl'];
+            $dest = $redirect[ 'redirectDestUrl' ];
             // If this isn't a full URL, make it one based on the appropriate site
             if (!UrlHelper::isFullUrl($dest)) {
                 try {
-                    $siteId = $redirect['siteId'] ?? null;
+                    $siteId = $redirect[ 'siteId' ] ?? null;
                     if ($siteId !== null) {
-                        $siteId = (int)$siteId;
+                        $siteId = (int) $siteId;
                     }
                     $dest = UrlHelper::siteUrl($dest, null, null, $siteId);
                 } catch (\yii\base\Exception $e) {
@@ -254,17 +254,17 @@ 
                     $dest .= '?' . $request->getQueryStringWithoutPath();
                 }
             }
-            $redirectMatchType = $redirect['redirectMatchType'] ?? 'notfound';
+            $redirectMatchType = $redirect[ 'redirectMatchType' ] ?? 'notfound';
             // Parse reference tags for exact matches
             if ($redirectMatchType === 'exactmatch') {
-                $dest = Craft::$app->elements->parseRefs($dest, $redirect['siteId'] ?? null);
+                $dest = Craft::$app->elements->parseRefs($dest, $redirect[ 'siteId' ] ?? null);
             }
-            $status = $redirect['redirectHttpCode'];
+            $status = $redirect[ 'redirectHttpCode' ];
             Craft::info(
                 Craft::t(
                     'retour',
                     'Redirecting {url} to {dest} with status {status}',
-                    ['url' => $url, 'dest' => $dest, 'status' => $status]
+                    [ 'url' => $url, 'dest' => $dest, 'status' => $status ]
                 ),
                 __METHOD__
             );
@@ -288,7 +288,7 @@ 
             // Add any additional headers
             if (!empty(Retour::$settings->additionalHeaders)) {
                 foreach (Retour::$settings->additionalHeaders as $additionalHeader) {
-                    $response->headers->add($additionalHeader['name'], $additionalHeader['value']);
+                    $response->headers->add($additionalHeader[ 'name' ], $additionalHeader[ 'value' ]);
                 }
             }
             // Redirect the request away;
@@ -354,13 +354,13 @@ 
     public function getRedirectFromCache($url, int $siteId = 0)
     {
         $cache = Craft::$app->getCache();
-        $cacheKey = $this::CACHE_KEY.md5($url).$siteId;
+        $cacheKey = $this::CACHE_KEY . md5($url) . $siteId;
         $redirect = $cache->get($cacheKey);
         Craft::info(
             Craft::t(
                 'retour',
                 'Cached redirect hit for {url}',
-                ['url' => $url]
+                [ 'url' => $url ]
             ),
             __METHOD__
         );
@@ -382,12 +382,12 @@ 
         } catch (SiteNotFoundException $e) {
             $siteId = 1;
         }
-        $cacheKey = $this::CACHE_KEY.md5($url).$siteId;
+        $cacheKey = $this::CACHE_KEY . md5($url) . $siteId;
         // Create the dependency tags
         $dependency = new TagDependency([
             'tags' => [
                 $this::GLOBAL_REDIRECTS_CACHE_TAG,
-                $this::GLOBAL_REDIRECTS_CACHE_TAG.$siteId,
+                $this::GLOBAL_REDIRECTS_CACHE_TAG . $siteId,
             ],
         ]);
         $cache->set($cacheKey, $redirect, Retour::$cacheDuration, $dependency);
@@ -395,7 +395,7 @@ 
             Craft::t(
                 'retour',
                 'Cached redirect saved for {url}',
-                ['url' => $url]
+                [ 'url' => $url ]
             ),
             __METHOD__
         );
@@ -425,8 +425,8 @@ 
         // Iterate through the redirects
         foreach ($redirects as $redirect) {
             // Figure out what type of source matching to do
-            $redirectSrcMatch = $redirect['redirectSrcMatch'] ?? 'pathonly';
-            $redirectEnabled = (bool)$redirect['enabled'];
+            $redirectSrcMatch = $redirect[ 'redirectSrcMatch' ] ?? 'pathonly';
+            $redirectEnabled = (bool) $redirect[ 'enabled' ];
             if ($redirectEnabled === true) {
                 switch ($redirectSrcMatch) {
                     case 'pathonly':
@@ -439,11 +439,11 @@ 
                         $url = $pathOnly;
                         break;
                 }
-                $redirectMatchType = $redirect['redirectMatchType'] ?? 'notfound';
+                $redirectMatchType = $redirect[ 'redirectMatchType' ] ?? 'notfound';
                 switch ($redirectMatchType) {
                     // Do a straight up match
                     case 'exactmatch':
-                        if (strcasecmp($redirect['redirectSrcUrlParsed'], $url) === 0) {
+                        if (strcasecmp($redirect[ 'redirectSrcUrlParsed' ], $url) === 0) {
                             $this->incrementRedirectHitCount($redirect);
                             $this->saveRedirectToCache($url, $redirect);
 
@@ -466,15 +466,15 @@ 
 
                     // Do a regex match
                     case 'regexmatch':
-                        $matchRegEx = '`'.$redirect['redirectSrcUrlParsed'].'`i';
+                        $matchRegEx = '`' . $redirect[ 'redirectSrcUrlParsed' ] . '`i';
                         try {
                             if (preg_match($matchRegEx, $url) === 1) {
                                 $this->incrementRedirectHitCount($redirect);
                                 // If we're not associated with an EntryID, handle capture group replacement
-                                if ((int)$redirect['associatedElementId'] === 0) {
-                                    $redirect['redirectDestUrl'] = preg_replace(
+                                if ((int) $redirect[ 'associatedElementId' ] === 0) {
+                                    $redirect[ 'redirectDestUrl' ] = preg_replace(
                                         $matchRegEx,
-                                        $redirect['redirectDestUrl'],
+                                        $redirect[ 'redirectDestUrl' ],
                                         $url
                                     );
                                 }
@@ -498,7 +498,7 @@ 
                             }
                         } catch (\Exception $e) {
                             // That's fine
-                            Craft::error('Invalid Redirect Regex: '.$matchRegEx, __METHOD__);
+                            Craft::error('Invalid Redirect Regex: ' . $matchRegEx, __METHOD__);
                         }
 
                         break;
@@ -512,7 +512,7 @@ 
                                     'redirect' => &$redirect,
                                 ],
                             ];
-                            $result = \call_user_func_array([$plugin, 'retourMatch'], $args);
+                            $result = \call_user_func_array([ $plugin, 'retourMatch' ], $args);
                             if ($result) {
                                 $this->incrementRedirectHitCount($redirect);
                                 $this->saveRedirectToCache($url, $redirect);
@@ -552,7 +552,7 @@ 
             Craft::t(
                 'retour',
                 'Not handled-> full URL: {fullUrl}, path only: {pathOnly}',
-                ['fullUrl' => $fullUrl, 'pathOnly' => $pathOnly]
+                [ 'fullUrl' => $fullUrl, 'pathOnly' => $pathOnly ]
             ),
             __METHOD__
         );
@@ -597,7 +597,7 @@ 
         foreach (Craft::$app->getPlugins()->getAllPlugins() as $plugin) {
             /** @var Plugin $plugin */
             if (method_exists($plugin, 'retourMatch')) {
-                $result[$plugin->getHandle()] = $plugin->name.Craft::t('retour', ' Match');
+                $result[ $plugin->getHandle() ] = $plugin->name . Craft::t('retour', ' Match');
             }
         }
 
@@ -618,12 +618,12 @@ 
         }
         // Query the db table
         $query = (new Query())
-            ->from(['{{%retour_static_redirects}}'])
+            ->from([ '{{%retour_static_redirects}}' ])
             ->orderBy('redirectMatchType ASC, redirectSrcMatch ASC, hitCount DESC');
         if ($siteId) {
             $query
-                ->where(['siteId' => $siteId])
-                ->orWhere(['siteId' => null]);
+                ->where([ 'siteId' => $siteId ])
+                ->orWhere([ 'siteId' => null ]);
         }
         if ($limit) {
             $query->limit($limit);
@@ -646,8 +646,8 @@ 
     {
         // Query the db table
         $redirect = (new Query())
-            ->from(['{{%retour_static_redirects}}'])
-            ->where(['id' => $id])
+            ->from([ '{{%retour_static_redirects}}' ])
+            ->where([ 'id' => $id ])
             ->one();
 
         return $redirect;
@@ -665,16 +665,16 @@ 
     {
         // Query the db table
         $query = (new Query())
-            ->from(['{{%retour_static_redirects}}'])
-            ->where(['redirectSrcUrl' => $redirectSrcUrl])
+            ->from([ '{{%retour_static_redirects}}' ])
+            ->where([ 'redirectSrcUrl' => $redirectSrcUrl ])
             ;
         if ($siteId) {
             $query
-                ->andWhere(['or', [
+                ->andWhere([ 'or', [
                     'siteId' => $siteId,
                 ], [
                     'siteId' => null,
-                ]]);
+                ] ]);
         }
         $redirect = $query->one();
 
@@ -716,13 +716,13 @@ 
     {
         if ($redirectConfig !== null) {
             $db = Craft::$app->getDb();
-            $redirectConfig['hitCount']++;
-            $redirectConfig['hitLastTime'] = Db::prepareDateForDb(new \DateTime());
+            $redirectConfig[ 'hitCount' ]++;
+            $redirectConfig[ 'hitLastTime' ] = Db::prepareDateForDb(new \DateTime());
             Craft::debug(
                 Craft::t(
                     'retour',
                     'Incrementing statistics for: {redirect}',
-                    ['redirect' => print_r($redirectConfig, true)]
+                    [ 'redirect' => print_r($redirectConfig, true) ]
                 ),
                 __METHOD__
             );
@@ -731,14 +731,14 @@ 
                 $rowsAffected = $db->createCommand()->update(
                     '{{%retour_static_redirects}}',
                     [
-                        'hitCount' => $redirectConfig['hitCount'],
-                        'hitLastTime' => $redirectConfig['hitLastTime'],
+                        'hitCount' => $redirectConfig[ 'hitCount' ],
+                        'hitLastTime' => $redirectConfig[ 'hitLastTime' ],
                     ],
                     [
-                        'id' => $redirectConfig['id'],
+                        'id' => $redirectConfig[ 'id' ],
                     ]
                 )->execute();
-                Craft::debug('Rows affected: '.$rowsAffected, __METHOD__);
+                Craft::debug('Rows affected: ' . $rowsAffected, __METHOD__);
             } catch (\Exception $e) {
                 Craft::error($e->getMessage(), __METHOD__);
             }
@@ -757,7 +757,7 @@ 
                 Craft::t(
                     'retour',
                     'Error validating redirect {id}: {errors}',
-                    ['id' => $redirect->id, 'errors' => print_r($redirect->getErrors(), true)]
+                    [ 'id' => $redirect->id, 'errors' => print_r($redirect->getErrors(), true) ]
                 ),
                 __METHOD__
             );
@@ -767,32 +767,32 @@ 
         // Get the validated model attributes and save them to the db
         $redirectConfig = $redirect->getAttributes();
         // 0 for a siteId needs to be converted to null
-        if (empty($redirectConfig['siteId']) || (int)$redirectConfig['siteId'] === 0) {
-            $redirectConfig['siteId'] = null;
+        if (empty($redirectConfig[ 'siteId' ]) || (int) $redirectConfig[ 'siteId' ] === 0) {
+            $redirectConfig[ 'siteId' ] = null;
         }
         // Throw an event to before saving the redirect
         $db = Craft::$app->getDb();
         // See if a redirect exists with this source URL already
-        if ((int)$redirectConfig['id'] === 0) {
+        if ((int) $redirectConfig[ 'id' ] === 0) {
             // Query the db table
             $redirect = (new Query())
-                ->from(['{{%retour_static_redirects}}'])
-                ->where(['redirectSrcUrlParsed' => $redirectConfig['redirectSrcUrlParsed']])
-                ->andWhere(['siteId' => $redirectConfig['siteId']])
+                ->from([ '{{%retour_static_redirects}}' ])
+                ->where([ 'redirectSrcUrlParsed' => $redirectConfig[ 'redirectSrcUrlParsed' ] ])
+                ->andWhere([ 'siteId' => $redirectConfig[ 'siteId' ] ])
                 ->one();
             // If it exists, update it rather than having duplicates
             if (!empty($redirect)) {
-                $redirectConfig['id'] = $redirect['id'];
+                $redirectConfig[ 'id' ] = $redirect[ 'id' ];
             }
         }
         // Trigger a 'beforeSaveRedirect' event
-        $isNew = (int)$redirectConfig['id'] === 0;
+        $isNew = (int) $redirectConfig[ 'id' ] === 0;
         $event = new RedirectEvent([
             'isNew' => $isNew,
-            'legacyUrl' => $redirectConfig['redirectSrcUrlParsed'],
-            'destinationUrl' => $redirectConfig['redirectDestUrl'],
-            'matchType' => $redirectConfig['redirectSrcMatch'],
-            'redirectType' => $redirectConfig['redirectHttpCode'],
+            'legacyUrl' => $redirectConfig[ 'redirectSrcUrlParsed' ],
+            'destinationUrl' => $redirectConfig[ 'redirectDestUrl' ],
+            'matchType' => $redirectConfig[ 'redirectSrcMatch' ],
+            'redirectType' => $redirectConfig[ 'redirectHttpCode' ],
         ]);
         $this->trigger(self::EVENT_BEFORE_SAVE_REDIRECT, $event);
         if (!$event->isValid) {
@@ -804,7 +804,7 @@ 
                 Craft::t(
                     'retour',
                     'Updating existing redirect: {redirect}',
-                    ['redirect' => print_r($redirectConfig, true)]
+                    [ 'redirect' => print_r($redirectConfig, true) ]
                 ),
                 __METHOD__
             );
@@ -814,7 +814,7 @@ 
                     '{{%retour_static_redirects}}',
                     $redirectConfig,
                     [
-                        'id' => $redirectConfig['id'],
+                        'id' => $redirectConfig[ 'id' ],
                     ]
                 )->execute();
             } catch (Exception $e) {
@@ -825,11 +825,11 @@ 
                 Craft::t(
                     'retour',
                     'Creating new redirect: {redirect}',
-                    ['redirect' => print_r($redirectConfig, true)]
+                    [ 'redirect' => print_r($redirectConfig, true) ]
                 ),
                 __METHOD__
             );
-            unset($redirectConfig['id']);
+            unset($redirectConfig[ 'id' ]);
             // Create a new record
             try {
                 $db->createCommand()->insert(
@@ -842,15 +842,15 @@ 
         }
         // To prevent redirect loops, see if any static redirects have our redirectDestUrl as their redirectSrcUrl
         $testRedirectConfig = $this->getRedirectByRedirectSrcUrl(
-            $redirectConfig['redirectDestUrl'],
-            $redirectConfig['siteId']
+            $redirectConfig[ 'redirectDestUrl' ],
+            $redirectConfig[ 'siteId' ]
         );
         if ($testRedirectConfig !== null) {
             Craft::debug(
                 Craft::t(
                     'retour',
                     'Deleting redirect to prevent a loop: {redirect}',
-                    ['redirect' => print_r($testRedirectConfig, true)]
+                    [ 'redirect' => print_r($testRedirectConfig, true) ]
                 ),
                 __METHOD__
             );
@@ -858,7 +858,7 @@ 
             try {
                 $db->createCommand()->delete(
                     '{{%retour_static_redirects}}',
-                    ['id' => $testRedirectConfig['id']]
+                    [ 'id' => $testRedirectConfig[ 'id' ] ]
                 )->execute();
             } catch (Exception $e) {
                 Craft::error($e->getMessage(), __METHOD__);
@@ -891,17 +891,17 @@ 
      */
     public function excludeUri($uri): bool
     {
-        $uri = '/'.ltrim($uri, '/');
+        $uri = '/' . ltrim($uri, '/');
         if (!empty(Retour::$settings->excludePatterns)) {
             foreach (Retour::$settings->excludePatterns as $excludePattern) {
-                $pattern = '`'.$excludePattern['pattern'].'`i';
+                $pattern = '`' . $excludePattern[ 'pattern' ] . '`i';
                 try {
                     if (preg_match($pattern, $uri) === 1) {
                         return true;
                     }
                 } catch (\Exception $e) {
                     // That's fine
-                    Craft::error('Invalid exclude URI Regex: '.$pattern, __METHOD__);
+                    Craft::error('Invalid exclude URI Regex: ' . $pattern, __METHOD__);
                 }
             }
         }