nystudio107 / craft-retour

src/controllers/StatisticsController.php

Spacing +16 added lines, -16 removed lines

@@ -40,7 +40,7 @@ 
     // Protected Properties
     // =========================================================================
 
-    protected $allowAnonymous = [];
+    protected $allowAnonymous = [ ];
 
     // Public Methods
     // =========================================================================
@@ -56,7 +56,7 @@ 
      */
     public function actionDashboard(string $siteHandle = null, bool $showWelcome = false): Response
     {
-        $variables = [];
+        $variables = [ ];
         PermissionHelper::controllerPermissionCheck('retour:dashboard');
         // Trim the statistics
         Retour::$plugin->statistics->trimStatistics();
@@ -71,34 +71,34 @@ 
         } catch (InvalidConfigException $e) {
             Craft::error($e->getMessage(), __METHOD__);
         }
-        $variables['baseAssetsUrl'] = Craft::$app->assetManager->getPublishedUrl(
+        $variables[ 'baseAssetsUrl' ] = Craft::$app->assetManager->getPublishedUrl(
             '@nystudio107/retour/assetbundles/retour/dist',
             true
         );
         // Enabled sites
         MultiSiteHelper::setMultiSiteVariables($siteHandle, $siteId, $variables);
-        $variables['controllerHandle'] = 'dashboard';
+        $variables[ 'controllerHandle' ] = 'dashboard';
 
         // Basic variables
-        $variables['fullPageForm'] = false;
-        $variables['docsUrl'] = self::DOCUMENTATION_URL;
-        $variables['pluginName'] = $pluginName;
-        $variables['title'] = $templateTitle;
-        $siteHandleUri = Craft::$app->isMultiSite ? '/'.$siteHandle : '';
-        $variables['crumbs'] = [
+        $variables[ 'fullPageForm' ] = false;
+        $variables[ 'docsUrl' ] = self::DOCUMENTATION_URL;
+        $variables[ 'pluginName' ] = $pluginName;
+        $variables[ 'title' ] = $templateTitle;
+        $siteHandleUri = Craft::$app->isMultiSite ? '/' . $siteHandle : '';
+        $variables[ 'crumbs' ] = [
             [
                 'label' => $pluginName,
                 'url' => UrlHelper::cpUrl('retour'),
             ],
             [
                 'label' => $templateTitle,
-                'url' => UrlHelper::cpUrl('retour/dashboard'.$siteHandleUri),
+                'url' => UrlHelper::cpUrl('retour/dashboard' . $siteHandleUri),
             ],
         ];
-        $variables['docTitle'] = "{$pluginName} - {$templateTitle}";
-        $variables['selectedSubnavItem'] = 'dashboard';
-        $variables['showWelcome'] = $showWelcome;
-        $variables['settings'] = Retour::$settings;
+        $variables[ 'docTitle' ] = "{$pluginName} - {$templateTitle}";
+        $variables[ 'selectedSubnavItem' ] = 'dashboard';
+        $variables[ 'showWelcome' ] = $showWelcome;
+        $variables[ 'settings' ] = Retour::$settings;
 
         // Render the template
         return $this->renderTemplate('retour/dashboard/index', $variables);
@@ -116,7 +116,7 @@ 
             Craft::t(
                 'retour',
                 'Retour statistics cleared: {error}',
-                ['error' => $error]
+                [ 'error' => $error ]
             ),
             __METHOD__
         );

src/services/Redirects.php

Spacing +61 added lines, -61 removed lines

@@ -128,7 +128,7 @@ 
                 Craft::t(
                     'retour',
                     '404 full URL: {fullUrl}, 404 path only: {pathOnly}',
-                    ['fullUrl' => $fullUrl, 'pathOnly' => $pathOnly]
+                    [ 'fullUrl' => $fullUrl, 'pathOnly' => $pathOnly ]
                 ),
                 __METHOD__
             );
@@ -162,7 +162,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;
@@ -174,11 +174,11 @@ 
                     $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 {
-                    $dest = UrlHelper::siteUrl($dest, null, null, $redirect['siteId'] ?? null);
+                    $dest = UrlHelper::siteUrl($dest, null, null, $redirect[ 'siteId' ] ?? null);
                 } catch (\yii\base\Exception $e) {
                 }
             }
@@ -188,12 +188,12 @@ 
                     $dest .= '?' . $request->getQueryStringWithoutPath();
                 }
             }
-            $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__
             );
@@ -273,13 +273,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__
         );
@@ -301,12 +301,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);
@@ -314,7 +314,7 @@ 
             Craft::t(
                 'retour',
                 'Cached redirect saved for {url}',
-                ['url' => $url]
+                [ 'url' => $url ]
             ),
             __METHOD__
         );
@@ -332,8 +332,8 @@ 
         $result = null;
         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':
@@ -346,11 +346,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);
 
@@ -360,14 +360,14 @@ 
 
                     // Do a regex match
                     case 'regexmatch':
-                        $matchRegEx = '`'.$redirect['redirectSrcUrlParsed'].'`i';
+                        $matchRegEx = '`' . $redirect[ 'redirectSrcUrlParsed' ] . '`i';
                         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
                                 );
                             }
@@ -386,7 +386,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);
@@ -402,7 +402,7 @@ 
             Craft::t(
                 'retour',
                 'Not handled-> full URL: {fullUrl}, path only: {pathOnly}',
-                ['fullUrl' => $fullUrl, 'pathOnly' => $pathOnly]
+                [ 'fullUrl' => $fullUrl, 'pathOnly' => $pathOnly ]
             ),
             __METHOD__
         );
@@ -426,7 +426,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');
             }
         }
 
@@ -447,12 +447,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);
@@ -475,8 +475,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;
@@ -494,16 +494,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();
 
@@ -545,13 +545,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__
             );
@@ -560,14 +560,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__);
             }
@@ -586,7 +586,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__
             );
@@ -596,32 +596,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) {
@@ -633,7 +633,7 @@ 
                 Craft::t(
                     'retour',
                     'Updating existing redirect: {redirect}',
-                    ['redirect' => print_r($redirectConfig, true)]
+                    [ 'redirect' => print_r($redirectConfig, true) ]
                 ),
                 __METHOD__
             );
@@ -643,7 +643,7 @@ 
                     '{{%retour_static_redirects}}',
                     $redirectConfig,
                     [
-                        'id' => $redirectConfig['id'],
+                        'id' => $redirectConfig[ 'id' ],
                     ]
                 )->execute();
             } catch (Exception $e) {
@@ -654,11 +654,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(
@@ -671,15 +671,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__
             );
@@ -687,7 +687,7 @@ 
             try {
                 $db->createCommand()->delete(
                     '{{%retour_static_redirects}}',
-                    ['id' => $testRedirectConfig['id']]
+                    [ 'id' => $testRedirectConfig[ 'id' ] ]
                 )->execute();
             } catch (Exception $e) {
                 Craft::error($e->getMessage(), __METHOD__);
@@ -720,10 +720,10 @@ 
      */
     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';
                 if (preg_match($pattern, $uri) === 1) {
                     return true;
                 }

src/config.php

Indentation +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
     // The number of milliseconds required between trimming of statistics
     'statisticsRateLimitMs' => 3600000,
 
-     // [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/Statistics.php

Spacing +18 added lines, -18 removed lines

@@ -60,7 +60,7 @@ 
         }
         // Query the db table
         $stats = (new Query())
-            ->from(['{{%retour_stats}}'])
+            ->from([ '{{%retour_stats}}' ])
             ->orderBy('hitCount DESC')
             ->limit(Retour::$settings->statsDisplayLimit)
             ->all();
@@ -79,13 +79,13 @@ 
     public function getRecentStatistics($days = 1, $handled = false): array
     {
         // Ensure is an int
-        $handledInt = (int)$handled;
-        $stats = [];
+        $handledInt = (int) $handled;
+        $stats = [ ];
         $db = Craft::$app->getDb();
         if ($db->getIsMysql()) {
             // Query the db table
             $stats = (new Query())
-                ->from(['{{%retour_stats}}'])
+                ->from([ '{{%retour_stats}}' ])
                 ->where("hitLastTime >= ( CURDATE() - INTERVAL '{$days}' DAY )")
                 ->andWhere("handledByRetour = {$handledInt}")
                 ->orderBy('hitLastTime DESC')
@@ -94,9 +94,9 @@ 
         if ($db->getIsPgsql()) {
             // Query the db table
             $stats = (new Query())
-                ->from(['{{%retour_stats}}'])
+                ->from([ '{{%retour_stats}}' ])
                 ->where("\"hitLastTime\" >= ( CURRENT_TIMESTAMP - INTERVAL '{$days} days' )")
-                ->andWhere(['handledByRetour' => $handledInt])
+                ->andWhere([ 'handledByRetour' => $handledInt ])
                 ->orderBy('hitLastTime DESC')
                 ->all();
         }
@@ -163,16 +163,16 @@ 
         $stats->validate();
         // Find any existing retour_stats record
         $statsConfig = (new Query())
-            ->from(['{{%retour_stats}}'])
-            ->where(['redirectSrcUrl' => $stats->redirectSrcUrl])
+            ->from([ '{{%retour_stats}}' ])
+            ->where([ 'redirectSrcUrl' => $stats->redirectSrcUrl ])
             ->one();
         // If no record is found, initialize some values
         if ($statsConfig === null) {
             $stats->id = 0;
             $stats->hitCount = 0;
         } else {
-            $stats->id = $statsConfig['id'];
-            $stats->hitCount = $statsConfig['hitCount'];
+            $stats->id = $statsConfig[ 'id' ];
+            $stats->hitCount = $statsConfig[ 'hitCount' ];
         }
         // Merge in the updated info
         $stats->siteId = $siteId;
@@ -181,9 +181,9 @@ 
         $stats->userAgent = $userAgent;
         $stats->exceptionMessage = $exceptionMessage;
         $stats->exceptionFilePath = $exceptionFilePath;
-        $stats->exceptionFileLine = (int)$exceptionFileLine;
+        $stats->exceptionFileLine = (int) $exceptionFileLine;
         $stats->hitLastTime = Db::prepareDateForDb(new \DateTime());
-        $stats->handledByRetour = (int)$handled;
+        $stats->handledByRetour = (int) $handled;
         $stats->hitCount++;
         $statsConfig = $stats->getAttributes();
         // Record the updated statistics
@@ -253,7 +253,7 @@ 
                 Craft::t(
                     'retour',
                     'Trimmed {rows} from retour_stats table',
-                    ['rows' => $affectedRows]
+                    [ 'rows' => $affectedRows ]
                 ),
                 __METHOD__
             );
@@ -274,7 +274,7 @@ 
                 Craft::t(
                     'retour',
                     'Error validating statistics {id}: {errors}',
-                    ['id' => $stats->id, 'errors' => print_r($stats->getErrors(), true)]
+                    [ 'id' => $stats->id, 'errors' => print_r($stats->getErrors(), true) ]
                 ),
                 __METHOD__
             );
@@ -284,14 +284,14 @@ 
         // Get the validated model attributes and save them to the db
         $statsConfig = $stats->getAttributes();
         $db = Craft::$app->getDb();
-        if ($statsConfig['id'] !== 0) {
+        if ($statsConfig[ 'id' ] !== 0) {
             // Update the existing record
             try {
                 $result = $db->createCommand()->update(
                     '{{%retour_stats}}',
                     $statsConfig,
                     [
-                        'id' => $statsConfig['id'],
+                        'id' => $statsConfig[ 'id' ],
                     ]
                 )->execute();
             } catch (Exception $e) {
@@ -300,7 +300,7 @@ 
                 // Craft::error($e->getMessage(), __METHOD__);
             }
         } else {
-            unset($statsConfig['id']);
+            unset($statsConfig[ 'id' ]);
             // Create a new record
             try {
                 $db->createCommand()->insert(
@@ -327,7 +327,7 @@ 
         $now = round(microtime(true) * 1000);
         $cache = Craft::$app->getCache();
         $then = $cache->get(self::LAST_STATISTICS_TRIM_CACHE_KEY);
-        if (($then !== false) && ($now - (int)$then < Retour::$settings->statisticsRateLimitMs)) {
+        if (($then !== false) && ($now - (int) $then < Retour::$settings->statisticsRateLimitMs)) {
             $limited = true;
         }
         $cache->set(self::LAST_STATISTICS_TRIM_CACHE_KEY, $now, 0);