Add PHP types to private methods and functions

Author: wouterj

DeprecationErrorHandler.php

@@ -354,7 +354,7 @@ private function displayDeprecations($groups, $configuration)
         }
     }
 
-    private static function getPhpUnitErrorHandler()
+    private static function getPhpUnitErrorHandler(): callable
     {
         if (!$eh = self::$errorHandler) {
             if (class_exists(Handler::class)) {

DeprecationErrorHandler/Configuration.php

@@ -154,20 +154,15 @@ private function __construct(array $thresholds = [], $regex = '', $verboseOutput
         $this->logFile = $logFile;
     }
 
-    /**
-     * @return bool
-     */
-    public function isEnabled()
+    public function isEnabled(): bool
     {
         return $this->enabled;
     }
 
     /**
      * @param DeprecationGroup[] $deprecationGroups
-     *
-     * @return bool
      */
-    public function tolerates(array $deprecationGroups)
+    public function tolerates(array $deprecationGroups): bool
     {
         $grandTotal = 0;
 
@@ -229,10 +224,7 @@ public function toleratesForGroup(string $groupName, array $deprecationGroups):
         return true;
     }
 
-    /**
-     * @return bool
-     */
-    public function isBaselineDeprecation(Deprecation $deprecation)
+    public function isBaselineDeprecation(Deprecation $deprecation): bool
     {
         if ($deprecation->isLegacy()) {
             return false;
@@ -260,20 +252,17 @@ public function isBaselineDeprecation(Deprecation $deprecation)
         return $result;
     }
 
-    /**
-     * @return bool
-     */
-    public function isGeneratingBaseline()
+    public function isGeneratingBaseline(): bool
     {
         return $this->generateBaseline;
     }
 
-    public function getBaselineFile()
+    public function getBaselineFile(): string
     {
         return $this->baselineFile;
     }
 
-    public function writeBaseline()
+    public function writeBaseline(): void
     {
         $map = [];
         foreach ($this->baselineDeprecations as $location => $messages) {
@@ -290,47 +279,37 @@ public function writeBaseline()
 
     /**
      * @param string $message
-     *
-     * @return bool
      */
-    public function shouldDisplayStackTrace($message)
+    public function shouldDisplayStackTrace($message): bool
     {
         return '' !== $this->regex && preg_match($this->regex, $message);
     }
 
-    /**
-     * @return bool
-     */
-    public function isInRegexMode()
+    public function isInRegexMode(): bool
     {
         return '' !== $this->regex;
     }
 
-    /**
-     * @return bool
-     */
-    public function verboseOutput($group)
+    public function verboseOutput($group): bool
     {
         return $this->verboseOutput[$group];
     }
 
-    public function shouldWriteToLogFile()
+    public function shouldWriteToLogFile(): bool
     {
         return null !== $this->logFile;
     }
 
-    public function getLogFile()
+    public function getLogFile(): ?string
     {
         return $this->logFile;
     }
 
     /**
      * @param string $serializedConfiguration an encoded string, for instance
      *                                        max[total]=1234&max[indirect]=42
-     *
-     * @return self
      */
-    public static function fromUrlEncodedString($serializedConfiguration)
+    public static function fromUrlEncodedString($serializedConfiguration): self
     {
         parse_str($serializedConfiguration, $normalizedConfiguration);
         foreach (array_keys($normalizedConfiguration) as $key) {
@@ -376,29 +355,20 @@ public static function fromUrlEncodedString($serializedConfiguration)
         );
     }
 
-    /**
-     * @return self
-     */
-    public static function inDisabledMode()
+    public static function inDisabledMode(): self
     {
         $configuration = new self();
         $configuration->enabled = false;
 
         return $configuration;
     }
 
-    /**
-     * @return self
-     */
-    public static function inStrictMode()
+    public static function inStrictMode(): self
     {
         return new self(['total' => 0]);
     }
 
-    /**
-     * @return self
-     */
-    public static function inWeakMode()
+    public static function inWeakMode(): self
     {
         $verboseOutput = [];
         foreach (['unsilenced', 'direct', 'indirect', 'self', 'other'] as $group) {
@@ -408,18 +378,12 @@ public static function inWeakMode()
         return new self([], '', $verboseOutput);
     }
 
-    /**
-     * @return self
-     */
-    public static function fromNumber($upperBound)
+    public static function fromNumber($upperBound): self
     {
         return new self(['total' => $upperBound]);
     }
 
-    /**
-     * @return self
-     */
-    public static function fromRegex($regex)
+    public static function fromRegex($regex): self
     {
         return new self([], $regex);
     }

DeprecationErrorHandler/Deprecation.php

@@ -356,7 +356,7 @@ private static function getVendors()
         return self::$vendors;
     }
 
-    private static function addSourcePathsFromPrefixes(array $prefixesByNamespace, array $paths)
+    private static function addSourcePathsFromPrefixes(array $prefixesByNamespace, array $paths): array
     {
         foreach ($prefixesByNamespace as $prefixes) {
             foreach ($prefixes as $prefix) {

DeprecationErrorHandler/DeprecationGroup.php

@@ -50,20 +50,18 @@ public function addNotice()
 
     /**
      * @param string $message
-     *
-     * @return DeprecationNotice
      */
-    private function deprecationNotice($message)
+    private function deprecationNotice($message): DeprecationNotice
     {
         return $this->deprecationNotices[$message] ?? $this->deprecationNotices[$message] = new DeprecationNotice();
     }
 
-    public function count()
+    public function count(): int
     {
         return $this->count;
     }
 
-    public function notices()
+    public function notices(): array
     {
         return $this->deprecationNotices;
     }

DeprecationErrorHandler/DeprecationNotice.php

@@ -37,12 +37,12 @@ public function addProceduralOccurrence()
         ++$this->count;
     }
 
-    public function getCountsByCaller()
+    public function getCountsByCaller(): array
     {
         return $this->countsByCaller;
     }
 
-    public function count()
+    public function count(): int
     {
         return $this->count;
     }