Add strict types

Author: johnstevenson

phpstan.neon.dist

@@ -8,8 +8,3 @@ parameters:
     paths:
         - src
         - tests
-    ignoreErrors:
-        # strict-rules errors
-        - message: "#^Call to function is_string\\(\\) with string will always evaluate to true.#"
-          count: 1
-          path: src/XdebugHandler.php

src/PhpConfig.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of composer/xdebug-handler.
  *
@@ -23,7 +25,7 @@ class PhpConfig
      *
      * @return string[] Empty array of PHP cli options
      */
-    public function useOriginal()
+    public function useOriginal(): array
     {
         $this->getDataAndReset();
         return [];
@@ -34,7 +36,7 @@ public function useOriginal()
      *
      * @return string[] PHP cli options
      */
-    public function useStandard()
+    public function useStandard(): array
     {
         $data = $this->getDataAndReset();
         if ($data !== null) {
@@ -49,7 +51,7 @@ public function useStandard()
      *
      * @return string[] Empty array of PHP cli options
      */
-    public function usePersistent()
+    public function usePersistent(): array
     {
         $data = $this->getDataAndReset();
         if ($data !== null) {
@@ -63,10 +65,9 @@ public function usePersistent()
     /**
      * Returns restart data if available and resets the environment
      *
-     * @return array|null
      * @phpstan-return restartData|null
      */
-    private function getDataAndReset()
+    private function getDataAndReset(): ?array
     {
         $data = XdebugHandler::getRestartSettings();
         if ($data !== null) {
@@ -82,10 +83,8 @@ private function getDataAndReset()
      *
      * @param string $name
      * @param string|false $value
-     *
-     * @return void
      */
-    private function updateEnv($name, $value)
+    private function updateEnv(string $name, $value): void
     {
         Process::setEnv($name, false !== $value ? $value : null);
     }

src/Process.php

@@ -9,6 +9,8 @@
  * the LICENSE file that was distributed with this source code.
  */
 
+declare(strict_types=1);
+
 namespace Composer\XdebugHandler;
 
 use Composer\Pcre\Preg;
@@ -27,12 +29,10 @@ class Process
      * MIT Licensed (c) John Stevenson <john-stevenson@blueyonder.co.uk>
      *
      * @param string $arg  The argument to be escaped
-     * @param bool   $meta Additionally escape cmd.exe meta characters
+     * @param bool $meta Additionally escape cmd.exe meta characters
      * @param bool $module The argument is the module to invoke
-     *
-     * @return string The escaped argument
      */
-    public static function escape($arg, $meta = true, $module = false)
+    public static function escape(string $arg, bool $meta = true, bool $module = false): string
     {
         if (!defined('PHP_WINDOWS_VERSION_BUILD')) {
             return "'".str_replace("'", "'\\''", $arg)."'";
@@ -67,10 +67,8 @@ public static function escape($arg, $meta = true, $module = false)
      * Escapes an array of arguments that make up a shell command
      *
      * @param string[] $args Argument list, with the module name first
-     *
-     * @return string The escaped command line
      */
-    public static function escapeShellCommand(array $args)
+    public static function escapeShellCommand(array $args): string
     {
         $command = '';
         $module = array_shift($args);
@@ -90,11 +88,9 @@ public static function escapeShellCommand(array $args)
      * Makes putenv environment changes available in $_SERVER and $_ENV
      *
      * @param string $name
-     * @param string|null $value A null value unsets the variable
-     *
-     * @return bool Whether the environment variable was set
-     */
-    public static function setEnv($name, $value = null)
+     * @param ?string $value A null value unsets the variable
+      */
+    public static function setEnv(string $name, ?string $value = null): bool
     {
         $unset = null === $value;
 

src/Status.php

@@ -9,6 +9,8 @@
  * the LICENSE file that was distributed with this source code.
  */
 
+declare(strict_types=1);
+
 namespace Composer\XdebugHandler;
 
 use Psr\Log\LoggerInterface;
@@ -48,12 +50,10 @@ class Status
     private $time;
 
     /**
-     * Constructor
-     *
      * @param string $envAllowXdebug Prefixed _ALLOW_XDEBUG name
      * @param bool $debug Whether debug output is required
      */
-    public function __construct($envAllowXdebug, $debug)
+    public function __construct(string $envAllowXdebug, bool $debug)
     {
         $start = getenv(self::ENV_RESTART);
         Process::setEnv(self::ENV_RESTART);
@@ -65,25 +65,21 @@ public function __construct($envAllowXdebug, $debug)
     }
 
     /**
-     * @param LoggerInterface $logger
+     * Activates status message output to a PSR3 logger
      *
      * @return void
      */
-    public function setLogger(LoggerInterface $logger)
+    public function setLogger(LoggerInterface $logger): void
     {
         $this->logger = $logger;
     }
 
     /**
      * Calls a handler method to report a message
      *
-     * @param string $op The handler constant
-     * @param null|string $data Data required by the handler
-     *
-     * @return void
      * @throws \InvalidArgumentException If $op is not known
      */
-    public function report($op, $data)
+    public function report(string $op, ?string $data): void
     {
         if ($this->logger !== null || $this->debug) {
             $callable = [$this, 'report'.$op];
@@ -99,13 +95,8 @@ public function report($op, $data)
 
     /**
      * Outputs a status message
-     *
-     * @param string $text
-     * @param string $level
-     *
-     * @return void
      */
-    private function output($text, $level = null)
+    private function output(string $text, ?string $level = null): void
     {
         if ($this->logger !== null) {
             $this->logger->log($level !== null ? $level: LogLevel::DEBUG, $text);
@@ -117,70 +108,64 @@ private function output($text, $level = null)
     }
 
     /**
-     * @param string $loaded
-     *
-     * @return void
+     * Checking status message
      */
-    private function reportCheck($loaded)
+    private function reportCheck(string $loaded): void
     {
         list($version, $mode) = explode('|', $loaded);
 
         if ($version !== '') {
-            $this->loaded = '('.$version.')'.($mode !== '' ? ' mode='.$mode : '');
+            $this->loaded = '('.$version.')'.($mode !== '' ? ' xdebug.mode='.$mode : '');
         }
         $this->modeOff = $mode === 'off';
         $this->output('Checking '.$this->envAllowXdebug);
     }
 
     /**
-     * @param string $error
-     *
-     * @return void
+     * Error status message
      */
-    private function reportError($error)
+    private function reportError(string $error): void
     {
         $this->output(sprintf('No restart (%s)', $error), LogLevel::WARNING);
     }
 
     /**
-     * @param string $info
-     *
-     * @return void
+     * Info status message
      */
-    private function reportInfo($info)
+    private function reportInfo(string $info): void
     {
         $this->output($info);
     }
 
     /**
-     * @return void
+     * No restart status message
      */
-    private function reportNoRestart()
+    private function reportNoRestart(): void
     {
         $this->output($this->getLoadedMessage());
 
         if ($this->loaded !== null) {
             $text = sprintf('No restart (%s)', $this->getEnvAllow());
             if (!((bool) getenv($this->envAllowXdebug))) {
-                $text .= ' Allowed by '.($this->modeOff ? 'mode' : 'application');
+                $text .= ' Allowed by '.($this->modeOff ? 'xdebug.mode' : 'application');
             }
             $this->output($text);
         }
     }
 
     /**
-     * @return void
+     * Restart status message
      */
-    private function reportRestart()
+    private function reportRestart(): void
     {
         $this->output($this->getLoadedMessage());
         Process::setEnv(self::ENV_RESTART, (string) microtime(true));
     }
 
     /**
-     * @return void
+     * Restarted status message
      */
-    private function reportRestarted()
+    private function reportRestarted(): void
     {
         $loaded = $this->getLoadedMessage();
         $text = sprintf('Restarted (%d ms). %s', $this->time, $loaded);
@@ -189,11 +174,9 @@ private function reportRestarted()
     }
 
     /**
-     * @param string $command
-     *
-     * @return void
+     * Restarting status message
      */
-    private function reportRestarting($command)
+    private function reportRestarting(string $command): void
     {
         $text = sprintf('Process restarting (%s)', $this->getEnvAllow());
         $this->output($text);
@@ -203,20 +186,16 @@ private function reportRestarting($command)
 
     /**
      * Returns the _ALLOW_XDEBUG environment variable as name=value
-     *
-     * @return string
      */
-    private function getEnvAllow()
+    private function getEnvAllow(): string
     {
         return $this->envAllowXdebug.'='.getenv($this->envAllowXdebug);
     }
 
     /**
      * Returns the Xdebug status and version
-     *
-     * @return string
      */
-    private function getLoadedMessage()
+    private function getLoadedMessage(): string
     {
         $loaded = $this->loaded !== null ? sprintf('loaded %s', $this->loaded) : 'not loaded';
         return 'The Xdebug extension is '.$loaded;