nystudio107 / craft-retour

src/controllers/RedirectsController.php

Spacing +26 added lines, -26 removed lines

@@ -41,7 +41,7 @@ 
     // Protected Properties
     // =========================================================================
 
-    protected $allowAnonymous = [];
+    protected $allowAnonymous = [ ];
 
     // Public Methods
     // =========================================================================
@@ -57,7 +57,7 @@ 
      */
     public function actionRedirects(string $siteHandle = null): Response
     {
-        $variables = [];
+        $variables = [ ];
         PermissionHelper::controllerPermissionCheck('retour:redirects');
         // Get the site to edit
         $siteId = MultiSiteHelper::getSiteIdFromHandle($siteHandle);
@@ -70,20 +70,20 @@ 
         } 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'] = 'redirects';
+        $variables[ 'controllerHandle' ] = 'redirects';
 
         // Basic variables
-        $variables['fullPageForm'] = false;
-        $variables['docsUrl'] = self::DOCUMENTATION_URL;
-        $variables['pluginName'] = $pluginName;
-        $variables['title'] = $templateTitle;
-        $variables['crumbs'] = [
+        $variables[ 'fullPageForm' ] = false;
+        $variables[ 'docsUrl' ] = self::DOCUMENTATION_URL;
+        $variables[ 'pluginName' ] = $pluginName;
+        $variables[ 'title' ] = $templateTitle;
+        $variables[ 'crumbs' ] = [
             [
                 'label' => $pluginName,
                 'url' => UrlHelper::cpUrl('retour'),
@@ -93,8 +93,8 @@ 
                 'url' => UrlHelper::cpUrl('retour/redirects'),
             ],
         ];
-        $variables['docTitle'] = "{$pluginName} - {$templateTitle}";
-        $variables['selectedSubnavItem'] = 'redirects';
+        $variables[ 'docTitle' ] = "{$pluginName} - {$templateTitle}";
+        $variables[ 'selectedSubnavItem' ] = 'redirects';
 
         // Render the template
         return $this->renderTemplate('retour/redirects/index', $variables);
@@ -118,7 +118,7 @@ 
         string $siteHandle = null,
         StaticRedirectsModel $redirect = null
     ): Response {
-        $variables = [];
+        $variables = [ ];
         PermissionHelper::controllerPermissionCheck('retour:redirects');
         // Load in the redirect
         if ($redirectId === 0) {
@@ -130,12 +130,12 @@ 
         if ($redirect === null) {
             $redirectConfig = Retour::$plugin->redirects->getRedirectById($redirectId);
             if ($redirectConfig === null) {
-                $redirectConfig = [];
+                $redirectConfig = [ ];
                 Craft::error(
                     Craft::t(
                         'retour',
                         "Couldn't load redirect id {id}",
-                        ['id' => $redirectId]
+                        [ 'id' => $redirectId ]
                     ),
                     __METHOD__
                 );
@@ -154,20 +154,20 @@ 
         } 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
         );
         // Sites menu
         MultiSiteHelper::setSitesMenuVariables($variables);
-        $variables['controllerHandle'] = 'redirects';
+        $variables[ 'controllerHandle' ] = 'redirects';
 
         // Basic variables
-        $variables['fullPageForm'] = true;
-        $variables['docsUrl'] = self::DOCUMENTATION_URL;
-        $variables['pluginName'] = $pluginName;
-        $variables['title'] = $templateTitle;
-        $variables['crumbs'] = [
+        $variables[ 'fullPageForm' ] = true;
+        $variables[ 'docsUrl' ] = self::DOCUMENTATION_URL;
+        $variables[ 'pluginName' ] = $pluginName;
+        $variables[ 'title' ] = $templateTitle;
+        $variables[ 'crumbs' ] = [
             [
                 'label' => $pluginName,
                 'url' => UrlHelper::cpUrl('retour'),
@@ -178,12 +178,12 @@ 
             ],
             [
                 'label' => $templateTitle,
-                'url' => UrlHelper::cpUrl('retour/edit-redirect/'.$redirectId),
+                'url' => UrlHelper::cpUrl('retour/edit-redirect/' . $redirectId),
             ],
         ];
-        $variables['docTitle'] = "{$pluginName} - Redirects - {$templateTitle}";
-        $variables['selectedSubnavItem'] = 'redirects';
-        $variables['redirect'] = $redirect;
+        $variables[ 'docTitle' ] = "{$pluginName} - Redirects - {$templateTitle}";
+        $variables[ 'selectedSubnavItem' ] = 'redirects';
+        $variables[ 'redirect' ] = $redirect;
 
         // Render the template
         return $this->renderTemplate('retour/redirects/_edit', $variables);
@@ -229,7 +229,7 @@ 
         if ($redirectConfig === null) {
             throw new NotFoundHttpException('Redirect not found');
         }
-        $redirectConfig['id'] = (int)$redirectConfig['id'];
+        $redirectConfig[ 'id' ] = (int) $redirectConfig[ 'id' ];
         $redirect = new StaticRedirectsModel($redirectConfig);
         // Make sure the redirect validates
         if (!$redirect->validate()) {

src/helpers/MultiSite.php

Spacing +24 added lines, -24 removed lines

@@ -36,7 +36,7 @@ 
     public static function setSitesMenuVariables(array &$variables)
     {
         // Set defaults based on the section settings
-        $variables['sitesMenu'] = [
+        $variables[ 'sitesMenu' ] = [
             0 => Craft::t(
                 'retour',
                 'All Sites'
@@ -49,10 +49,10 @@ 
             /** @var Site $site */
             foreach ($sites->getAllGroups() as $group) {
                 $groupSites = $sites->getSitesByGroupId($group->id);
-                $variables['sitesMenu'][$group->name]
-                    = ['optgroup' => $group->name];
+                $variables[ 'sitesMenu' ][ $group->name ]
+                    = [ 'optgroup' => $group->name ];
                 foreach ($groupSites as $groupSite) {
-                    $variables['sitesMenu'][$groupSite->id] = $groupSite->name;
+                    $variables[ 'sitesMenu' ][ $groupSite->id ] = $groupSite->name;
                 }
             }
         }
@@ -71,53 +71,53 @@ 
         $sites = Craft::$app->getSites();
         if (Craft::$app->getIsMultiSite()) {
             // Set defaults based on the section settings
-            $variables['enabledSiteIds'] = [];
-            $variables['siteIds'] = [];
+            $variables[ 'enabledSiteIds' ] = [ ];
+            $variables[ 'siteIds' ] = [ ];
 
             /** @var Site $site */
             foreach ($sites->getEditableSiteIds() as $editableSiteId) {
-                $variables['enabledSiteIds'][] = $editableSiteId;
-                $variables['siteIds'][] = $editableSiteId;
+                $variables[ 'enabledSiteIds' ][ ] = $editableSiteId;
+                $variables[ 'siteIds' ][ ] = $editableSiteId;
             }
 
             // Make sure the $siteId they are trying to edit is in our array of editable sites
-            if (!\in_array($siteId, $variables['enabledSiteIds'], false)) {
-                if (!empty($variables['enabledSiteIds'])) {
+            if (!\in_array($siteId, $variables[ 'enabledSiteIds' ], false)) {
+                if (!empty($variables[ 'enabledSiteIds' ])) {
                     if ($siteId !== 0) {
-                        $siteId = reset($variables['enabledSiteIds']);
+                        $siteId = reset($variables[ 'enabledSiteIds' ]);
                     }
                 } else {
-                    self::requirePermission('editSite:'.$siteId);
+                    self::requirePermission('editSite:' . $siteId);
                 }
             }
         }
         // Set the currentSiteId and currentSiteHandle
-        $variables['currentSiteId'] = empty($siteId) ? 0 : $siteId;
-        $variables['currentSiteHandle'] = empty($siteHandle)
+        $variables[ 'currentSiteId' ] = empty($siteId) ? 0 : $siteId;
+        $variables[ 'currentSiteHandle' ] = empty($siteHandle)
             ? Craft::$app->getSites()->currentSite->handle
             : $siteHandle;
 
         // Page title
-        $variables['showSites'] = (
+        $variables[ 'showSites' ] = (
             Craft::$app->getIsMultiSite() &&
-            \count($variables['enabledSiteIds'])
+            \count($variables[ 'enabledSiteIds' ])
         );
 
-        if ($variables['showSites']) {
-            if ($variables['currentSiteId'] === 0) {
-                $variables['sitesMenuLabel'] = Craft::t(
+        if ($variables[ 'showSites' ]) {
+            if ($variables[ 'currentSiteId' ] === 0) {
+                $variables[ 'sitesMenuLabel' ] = Craft::t(
                     'retour',
                     'All Sites'
                 );
             } else {
-                $variables['sitesMenuLabel'] = Craft::t(
+                $variables[ 'sitesMenuLabel' ] = Craft::t(
                     'site',
-                    $sites->getSiteById((int)$variables['currentSiteId'])->name
+                    $sites->getSiteById((int) $variables[ 'currentSiteId' ])->name
                 );
             }
         } else {
-            $variables['currentSiteId'] = 0;
-            $variables['sitesMenuLabel'] = '';
+            $variables[ 'currentSiteId' ] = 0;
+            $variables[ 'sitesMenuLabel' ] = '';
         }
     }
 
@@ -135,7 +135,7 @@ 
         if ($siteHandle !== null) {
             $site = Craft::$app->getSites()->getSiteByHandle($siteHandle);
             if (!$site) {
-                throw new NotFoundHttpException('Invalid site handle: '.$siteHandle);
+                throw new NotFoundHttpException('Invalid site handle: ' . $siteHandle);
             }
             $siteId = $site->id;
         } else {

src/services/Redirects.php

Spacing +48 added lines, -48 removed lines

@@ -92,7 +92,7 @@ 
                 Craft::t(
                     'retour',
                     '404 full URL: {fullUrl}, 404 path only: {pathOnly}',
-                    ['fullUrl' => $fullUrl, 'pathOnly' => $pathOnly]
+                    [ 'fullUrl' => $fullUrl, 'pathOnly' => $pathOnly ]
                 ),
                 __METHOD__
             );
@@ -124,7 +124,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;
@@ -136,17 +136,17 @@ 
                     $url = $pathOnly;
                     break;
             }
-            $dest = $redirect['redirectDestUrl'];
+            $dest = $redirect[ 'redirectDestUrl' ];
             if (Retour::$settings->preserveQueryString) {
                 $request = Craft::$app->getRequest();
                 $dest .= '?' . $request->getQueryString();
             }
-            $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__
             );
@@ -221,13 +221,13 @@ 
     public function getRedirectFromCache($url)
     {
         $cache = Craft::$app->getCache();
-        $cacheKey = $this::CACHE_KEY.md5($url);
+        $cacheKey = $this::CACHE_KEY . md5($url);
         $redirect = $cache->get($cacheKey);
         Craft::info(
             Craft::t(
                 'retour',
                 'Cached redirect hit for {url}',
-                ['url' => $url]
+                [ 'url' => $url ]
             ),
             __METHOD__
         );
@@ -241,7 +241,7 @@ 
      */
     public function saveRedirectToCache($url, $redirect)
     {
-        $cacheKey = $this::CACHE_KEY.md5($url);
+        $cacheKey = $this::CACHE_KEY . md5($url);
         $cache = Craft::$app->getCache();
         // Get the current site id
         $sites = Craft::$app->getSites();
@@ -254,7 +254,7 @@ 
         $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);
@@ -262,7 +262,7 @@ 
             Craft::t(
                 'retour',
                 'Cached redirect saved for {url}',
-                ['url' => $url]
+                [ 'url' => $url ]
             ),
             __METHOD__
         );
@@ -280,8 +280,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':
@@ -294,11 +294,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);
 
@@ -308,14 +308,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
                                 );
                             }
@@ -334,7 +334,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);
@@ -350,7 +350,7 @@ 
             Craft::t(
                 'retour',
                 'Not handled-> full URL: {fullUrl}, path only: {pathOnly}',
-                ['fullUrl' => $fullUrl, 'pathOnly' => $pathOnly]
+                [ 'fullUrl' => $fullUrl, 'pathOnly' => $pathOnly ]
             ),
             __METHOD__
         );
@@ -374,7 +374,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');
             }
         }
 
@@ -394,7 +394,7 @@ 
         }
         // Query the db table
         $query = (new Query())
-            ->from(['{{%retour_static_redirects}}'])
+            ->from([ '{{%retour_static_redirects}}' ])
             ->orderBy('redirectMatchType ASC, redirectSrcMatch ASC, hitCount DESC');
         if ($limit) {
             $query->limit($limit);
@@ -417,8 +417,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;
@@ -435,8 +435,8 @@ 
     {
         // Query the db table
         $redirect = (new Query())
-            ->from(['{{%retour_static_redirects}}'])
-            ->where(['redirectSrcUrl' => $redirectSrcUrl])
+            ->from([ '{{%retour_static_redirects}}' ])
+            ->where([ 'redirectSrcUrl' => $redirectSrcUrl ])
             ->one();
 
         return $redirect;
@@ -477,13 +477,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__
             );
@@ -492,14 +492,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__);
             }
@@ -518,7 +518,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__
             );
@@ -528,28 +528,28 @@ 
         // 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']) || $redirectConfig['siteId'] == 0) {
-            $redirectConfig['siteId'] = null;
+        if (empty($redirectConfig[ 'siteId' ]) || $redirectConfig[ 'siteId' ] == 0) {
+            $redirectConfig[ 'siteId' ] = null;
         }
         $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']])
+                ->from([ '{{%retour_static_redirects}}' ])
+                ->where([ 'redirectSrcUrlParsed' => $redirectConfig[ 'redirectSrcUrlParsed' ] ])
                 ->one();
             // If it exists, update it rather than having duplicates
             if (!empty($redirect)) {
-                $redirectConfig['id'] = $redirect['id'];
+                $redirectConfig[ 'id' ] = $redirect[ 'id' ];
             }
         }
-        if ((int)$redirectConfig['id'] !== 0) {
+        if ((int) $redirectConfig[ 'id' ] !== 0) {
             Craft::debug(
                 Craft::t(
                     'retour',
                     'Updating existing redirect: {redirect}',
-                    ['redirect' => print_r($redirectConfig, true)]
+                    [ 'redirect' => print_r($redirectConfig, true) ]
                 ),
                 __METHOD__
             );
@@ -559,7 +559,7 @@ 
                     '{{%retour_static_redirects}}',
                     $redirectConfig,
                     [
-                        'id' => $redirectConfig['id'],
+                        'id' => $redirectConfig[ 'id' ],
                     ]
                 )->execute();
             } catch (Exception $e) {
@@ -570,11 +570,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(
@@ -586,13 +586,13 @@ 
             }
         }
         // To prevent redirect loops, see if any static redirects have our redirectDestUrl as their redirectSrcUrl
-        $testRedirectConfig = $this->getRedirectByRedirectSrcUrl($redirectConfig['redirectDestUrl']);
+        $testRedirectConfig = $this->getRedirectByRedirectSrcUrl($redirectConfig[ 'redirectDestUrl' ]);
         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__
             );
@@ -600,7 +600,7 @@ 
             try {
                 $db->createCommand()->delete(
                     '{{%retour_static_redirects}}',
-                    ['id' => $testRedirectConfig['id']]
+                    [ 'id' => $testRedirectConfig[ 'id' ] ]
                 )->execute();
             } catch (Exception $e) {
                 Craft::error($e->getMessage(), __METHOD__);