Code quality clean up (octobercms#4449)

Credit to @bennothommo

.github/CONTRIBUTING.md

@@ -69,10 +69,12 @@ Please ensure that your Pull Request satisfies the following coding standards:
 - [PSR 1 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md)
 - [PSR 0 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md)
 
+To validate your changes against our coding standards, you may run `./vendor/bin/phpcs -nq --extensions="php"` in your development folder.
+
 #### Team rules
 
 The October team follows the [developer guidelines](https://octobercms.com/docs/help/developer-guide) as much as possible.
 
 #### Escalation process
 
-We do our best to attend to all reported issues. If you have an important issue that requires attention, consider submitting a bounty using the [OctoberCMS Bounty Program](https://www.bountysource.com/teams/october).
+We do our best to attend to all reported issues. If you have an important issue that requires attention, consider submitting a bounty using the [OctoberCMS Bounty Program](https://www.bountysource.com/teams/october).

config/app.php

@@ -56,7 +56,7 @@
     | -------- STOP! --------
     | Before you change this value, consider carefully if that is actually
     | what you want to do. It is HIGHLY recommended that this is always set
-    | to UTC (as your server & DB timezone should be as well) and instead you 
+    | to UTC (as your server & DB timezone should be as well) and instead you
     | use cms.backendTimezone to set the default timezone used in the backend
     | to display dates & times.
     |

config/cms.php

@@ -425,14 +425,14 @@
     | this feature on can create a conflict if you have a frontend Service
     | Worker running. The 'scope' needs to be correctly set and not have a
     | duplicate subfolder structure on the frontend, otherwise it will run
-    | on both the frontend and backend of your website.	
+    | on both the frontend and backend of your website.
     |
     | true  - allow service workers to run in the backend
     |
     | false - disallow service workers to run in the backend
     |
     */
 
-    'enableBackendServiceWorkers' => false,	
+    'enableBackendServiceWorkers' => false,
 
 ];

modules/backend/behaviors/FormController.php

@@ -159,7 +159,9 @@ public function initForm($model, $context = null)
 
         $this->formWidget->bindEvent('form.beforeRefresh', function ($holder) {
             $result = $this->controller->formExtendRefreshData($this->formWidget, $holder->data);
-            if (is_array($result)) $holder->data = $result;
+            if (is_array($result)) {
+                $holder->data = $result;
+            }
         });
 
         $this->formWidget->bindEvent('form.refreshFields', function ($fields) {

modules/backend/behaviors/RelationController.php

@@ -886,7 +886,6 @@ protected function makeManageWidget()
          * Form
          */
         elseif ($this->manageMode == 'form') {
-
             if (!$config = $this->makeConfigForMode('manage', 'form', false)) {
                 return null;
             }
@@ -1205,7 +1204,6 @@ public function onRelationManageAdd()
          * Add
          */
         if ($this->viewMode == 'multi') {
-
             $checkedIds = $recordId ? [$recordId] : post('checked');
 
             if (is_array($checkedIds)) {
@@ -1221,14 +1219,12 @@ public function onRelationManageAdd()
                     $this->relationObject->add($model, $sessionKey);
                 }
             }
-
         }
         /*
          * Link
          */
         elseif ($this->viewMode == 'single') {
             if ($recordId && ($model = $this->relationModel->find($recordId))) {
-
                 $this->relationObject->add($model, $sessionKey);
                 $this->viewWidget->setFormValues($model->attributes);
 
@@ -1242,7 +1238,6 @@ public function onRelationManageAdd()
                         $parentModel->save();
                     }
                 }
-
             }
         }
 
@@ -1264,7 +1259,6 @@ public function onRelationManageRemove()
          * Remove
          */
         if ($this->viewMode == 'multi') {
-
             $checkedIds = $recordId ? [$recordId] : post('checked');
 
             if (is_array($checkedIds)) {
@@ -1707,7 +1701,8 @@ protected function makeConfigForMode($mode = 'view', $type = 'list', $throwExcep
      *
      * @return \Backend\Classes\WidgetBase
      */
-    public function relationGetManageWidget() {
+    public function relationGetManageWidget()
+    {
         return $this->manageWidget;
     }
 
@@ -1716,7 +1711,8 @@ public function relationGetManageWidget() {
      *
      * @return \Backend\Classes\WidgetBase
      */
-    public function relationGetViewWidget() {
+    public function relationGetViewWidget()
+    {
         return $this->viewWidget;
     }
-}
+}

modules/backend/classes/Controller.php

@@ -231,7 +231,6 @@ public function run($action = null, $params = [])
          * Check that user is logged in and has permission to view this page
          */
         if (!$isPublicAction) {
-
             /*
              * Not logged in, redirect to login screen or show ajax error.
              */

modules/backend/classes/FormField.php

@@ -688,7 +688,6 @@ protected function getFieldNameFromData($fieldName, $data, $default = null)
          * relation value, all others will look up the relation object as normal.
          */
         foreach ($keyParts as $key) {
-
             if ($result instanceof Model && $result->hasRelation($key)) {
                 if ($key == $lastField) {
                     $result = $result->getRelationValue($key) ?: $default;
@@ -709,7 +708,6 @@ protected function getFieldNameFromData($fieldName, $data, $default = null)
                 }
                 $result = $result->{$key};
             }
-
         }
 
         return $result;

modules/backend/classes/FormTabs.php

@@ -31,12 +31,12 @@ class FormTabs implements IteratorAggregate, ArrayAccess
      * @var string Default tab label to use when none is specified.
      */
     public $defaultTab = 'backend::lang.form.undefined_tab';
-    
+
     /**
      * @var array List of icons for their corresponding tabs.
      */
     public $icons = [];
-    
+
     /**
      * @var bool Should these tabs stretch to the bottom of the page layout.
      */
@@ -86,11 +86,11 @@ protected function evalConfig($config)
         if (array_key_exists('defaultTab', $config)) {
             $this->defaultTab = $config['defaultTab'];
         }
-        
+
         if (array_key_exists('icons', $config)) {
             $this->icons = $config['icons'];
         }
-        
+
         if (array_key_exists('stretch', $config)) {
             $this->stretch = $config['stretch'];
         }
@@ -182,7 +182,7 @@ public function getAllFields()
 
         return $tablessFields;
     }
-    
+
     /**
      * Returns an icon for the tab based on the tab's name.
      * @param string $name
@@ -194,7 +194,7 @@ public function getIcon($name)
             return $this->icons[$name];
         }
     }
-    
+
     /**
      * Returns a tab pane CSS class.
      * @param string $index
@@ -222,9 +222,10 @@ public function getPaneCssClass($index = null, $label = null)
      */
     public function getIterator()
     {
-        return new ArrayIterator($this->suppressTabs
-            ? $this->getAllFields()
-            : $this->getFields()
+        return new ArrayIterator(
+            $this->suppressTabs
+                ? $this->getAllFields()
+                : $this->getFields()
         );
     }
 

modules/backend/classes/FormWidgetBase.php

@@ -149,5 +149,4 @@ public function getLoadValue()
 
         return $this->formField->getValueFromData($this->data ?: $this->model, $defaultValue);
     }
-
 }

modules/backend/classes/NavigationManager.php

@@ -124,7 +124,9 @@ protected function loadItems()
              */
             $orderCount = 0;
             foreach ($item->sideMenu as $sideMenuItem) {
-                if ($sideMenuItem->order !== -1) continue;
+                if ($sideMenuItem->order !== -1) {
+                    continue;
+                }
                 $sideMenuItem->order = ($orderCount += 100);
             }
 
@@ -530,4 +532,4 @@ protected function makeItemKey($owner, $code)
     {
         return strtoupper($owner).'.'.strtoupper($code);
     }
-}
+}

modules/backend/classes/WidgetManager.php

@@ -257,4 +257,4 @@ public function removeReportWidget($className)
 
         unset($this->reportWidgets[$className]);
     }
-}
+}

modules/backend/controllers/Files.php

@@ -30,7 +30,8 @@ public function get($code = null)
         try {
             return $this->findFileObject($code)->output('inline', true);
         }
-        catch (Exception $ex) {}
+        catch (Exception $ex) {
+        }
 
         return Response::make(View::make('backend::404'), 404);
     }
@@ -48,7 +49,8 @@ public function thumb($code = null, $width = 100, $height = 100, $mode = 'auto',
                 true
             );
         }
-        catch (Exception $ex) {}
+        catch (Exception $ex) {
+        }
 
         return Response::make(View::make('backend::404'), 404);
     }

modules/backend/controllers/UserRoles.php

@@ -51,7 +51,7 @@ public function __construct()
         /*
          * Only super users can access
          */
-        $this->bindEvent('page.beforeDisplay', function() {
+        $this->bindEvent('page.beforeDisplay', function () {
             if (!$this->user->isSuperUser()) {
                 return Response::make(View::make('backend::access_denied'), 403);
             }

modules/backend/database/migrations/2017_10_01_000010_Db_Backend_User_Roles.php

@@ -88,7 +88,8 @@ protected function migratePermissionsFromGroupsToRoles()
                     'permissions' => $group->permissions ?? null
                 ]);
             }
-            catch (Exception $ex) {}
+            catch (Exception $ex) {
+            }
 
             $permissions[$group->id] = $group->permissions ?? null;
         }
@@ -130,7 +131,8 @@ protected function migratePermissionsFromGroupsToRoles()
                     $perms = json_decode($permString, true);
                     $userPerms = array_merge($userPerms, $perms);
                 }
-                catch (Exception $ex) {}
+                catch (Exception $ex) {
+                }
             }
 
             if (count($userPerms) > 0) {
@@ -157,6 +159,7 @@ protected function splicePermissionsForUser($userId, $permissions)
                 'permissions' => json_encode($newPerms)
             ]);
         }
-        catch (Exception $ex) {}
+        catch (Exception $ex) {
+        }
     }
 }

modules/backend/formwidgets/CodeEditor.php

@@ -215,5 +215,4 @@ protected function applyEditorPreferences()
         $this->displayIndentGuides = $preferences->editor_display_indent_guides;
         $this->showPrintMargin = $preferences->editor_show_print_margin;
     }
-
 }

modules/backend/formwidgets/DataTable.php

@@ -192,5 +192,4 @@ public function getDataTableOptions($field, $data)
 
         return $result;
     }
-
 }

modules/backend/formwidgets/DatePicker.php

@@ -122,7 +122,7 @@ public function prepareVars()
             if ($this->mode === 'date' && !$this->ignoreTimezone) {
                 $backendTimeZone = \Backend\Models\Preference::get('timezone');
                 $value->setTimezone($backendTimeZone);
-                $value->setTime(0,0,0);
+                $value->setTime(0, 0, 0);
                 $value->setTimezone(Config::get('app.timezone'));
             }
             $value = $value->toDateTimeString();

modules/backend/formwidgets/NestedForm.php

@@ -35,7 +35,8 @@ class NestedForm extends FormWidgetBase
     /**
      * @inheritDoc
      */
-    public function init() {
+    public function init()
+    {
         $this->fillFromConfig([
             'form',
             'usePanelStyles',
@@ -62,13 +63,14 @@ protected function loadAssets()
     /**
      * @inheritdoc
      */
-    function render()
+    public function render()
     {
         $this->prepareVars();
         return $this->makePartial('nestedform');
     }
 
-    function prepareVars() {
+    public function prepareVars()
+    {
         $this->formWidget->previewMode = $this->previewMode;
     }
 }

modules/backend/formwidgets/RichEditor.php

@@ -217,8 +217,8 @@ protected function getPageLinksArray()
 
         $iterator = function ($links, $level = 0) use (&$iterator) {
             $result = [];
-            foreach ($links as $linkUrl => $link) {
 
+            foreach ($links as $linkUrl => $link) {
                 /*
                  * Remove scheme and host from URL
                  */

modules/backend/formwidgets/TagList.php

@@ -198,9 +198,10 @@ protected function getCustomSeparators()
     protected function getSeparatorCharacter()
     {
         switch (strtolower($this->separator)) {
-            case 'comma': return ',';
-            case 'space': return ' ';
+            case 'comma':
+                return ',';
+            case 'space':
+                return ' ';
         }
     }
-
 }

modules/backend/helpers/Backend.php

@@ -118,8 +118,8 @@ public function dateTime($dateTime, $options = [])
             'timeSince' => false,
             'ignoreTimezone' => false,
         ], $options));
-        
-        if(!$dateTime) {
+
+        if (!$dateTime) {
             return '';
         }
 
@@ -156,5 +156,4 @@ public function dateTime($dateTime, $options = [])
 
         return '<time'.Html::attributes($attributes).'>'.e($defaultValue).'</time>'.PHP_EOL;
     }
-
 }

modules/backend/models/BrandSetting.php

@@ -43,7 +43,7 @@ class BrandSetting extends Model
         'favicon' => \System\Models\File::class,
         'logo' => \System\Models\File::class
     ];
-    
+
     /**
      * @var string The key to store rendered CSS in the cache under
      */
@@ -181,5 +181,4 @@ public static function getDefaultLogo()
 
         return null;
     }
-
 }