Unify file reading methods.

Changelog excerpt:
- Unified the methods for reading files to a singular method.

Author: Maikuolan

Changelog.md

@@ -133,3 +133,5 @@ __*Why "v3.0.0" instead of "v1.0.0?"*__ Prior to phpMussel v3, the "phpMussel Co
 [2023.09.16~18; Maikuolan]: Significantly refactored all L10N data.
 
 [2023.09.18; Maikuolan]: Better resource guarding.
+
+[2023.09.25; Maikuolan]: Unified the methods for reading files to a singular method.

src/Loader.php

@@ -174,7 +174,7 @@ class Loader
     private $Channels = [];
 
     /**
-     * @var int The default blocksize for readFileContent and readFileContentGZ.
+     * @var int The default blocksize for readFileGZ.
      */
     private $Blocksize = 131072;
 
@@ -349,7 +349,7 @@ public function __construct(
             $this->Request->ObjLoggerFile = $this->buildPath($this->Configuration['core']['outbound_request_log']);
         }
         $ChannelsDataArray = [];
-        $this->YAML->process($this->readFileContent($this->AssetsPath . 'channels.yml'), $ChannelsDataArray);
+        $this->YAML->process($this->readFile($this->AssetsPath . 'channels.yml'), $ChannelsDataArray);
         $this->Request->Channels = $ChannelsDataArray ?: [];
         unset($ChannelsDataArray);
         if (!isset($this->Request->Channels['Triggers'])) {
@@ -447,28 +447,6 @@ public function __destruct()
         restore_error_handler();
     }
 
-    /**
-     * Returns the content of the specified file (should only use for
-     * reasonably small files).
-     *
-     * @param string $File The file to read.
-     * @return string The file's content or an empty string on failure.
-     */
-    public function readFile(string $File): string
-    {
-        /** Guard. */
-        if (!is_file($File) || !is_readable($File) || !$Filesize = filesize($File)) {
-            return '';
-        }
-
-        if (!is_resource($Handle = fopen($File, 'rb'))) {
-            return '';
-        }
-        $Data = fread($Handle, $Filesize);
-        fclose($Handle);
-        return $Data;
-    }
-
     /**
      * Read byte value configuration directives as byte values.
      *
@@ -915,7 +893,7 @@ public function substrAfterLast(string $Haystack, string $Needle): string
      * @param string $File The path and the name of the file to read.
      * @return string The file's content, or an empty string on failure.
      */
-    public function readFileContent(string $File): string
+    public function readFile(string $File): string
     {
         /** Guard. */
         if ($File === '' || !is_file($File) || !is_readable($File)) {
@@ -932,7 +910,7 @@ public function readFileContent(string $File): string
      * @param string $File The file to read.
      * @return string The file's content, or an empty string on failure.
      */
-    public function readFileContentGZ(string $File): string
+    public function readFileGZ(string $File): string
     {
         /** Guard. */
         if ($File === '' || !is_file($File) || !is_readable($File) || !$Filesize = filesize($File)) {

src/Scanner.php

@@ -934,7 +934,7 @@ private function recursor($Files = '', int $Depth = -1): void
         }
 
         /** Read in the file to be scanned. */
-        $In = $this->Loader->readFileContent($Files);
+        $In = $this->Loader->readFile($Files);
 
         /** Enforce scannable threshold. */
         if (
@@ -1837,7 +1837,7 @@ private function dataHandler(string $str = '', int $Depth = 0, string $OriginalF
                     continue;
                 }
                 if (!isset($this->Loader->InstanceCache[$SigFile])) {
-                    $this->Loader->InstanceCache[$SigFile] = $this->Loader->readFileContent($this->Loader->SignaturesPath . $SigFile);
+                    $this->Loader->InstanceCache[$SigFile] = $this->Loader->readFile($this->Loader->SignaturesPath . $SigFile);
                 }
 
                 /** Fire event: "beforeSigFile". */