Introduce static analysis

composer.json

@@ -53,6 +53,7 @@
         "ext-xml": "*"
     },
     "require-dev": {
+        "phpstan/phpstan-shim": "^0.11.8",
         "phpunit/phpunit": "^5.7",
         "silverstripe/versioned": "^1"
     },

phpstan.neon.dist

@@ -0,0 +1,29 @@
+parameters:
+    level: 0
+    paths:
+        - %currentWorkingDirectory%/src/
+    excludes_analyse:
+        # PHPStan bug?? https://github.com/phpstan/phpstan/issues/2171
+        - %currentWorkingDirectory%/src/View/SSTemplateParser.php
+        # tidy ext.
+        - %currentWorkingDirectory%/src/View/Parsers/TidyHTMLCleaner.php
+        - %currentWorkingDirectory%/src/Dev/CSSContentParser.php
+        # ezyang/htmlpurifier
+        - %currentWorkingDirectory%/src/View/Parsers/PurifierHTMLCleaner.php
+        # Memcached ext.
+        - %currentWorkingDirectory%/src/Core/Cache/MemcachedCacheFactory.php
+        # symfony/console
+        - %currentWorkingDirectory%/src/Dev/Upgrade/UpgradeBootstrap.php
+        # Previous version
+        - %currentWorkingDirectory%/src/Dev/Tasks/MigrateFileTask.php
+        - %currentWorkingDirectory%/src/Forms/GridField/GridFieldVersionedState.php
+        # npm package tinymce_compressor
+        - %currentWorkingDirectory%/src/Forms/HTMLEditor/TinyMCEGZIPGenerator.php
+    autoload_files:
+        - %currentWorkingDirectory%/thirdparty/php-peg/Parser.php
+        - %currentWorkingDirectory%/thirdparty/difflib/difflib.php
+        - %currentWorkingDirectory%/thirdparty/simpletest/selector.php
+        - %currentWorkingDirectory%/thirdparty/simpletest/page.php
+    ignoreErrors:
+#        # Where is TransactionalDBConnector?
+#        - '#^Class SilverStripe\\ORM\\Connect\\TransactionalDBConnector not found\.$#'

src/Control/IPUtils.php

@@ -7,7 +7,7 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  */
-namespace SilverStripe\Control\Util;
+namespace SilverStripe\Control;
 
 /**
  * Http utility functions.

src/Control/Middleware/TrustedProxyMiddleware.php

@@ -3,7 +3,7 @@
 namespace SilverStripe\Control\Middleware;
 
 use SilverStripe\Control\HTTPRequest;
-use SilverStripe\Control\Util\IPUtils;
+use SilverStripe\Control\IPUtils;
 
 /**
  * This middleware will rewrite headers that provide IP and host details from an upstream proxy.

src/Core/Manifest/ClassManifest.php

@@ -445,7 +445,7 @@ public function regenerate($includeTests)
             'name_regex' => '/^[^_].*\\.php$/',
             'ignore_files' => array('index.php', 'cli-script.php'),
             'ignore_tests' => !$includeTests,
-            'file_callback' => function ($basename, $pathname, $depth) use ($includeTests, $finder) {
+            'file_callback' => function ($basename, $pathname, $depth) use ($includeTests) {
                 $this->handleFile($basename, $pathname, $includeTests);
             },
         ));

src/Dev/DebugView.php

@@ -38,10 +38,6 @@ class DebugView
             'title' => 'Alert',
             'class' => 'error'
         ),
-        2 => array(
-            'title' => 'Critical',
-            'class' => 'error'
-        ),
         3 => array(
             'title' => 'Error',
             'class' => 'error'
@@ -86,10 +82,6 @@ class DebugView
             'title' => 'User Deprecated',
             'class' => 'notice'
         ),
-        E_CORE_ERROR => array(
-            'title' => 'Core Error',
-            'class' => 'error'
-        ),
         E_WARNING => array(
             'title' => 'Warning',
             'class' => 'warning'

src/Dev/Install/InstallRequirements.php

@@ -315,7 +315,7 @@ public function check($originalIni)
             // in addition to the temp folder being available, check it is writable
             $this->requireWriteable($tempFolder, array(
                 "File permissions",
-                sprintf("Is the temporary directory writeable?", $tempFolder),
+                sprintf("Is the temporary directory (%s) writeable?", $tempFolder),
                 null
             ), true);
         }

src/Forms/ConfirmedPasswordField.php

@@ -123,7 +123,7 @@ class ConfirmedPasswordField extends FormField
      * @param string $name
      * @param string $title
      * @param mixed $value
-     * @param Form $form
+     * @param Form $form Ignored for ConfirmedPasswordField.
      * @param boolean $showOnClick
      * @param string $titleConfirmField Alternate title (not localizeable)
      */

src/Forms/FormField.php

@@ -580,7 +580,7 @@ public function extraClass()
         //
         // CSS class needs to be different from the one rendered through {@link FieldHolder()}.
         if ($this->getMessage()) {
-            $classes[] .= 'holder-' . $this->getMessageType();
+            $classes[] = 'holder-' . $this->getMessageType();
         }
 
         return implode(' ', $classes);

src/Forms/GridField/GridField_ActionMenuLink.php

@@ -2,6 +2,8 @@
 
 namespace SilverStripe\Forms\GridField;
 
+use SilverStripe\ORM\DataObject;
+
 /**
  * Allows GridField_ActionMenuItem to act as a link
  */

src/Forms/NullableField.php

@@ -169,7 +169,7 @@ public function setName($name)
     public function debug()
     {
         $result = sprintf(
-            '%s (%s: $s : <span style="color: red">%s</span>) = ',
+            '%s (%s: %s : <span style="color: red">%s</span>) = ',
             static::class,
             $this->name,
             $this->title,

src/ORM/Connect/MySQLDatabase.php

@@ -6,6 +6,7 @@
 use SilverStripe\CMS\Model\SiteTree;
 use SilverStripe\Core\Config\Configurable;
 use SilverStripe\Core\Convert;
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\ORM\PaginatedList;
 use SilverStripe\ORM\DataList;
 use SilverStripe\ORM\ArrayList;

src/ORM/Connect/MySQLSchemaManager.php

@@ -82,23 +82,23 @@ public function alterTable(
 
         if ($newFields) {
             foreach ($newFields as $k => $v) {
-                $alterList[] .= "ADD \"$k\" $v";
+                $alterList[] = "ADD \"$k\" $v";
             }
         }
         if ($newIndexes) {
             foreach ($newIndexes as $k => $v) {
-                $alterList[] .= "ADD " . $this->getIndexSqlDefinition($k, $v);
+                $alterList[] = "ADD " . $this->getIndexSqlDefinition($k, $v);
             }
         }
         if ($alteredFields) {
             foreach ($alteredFields as $k => $v) {
-                $alterList[] .= "CHANGE \"$k\" \"$k\" $v";
+                $alterList[] = "CHANGE \"$k\" \"$k\" $v";
             }
         }
         if ($alteredIndexes) {
             foreach ($alteredIndexes as $k => $v) {
-                $alterList[] .= "DROP INDEX \"$k\"";
-                $alterList[] .= "ADD " . $this->getIndexSqlDefinition($k, $v);
+                $alterList[] = "DROP INDEX \"$k\"";
+                $alterList[] = "ADD " . $this->getIndexSqlDefinition($k, $v);
             }
         }
 

src/ORM/DatabaseAdmin.php

@@ -322,7 +322,7 @@ public function doBuild($quiet = false, $populate = true, $testMode = false)
                         try {
                             $count = DB::query("SELECT COUNT(*) FROM \"$tableName\"")->value();
                             $countSuffix = " ($count records)";
-                        } catch (Exception $e) {
+                        } catch (\Exception $e) {
                             $countSuffix = " (error getting record count)";
                         }
                     } else {

src/ORM/FieldType/DBLocale.php

@@ -65,7 +65,7 @@ public function getLongName()
     public function getNativeName()
     {
         $locale = $this->value;
-        return i18n::with_locale($locale, function () use ($locale) {
+        return i18n::with_locale($locale, function () {
             return $this->getShortName();
         });
     }

src/View/Parsers/ShortcodeParser.php

@@ -99,7 +99,7 @@ public static function set_active($identifier)
      *   - An associative array of extra information about the shortcode being parsed.
      *
      * @param string $shortcode The shortcode tag to map to the callback - normally in lowercase_underscore format.
-     * @param callback $callback The callback to replace the shortcode with.
+     * @param callable $callback The callback to replace the shortcode with.
      * @return $this
      */
     public function register($shortcode, $callback)

src/View/ThemeManifest.php

@@ -118,7 +118,7 @@ public function getCacheKey($includeTests = false)
     }
 
     /**
-     * @return \string[]
+     * @return string[]
      */
     public function getThemes()
     {

tests/php/Control/IPUtilsTest.php

@@ -12,7 +12,7 @@
  * file that was distributed with this source code.
  */
 use SilverStripe\Dev\SapphireTest;
-use SilverStripe\Control\Util\IPUtils;
+use SilverStripe\Control\IPUtils;
 
 class IPUtilsTest extends SapphireTest
 {