Add some missing return type declarations.

Author: Maikuolan

Changelog.md

@@ -39,3 +39,7 @@ __*Why "v3.0.0" instead of "v1.0.0?"*__ Prior to phpMussel v3, the "phpMussel Co
 [2021.02.05; Maikuolan]: The default timeout for external requests is now configurable.
 
 [2021.02.07; Maikuolan]: Added the ability to hide the phpMussel version used.
+
+### v3.2.1
+
+[2021.03.11; Maikuolan]: Added some missing return type declarations.

src/ArchiveHandlerInterface.php

@@ -8,7 +8,7 @@
  * License: GNU/GPLv2
  * @see LICENSE.txt
  *
- * This file: Archive handler (last modified: 2020.06.12).
+ * This file: Archive handler (last modified: 2021.03.11).
  */
 
 namespace phpMussel\Core;
@@ -29,13 +29,17 @@ public function EntryRead(int $Bytes = -1);
 
     /**
      * Return the compressed size of the entry at the current entry pointer.
+     *
+     * @return int
      */
-    public function EntryCompressedSize();
+    public function EntryCompressedSize(): int;
 
     /**
      * Return the actual size of the entry at the current entry pointer.
+     *
+     * @return int
      */
-    public function EntryActualSize();
+    public function EntryActualSize(): int;
 
     /**
      * Return whether the entry at the current entry pointer is a directory.
@@ -53,8 +57,10 @@ public function EntryIsEncrypted(): bool;
 
     /**
      * Return the reported internal CRC hash for the entry, if it exists.
+     *
+     * @return string
      */
-    public function EntryCRC();
+    public function EntryCRC(): string;
 
     /**
      * Return the name of the entry at the current entry pointer.

src/Loader.php

@@ -8,7 +8,7 @@
  * License: GNU/GPLv2
  * @see LICENSE.txt
  *
- * This file: The loader (last modified: 2021.03.03).
+ * This file: The loader (last modified: 2021.03.11).
  */
 
 namespace phpMussel\Core;
@@ -484,8 +484,9 @@ public function readBytes(string $In, int $Mode = 0)
      *
      * @param mixed $Var The variable to fix (passed by reference).
      * @param string $Type The type (or pseudo-type) to cast the variable to.
+     * @return void
      */
-    public function autoType(&$Var, string $Type = '')
+    public function autoType(&$Var, string $Type = ''): void
     {
         if (in_array($Type, ['string', 'timezone', 'checkbox', 'url', 'email'], true)) {
             $Var = (string)$Var;
@@ -513,8 +514,9 @@ public function autoType(&$Var, string $Type = '')
      * Performs fallbacks and autotyping for missing configuration directives.
      *
      * @param array $Fallbacks The fallback source.
+     * @return void
      */
-    public function fallback(array $Fallbacks)
+    public function fallback(array $Fallbacks): void
     {
         foreach ($Fallbacks as $KeyCat => $DCat) {
             if (!isset($this->Configuration[$KeyCat])) {
@@ -551,8 +553,9 @@ public function fallback(array $Fallbacks)
      * Load L10N data.
      *
      * @param string $Path Where to find the L10N data to load.
+     * @return void
      */
-    public function loadL10N(string $Path = '')
+    public function loadL10N(string $Path = ''): void
     {
         if ($this->Configuration['core']['lang'] === 'en') {
             $Primary = $this->readFile($Path . 'en.yml');
@@ -905,7 +908,7 @@ public function readFileBlocksGZ(string $File, int $BlocksToRead = 0): string
      * @param resource|null $Context Refer to the description for file().
      * @return array The file's contents or an empty array on failure.
      */
-    public function readFileAsArray(string $Filename, int $Flags = 0, $Context = null)
+    public function readFileAsArray(string $Filename, int $Flags = 0, $Context = null): array
     {
         /** Guard. */
         if (!is_file($Filename) || !is_readable($Filename) || !$Filesize = filesize($Filename)) {
@@ -939,8 +942,9 @@ public function unpackSafe(string $Format, string $Data): array
      * If input isn't an array, make it so. Remove empty elements.
      *
      * @param mixed $Input
+     * @return void
      */
-    public function arrayify(&$Input)
+    public function arrayify(&$Input): void
     {
         if (!is_array($Input)) {
             $Input = [$Input];
@@ -993,8 +997,9 @@ public function isDirEmpty(string $Directory): bool
      * Deletes empty directories (used by some front-end methods and log rotation).
      *
      * @param string $Dir The directory to delete.
+     * @return void
      */
-    public function deleteDirectory(string $Dir)
+    public function deleteDirectory(string $Dir): void
     {
         while (strrpos($Dir, DIRECTORY_SEPARATOR) !== false) {
             $Dir = substr($Dir, 0, strrpos($Dir, DIRECTORY_SEPARATOR));
@@ -1110,8 +1115,9 @@ public function hexSafe(string $Data): string
      *
      * @throws Exception if using flatfiles for caching and if an appropriate
      *      cache directory hasn't been specified or can't be written to.
+     * @return void
      */
-    private function initialiseCache()
+    private function initialiseCache(): void
     {
         /** Exit early if already initialised. */
         if ($this->Cache instanceof \Maikuolan\Common\Cache) {
@@ -1224,8 +1230,9 @@ public function loadShorthandData(): bool
      * @param string $Text A human-readable explanation of the hit.
      * @param int $Code The integer results of the scan.
      * @param int $Depth The current depth of the scan process.
+     * @return void
      */
-    public function atHit(string $Hash, int $Size = -1, string $Name = '', string $Text = '', int $Code = 2, int $Depth = 0)
+    public function atHit(string $Hash, int $Size = -1, string $Name = '', string $Text = '', int $Code = 2, int $Depth = 0): void
     {
         /** Fallback for missing item hash. */
         if ($Hash === '') {

src/PdfHandler.php

@@ -8,7 +8,7 @@
  * License: GNU/GPLv2
  * @see LICENSE.txt
  *
- * This file: Pdf handler (last modified: 2020.11.27).
+ * This file: Pdf handler (last modified: 2021.03.11).
  */
 
 namespace phpMussel\Core;
@@ -348,7 +348,7 @@ public function EntryRead(int $Bytes = -1): string
      */
     public function EntryCompressedSize(): int
     {
-        return $this->Objects[$this->Index]['EntryCompressedSize'] ?? 0;
+        return (int)($this->Objects[$this->Index]['EntryCompressedSize'] ?? 0);
     }
 
     /**
@@ -358,7 +358,7 @@ public function EntryCompressedSize(): int
      */
     public function EntryActualSize(): int
     {
-        return $this->Objects[$this->Index]['EntryActualSize'] ?? 0;
+        return (int)($this->Objects[$this->Index]['EntryActualSize'] ?? 0);
     }
 
     /**
@@ -384,11 +384,11 @@ public function EntryIsEncrypted(): bool
     /**
      * Return the reported internal CRC hash for the entry, if it exists.
      *
-     * @return false Pdf doesn't provide internal CRCs.
+     * @return string Empty because PDF doesn't provide internal CRCs.
      */
-    public function EntryCRC(): bool
+    public function EntryCRC(): string
     {
-        return false;
+        return '';
     }
 
     /**

src/RarHandler.php

@@ -8,7 +8,7 @@
  * License: GNU/GPLv2
  * @see LICENSE.txt
  *
- * This file: Rar handler (last modified: 2020.07.11).
+ * This file: Rar handler (last modified: 2021.03.11).
  */
 
 namespace phpMussel\Core;
@@ -89,18 +89,22 @@ public function EntryRead(int $Bytes = -1)
 
     /**
      * Return the compressed size of the entry at the current entry pointer.
+     *
+     * @return int
      */
-    public function EntryCompressedSize()
+    public function EntryCompressedSize(): int
     {
-        return is_object($this->RarEntry) ? $this->RarEntry->getPackedSize() : false;
+        return is_object($this->RarEntry) ? (int)$this->RarEntry->getPackedSize() : 0;
     }
 
     /**
      * Return the actual size of the entry at the current entry pointer.
+     *
+     * @return int
      */
-    public function EntryActualSize()
+    public function EntryActualSize(): int
     {
-        return is_object($this->RarEntry) ? $this->RarEntry->getUnpackedSize() : false;
+        return is_object($this->RarEntry) ? (int)$this->RarEntry->getUnpackedSize() : 0;
     }
 
     /**
@@ -125,10 +129,12 @@ public function EntryIsEncrypted(): bool
 
     /**
      * Return the reported internal CRC hash for the entry, if it exists.
+     *
+     * @return string
      */
-    public function EntryCRC()
+    public function EntryCRC(): string
     {
-        return is_object($this->RarEntry) ? $this->RarEntry->getCrc() : false;
+        return is_object($this->RarEntry) ? (string)$this->RarEntry->getCrc() : '';
     }
 
     /**

src/Scanner.php

@@ -8,7 +8,7 @@
  * License: GNU/GPLv2
  * @see LICENSE.txt
  *
- * This file: The scanner (last modified: 2021.01.10).
+ * This file: The scanner (last modified: 2021.03.11).
  */
 
 namespace phpMussel\Core;
@@ -314,8 +314,9 @@ public function scan($Files, int $Format = 0)
      * @param string|array $Files Supplied by the scan method.
      * @param int $Depth Represents the current depth of recursion from which the
      *      method has been called.
+     * @return void
      */
-    private function recursor($Files = '', int $Depth = -1)
+    private function recursor($Files = '', int $Depth = -1): void
     {
         /** Fire event: "atStartOf_recursor". */
         $this->Loader->Events->fireEvent('atStartOf_recursor');
@@ -716,8 +717,9 @@ private function recursor($Files = '', int $Depth = -1)
      *      scanned (in this context, referring to the name supplied by the upload
      *      client or CLI operator, as opposed to the temporary filename assigned
      *      by the server or anything else).
+     * @return void
      */
-    private function dataHandler(string $str = '', int $Depth = 0, string $OriginalFilename = '')
+    private function dataHandler(string $str = '', int $Depth = 0, string $OriginalFilename = ''): void
     {
         /** Fire event: "atStartOf_dataHandler". */
         $this->Loader->Events->fireEvent('atStartOf_dataHandler');
@@ -2339,9 +2341,10 @@ private function dataHandler(string $str = '', int $Depth = 0, string $OriginalF
      *      needed (because the zip and rar classes require a file pointer).
      * @param int $ScanDepth The current scan depth (supplied during recursion).
      * @param string $ItemRef A reference to the parent container (for logging).
+     * @return void
      * @throws Exception if the metadata scanner throws an exception (forwarded on).
      */
-    private function archiveRecursor(string $Data, string $File = '', int $ScanDepth = 0, string $ItemRef = '')
+    private function archiveRecursor(string $Data, string $File = '', int $ScanDepth = 0, string $ItemRef = ''): void
     {
         /** Fire event: "atStartOf_archiveRecursor". */
         $this->Loader->Events->fireEvent('atStartOf_archiveRecursor');
@@ -2687,8 +2690,10 @@ private function archiveRecursor(string $Data, string $File = '', int $ScanDepth
 
     /**
      * Initialise statistics if they've been enabled.
+     *
+     * @return void
      */
-    public function statsInitialise()
+    public function statsInitialise(): void
     {
         /** Guard. */
         if (!$this->Loader->Configuration['core']['statistics']) {
@@ -2724,8 +2729,9 @@ public function statsInitialise()
      *
      * @param string $Statistic The statistic to increment.
      * @param int $Amount The amount to increment it by.
+     * @return void
      */
-    public function statsIncrement(string $Statistic, int $Amount)
+    public function statsIncrement(string $Statistic, int $Amount): void
     {
         /** Guard. */
         if (!$this->Loader->Configuration['core']['statistics'] || !isset($this->Loader->InstanceCache['Statistics'][$Statistic])) {
@@ -2738,8 +2744,10 @@ public function statsIncrement(string $Statistic, int $Amount)
 
     /**
      * Fetch information about signature files for the scan process.
+     *
+     * @return void
      */
-    private function organiseSigFiles()
+    private function organiseSigFiles(): void
     {
         /** Guard. */
         if (empty($this->Loader->Configuration['signatures']['active']) || !$this->Loader->SignaturesPath) {
@@ -3597,8 +3605,9 @@ private function confineLength(int $Length): bool
      * @param string $Checksum
      * @param int $StringLength
      * @param int $Depth
+     * @return void
      */
-    private function detected(string $VN, string $OriginalFilename, string $Checksum, int $StringLength, int $Depth)
+    private function detected(string $VN, string $OriginalFilename, string $Checksum, int $StringLength, int $Depth): void
     {
         /** Prepare detection text. */
         $Text = sprintf($this->Loader->L10N->getString('grammar_exclamation_mark'), sprintf(
@@ -3631,8 +3640,9 @@ private function detected(string $VN, string $OriginalFilename, string $Checksum
      * @param string|int $Initial The start of the boundary or string initial offset value.
      * @param string|int $Terminal The end of the boundary or string terminal offset value.
      * @param array $SectionOffsets Section offset values.
+     * @return void
      */
-    private function dataConfineByOffsets(string &$Data, &$Initial, &$Terminal, array &$SectionOffsets)
+    private function dataConfineByOffsets(string &$Data, &$Initial, &$Terminal, array &$SectionOffsets): void
     {
         /** Guard. */
         if ($Initial === '*' && $Terminal === '*') {
@@ -3738,8 +3748,9 @@ private function splitSigParts(string $Sig, int $Max = -1): array
      * @param int $Depth The depth of the item being scanned in relation to its
      *      container and/or its hierarchy within the scan process.
      * @param string $Checksum A hash for the content, inherited from the parent.
+     * @return void
      */
-    private function metaDataScan(string $ItemRef, string $Filename, string &$Data, int $Depth, string $Checksum)
+    private function metaDataScan(string $ItemRef, string $Filename, string &$Data, int $Depth, string $Checksum): void
     {
         $Depth++;
 
@@ -3903,8 +3914,9 @@ private function convertCrx(string &$Data): bool
      * Assigns an array to use for dumping scan debug information (optional).
      *
      * @param array $Arr
+     * @return void
      */
-    public function setScanDebugArray(&$Arr)
+    public function setScanDebugArray(&$Arr): void
     {
         unset($this->debugArr);
         if (!is_array($Arr)) {
@@ -3917,17 +3929,20 @@ public function setScanDebugArray(&$Arr)
      * Destroys the scan debug array (optional).
      *
      * @param array $Arr
+     * @return void
      */
-    public function destroyScanDebugArray(&$Arr)
+    public function destroyScanDebugArray(&$Arr): void
     {
         unset($this->Loader->InstanceCache['DebugArrKey'], $this->debugArr);
         $Arr = null;
     }
 
     /**
      * Reset heuristics.
+     *
+     * @return void
      */
-    private function resetHeuristics()
+    private function resetHeuristics(): void
     {
         $this->HeuristicText = [];
         $this->HeuristicCount = 0;