[FEATURE] ♻️ Codestyle: Catch unexpected return types

pixelbrackets · pixelbrackets · commit 05a19796505b · 2022-11-10T12:15:07.000+01:00
»file_get_contents« is used several times to fetch content
expected as string, but may return false instead.
This should never happen here, but the mere possibility
collides with the return type of the methods.

Wrap the function with some error handlers
to avoid this ambiguity.

Refs #8
diff --git a/src/Html5MiniTemplate.php b/src/Html5MiniTemplate.php
@@ -74,7 +74,7 @@ class Html5MiniTemplate
      */
     public function __construct()
     {
-        $this->markup = file_get_contents(__DIR__ . '/../resources/template.html');
+        $this->markup = $this->getFileContent(__DIR__ . '/../resources/template.html');
     }
 
     /**
@@ -87,7 +87,7 @@ protected function parseMarkup()
         $markup = $this->markup;
         $content = $this->content;
 
-        // no message set = early return example template
+        // No message set = early return example template
         if ($content === null) {
             return self::getTemplate();
         }
@@ -113,11 +113,27 @@ protected function parseMarkup()
         $markup = preg_replace('/<\/head>/', $this->additionalMetadata . '</head>', $markup);
 
         // Content
+        /** @var string $markup */
         $markup = preg_replace('/<body>(.*?)<\/body>/is', '<body>' . $content . '</body>', $markup);
 
+        // That's it
         return $markup;
     }
 
+    /**
+     * Wrap file_get_contents function and throw errors if needed
+     *
+     * @param string $file File-URI to read its content from
+     * @return string
+     */
+    protected function getFileContent(string $file): string
+    {
+        if (($content = file_get_contents($file)) === false) {
+            throw new \RuntimeException('Can not access file to read its content');
+        }
+        return $content;
+    }
+
     /**
      * Get markup of HTML5 document
      *
@@ -135,7 +151,11 @@ public function getMarkup()
      */
     public static function getTemplate()
     {
-        return file_get_contents(__DIR__ . '/../resources/template.html');
+        if (($content = file_get_contents(__DIR__ . '/../resources/template.html')) === false) {
+            throw new \RuntimeException('Can not access file to read its content');
+        }
+        return $content;
+
     }
 
     /**
@@ -209,23 +229,23 @@ protected function getStylesheetUrl()
     }
 
     /**
-     * Get stylesheet content
+     * Get stylesheet content and cache it in filesystem
      *
      * @return string
      */
     protected function getStylesheetContent()
     {
         $stylesheetUrl = $this->getStylesheetUrl();
 
-        // try to get a cached version first
+        // Try to get a cached version first
         $cachefile = sys_get_temp_dir() . '/' . md5($stylesheetUrl) . '.css';
         if (file_exists($cachefile) && (filemtime($cachefile) > (time() - 86400))) { // 1 day
-            return file_get_contents($cachefile);
+            return $this->getFileContent($cachefile);
         }
 
         try {
-            $stylesheetContent = file_get_contents($stylesheetUrl) ?: '';
-            // try to cache the file
+            $stylesheetContent = $this->getFileContent($stylesheetUrl) ?: '';
+            // Cache the file
             file_put_contents($cachefile, $stylesheetContent, LOCK_EX);
         } catch (\Exception $e) {
             // Catch exception if resource is not reachable
