Merge pull request #9717 from robbieaverill/pulls/4.7/improve-stuff

Update spaces in syntax, single quotes, early returns where possible

src/ORM/Connect/DBConnector.php

@@ -122,9 +122,8 @@ protected function isQueryType($sql, $type)
         $operation = $matches['operation'];
         if (is_array($type)) {
             return in_array(strtolower($operation), $type);
-        } else {
-            return strcasecmp($sql, $type) === 0;
         }
+        return strcasecmp($sql, $type) === 0;
     }
 
     /**

src/ORM/Connect/DBSchemaManager.php

@@ -788,51 +788,45 @@ public function alterationMessage($message, $type = "")
         if (!$this->supressOutput) {
             if (Director::is_cli()) {
                 switch ($type) {
-                    case "created":
-                    case "changed":
-                    case "repaired":
-                        $sign = "+";
+                    case 'created':
+                    case 'changed':
+                    case 'repaired':
+                        $sign = '+';
                         break;
-                    case "obsolete":
-                    case "deleted":
+                    case 'obsolete':
+                    case 'deleted':
                         $sign = '-';
                         break;
-                    case "notice":
+                    case 'notice':
                         $sign = '*';
                         break;
-                    case "error":
-                        $sign = "!";
+                    case 'error':
+                        $sign = '!';
                         break;
                     default:
-                        $sign = " ";
+                        $sign = ' ';
                 }
                 $message = strip_tags($message);
                 echo "  $sign $message\n";
             } else {
                 switch ($type) {
-                    case "created":
-                        $class = "success";
+                    case 'created':
+                        $class = 'success';
                         break;
-                    case "obsolete":
-                        $class = "error";
+                    case 'obsolete':
+                    case 'error':
+                    case 'deleted':
+                        $class = 'error';
                         break;
-                    case "notice":
-                        $class = "warning";
+                    case 'notice':
+                        $class = 'warning';
                         break;
-                    case "error":
-                        $class = "error";
-                        break;
-                    case "deleted":
-                        $class = "error";
-                        break;
-                    case "changed":
-                        $class = "info";
-                        break;
-                    case "repaired":
-                        $class = "info";
+                    case 'changed':
+                    case 'repaired':
+                        $class = 'info';
                         break;
                     default:
-                        $class = "";
+                        $class = '';
                 }
                 echo "<li class=\"$class\">$message</li>";
             }
@@ -878,7 +872,7 @@ public function fixTableCase($tableName)
 
         $this->alterationMessage(
             "Table $tableName: renamed from $currentName",
-            "repaired"
+            'repaired'
         );
 
         // Rename via temp table to avoid case-sensitivity issues

src/ORM/Connect/Database.php

@@ -254,9 +254,8 @@ protected function benchmarkQuery($sql, $callback, $parameters = [])
                 Backtrace::backtrace();
             }
             return $result;
-        } else {
-            return $callback($sql);
         }
+        return $callback($sql);
     }
 
     /**

src/ORM/Connect/DatabaseException.php

@@ -53,7 +53,7 @@ public function getParameters()
      * @param string $sql The SQL executed for this query
      * @param array $parameters The parameters given for this query, if any
      */
-    function __construct($message = '', $code = 0, $previous = null, $sql = null, $parameters = [])
+    public function __construct($message = '', $code = 0, $previous = null, $sql = null, $parameters = [])
     {
         parent::__construct($message, $code, $previous);
         $this->sql = $sql;

src/ORM/FieldType/DBBoolean.php

@@ -11,7 +11,6 @@
  */
 class DBBoolean extends DBField
 {
-
     public function __construct($name = null, $defaultVal = 0)
     {
         $this->defaultVal = ($defaultVal) ? 1 : 0;
@@ -21,15 +20,15 @@ public function __construct($name = null, $defaultVal = 0)
 
     public function requireField()
     {
-        $parts=[
-            'datatype'=>'tinyint',
-            'precision'=>1,
-            'sign'=>'unsigned',
-            'null'=>'not null',
-            'default'=>$this->defaultVal,
-            'arrayValue'=>$this->arrayValue
+        $parts = [
+            'datatype' => 'tinyint',
+            'precision' => 1,
+            'sign' => 'unsigned',
+            'null' => 'not null',
+            'default' => $this->defaultVal,
+            'arrayValue' => $this->arrayValue
         ];
-        $values=['type'=>'boolean', 'parts'=>$parts];
+        $values = ['type' => 'boolean', 'parts' => $parts];
         DB::require_field($this->tableName, $this->name, $values);
     }
 
@@ -81,9 +80,11 @@ public function prepValueForDB($value)
     {
         if (is_bool($value)) {
             return $value ? 1 : 0;
-        } elseif (empty($value)) {
+        }
+        if (empty($value)) {
             return 0;
-        } elseif (is_string($value)) {
+        }
+        if (is_string($value)) {
             switch (strtolower($value)) {
                 case 'false':
                 case 'f':

src/ORM/FieldType/DBClassName.php

@@ -4,9 +4,9 @@
 
 use SilverStripe\Core\ClassInfo;
 use SilverStripe\Core\Config\Config;
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\DB;
-use SilverStripe\Dev\Deprecation;
 
 /**
  * Represents a classname selector, which respects obsolete clasess.

src/ORM/FieldType/DBComposite.php

@@ -126,7 +126,7 @@ public function compositeDatabaseFields()
     public function isChanged()
     {
         // When unbound, use the local changed flag
-        if (! ($this->record instanceof DataObject)) {
+        if (!$this->record instanceof DataObject) {
             return $this->isChanged;
         }
 

src/ORM/FieldType/DBCurrency.php

@@ -35,7 +35,6 @@ public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $def
      */
     public function Nice()
     {
-        // return "<span title=\"$this->value\">$" . number_format($this->value, 2) . '</span>';
         $val = $this->config()->currency_symbol . number_format(abs($this->value), 2);
         if ($this->value < 0) {
             return "($val)";

src/ORM/FieldType/DBDate.php

@@ -335,11 +335,11 @@ public function RangeString($otherDateObj, $includeOrdinals = false)
 
         if ($y1 != $y2) {
             return "$d1 $m1 $y1 - $d2 $m2 $y2";
-        } elseif ($m1 != $m2) {
+        }
+        if ($m1 != $m2) {
             return "$d1 $m1 - $d2 $m2 $y1";
-        } else {
-            return "$d1 - $d2 $m1 $y1";
         }
+        return "$d1 - $d2 $m1 $y1";
     }
 
     /**
@@ -393,19 +393,18 @@ public function Ago($includeSeconds = true, $significance = 2)
         $now = DBDatetime::now()->getTimestamp();
         if ($timestamp <= $now) {
             return _t(
-                'SilverStripe\\ORM\\FieldType\\DBDate.TIMEDIFFAGO',
+                __CLASS__ . '.TIMEDIFFAGO',
                 "{difference} ago",
                 'Natural language time difference, e.g. 2 hours ago',
                 ['difference' => $this->TimeDiff($includeSeconds, $significance)]
             );
-        } else {
-            return _t(
-                'SilverStripe\\ORM\\FieldType\\DBDate.TIMEDIFFIN',
-                "in {difference}",
-                'Natural language time difference, e.g. in 2 hours',
-                ['difference' => $this->TimeDiff($includeSeconds, $significance)]
-            );
         }
+        return _t(
+            __CLASS__ . '.TIMEDIFFIN',
+            "in {difference}",
+            'Natural language time difference, e.g. in 2 hours',
+            ['difference' => $this->TimeDiff($includeSeconds, $significance)]
+        );
     }
 
     /**
@@ -423,20 +422,24 @@ public function TimeDiff($includeSeconds = true, $significance = 2)
         $time = $this->getTimestamp();
         $ago = abs($time - $now);
         if ($ago < 60 && !$includeSeconds) {
-            return _t('SilverStripe\\ORM\\FieldType\\DBDate.LessThanMinuteAgo', 'less than a minute');
-        } elseif ($ago < $significance * 60 && $includeSeconds) {
+            return _t(__CLASS__ . '.LessThanMinuteAgo', 'less than a minute');
+        }
+        if ($ago < $significance * 60 && $includeSeconds) {
             return $this->TimeDiffIn('seconds');
-        } elseif ($ago < $significance * 3600) {
+        }
+        if ($ago < $significance * 3600) {
             return $this->TimeDiffIn('minutes');
-        } elseif ($ago < $significance * 86400) {
+        }
+        if ($ago < $significance * 86400) {
             return $this->TimeDiffIn('hours');
-        } elseif ($ago < $significance * 86400 * 30) {
+        }
+        if ($ago < $significance * 86400 * 30) {
             return $this->TimeDiffIn('days');
-        } elseif ($ago < $significance * 86400 * 365) {
+        }
+        if ($ago < $significance * 86400 * 365) {
             return $this->TimeDiffIn('months');
-        } else {
-            return $this->TimeDiffIn('years');
         }
+        return $this->TimeDiffIn('years');
     }
 
     /**
@@ -456,47 +459,47 @@ public function TimeDiffIn($format)
         $time = $this->getTimestamp();
         $ago = abs($time - $now);
         switch ($format) {
-            case "seconds":
+            case 'seconds':
                 $span = $ago;
                 return _t(
                     __CLASS__ . '.SECONDS_SHORT_PLURALS',
                     '{count} sec|{count} secs',
                     ['count' => $span]
                 );
 
-            case "minutes":
+            case 'minutes':
                 $span = round($ago / 60);
                 return _t(
                     __CLASS__ . '.MINUTES_SHORT_PLURALS',
                     '{count} min|{count} mins',
                     ['count' => $span]
                 );
 
-            case "hours":
+            case 'hours':
                 $span = round($ago / 3600);
                 return _t(
                     __CLASS__ . '.HOURS_SHORT_PLURALS',
                     '{count} hour|{count} hours',
                     ['count' => $span]
                 );
 
-            case "days":
+            case 'days':
                 $span = round($ago / 86400);
                 return _t(
                     __CLASS__ . '.DAYS_SHORT_PLURALS',
                     '{count} day|{count} days',
                     ['count' => $span]
                 );
 
-            case "months":
+            case 'months':
                 $span = round($ago / 86400 / 30);
                 return _t(
                     __CLASS__ . '.MONTHS_SHORT_PLURALS',
                     '{count} month|{count} months',
                     ['count' => $span]
                 );
 
-            case "years":
+            case 'years':
                 $span = round($ago / 86400 / 365);
                 return _t(
                     __CLASS__ . '.YEARS_SHORT_PLURALS',
@@ -554,6 +557,7 @@ public function IsToday()
      * </code>
      *
      * @param string $adjustment PHP strtotime style
+     * @return $this
      */
     public function modify(string $adjustment): self
     {
@@ -588,7 +592,7 @@ public function scaffoldFormField($title = null, $params = null)
     protected function fixInputDate($value)
     {
         // split
-        list($year, $month, $day, $time) = $this->explodeDateString($value);
+        [$year, $month, $day, $time] = $this->explodeDateString($value);
 
         if ((int)$year === 0 && (int)$month === 0 && (int)$day === 0) {
             return null;

src/ORM/FieldType/DBDatetime.php

@@ -93,7 +93,7 @@ public function Time24()
      * Return a date and time formatted as per a CMS user's settings.
      *
      * @param Member $member
-     * @return boolean | string A time and date pair formatted as per user-defined settings.
+     * @return boolean|string A time and date pair formatted as per user-defined settings.
      */
     public function FormatFromSettings($member = null)
     {
@@ -150,7 +150,7 @@ public function scaffoldFormField($title = null, $params = null)
                 'SilverStripe\\Forms\\FormField.EXAMPLE',
                 'e.g. {format}',
                 'Example format',
-                [ 'format' => $date ]
+                ['format' => $date]
             ))
             ->setAttribute('placeholder', $dateTimeFormat);
 

src/ORM/FieldType/DBDecimal.php

@@ -2,8 +2,8 @@
 
 namespace SilverStripe\ORM\FieldType;
 
-use SilverStripe\ORM\DB;
 use SilverStripe\Forms\NumericField;
+use SilverStripe\ORM\DB;
 
 /**
  * Represents a Decimal field.

src/ORM/FieldType/DBDouble.php

@@ -2,8 +2,8 @@
 
 namespace SilverStripe\ORM\FieldType;
 
-use SilverStripe\ORM\DB;
 use SilverStripe\ORM\Connect\MySQLDatabase;
+use SilverStripe\ORM\DB;
 
 /**
  * Supports double precision DB types

src/ORM/FieldType/DBEnum.php

@@ -130,7 +130,7 @@ public function requireField()
      * @param string $emptyString
      * @return DropdownField
      */
-    public function formField($title = null, $name = null, $hasEmpty = false, $value = "", $emptyString = null)
+    public function formField($title = null, $name = null, $hasEmpty = false, $value = '', $emptyString = null)
     {
 
         if (!$title) {
@@ -154,13 +154,12 @@ public function scaffoldFormField($title = null, $params = null)
     }
 
     /**
-     * @param string
-     *
+     * @param string $title
      * @return DropdownField
      */
     public function scaffoldSearchField($title = null)
     {
-        $anyText = _t('SilverStripe\\ORM\\FieldType\\DBEnum.ANY', 'Any');
+        $anyText = _t(__CLASS__ . '.ANY', 'Any');
         return $this->formField($title, null, true, '', "($anyText)");
     }