[FEATURE] ✨ Add static method to fetch example template

Add a static method to get the example template.

- No need to create the object
- Preparation to solve the bug that example styles
  are set by default

Author: pixelbrackets

README.md

@@ -13,27 +13,31 @@ status pages, TOC pages, or any other minimal single-serving site.
 
 ## Vision
 
-This package provides a single class to turn a text or HTML-snippet into a valid
-HTML5 document.
+This package provides a single class to turn a message or HTML-snippet into
+a valid HTML5 document.
 
 This way it is possible to let an app return an HTML response without the need
 to store a template file beforehand or initialize a full-blown template engine.
 
-The package therefore does not have template variables, modifiers or parsers.
-Three lines of code should be sufficient to wrap a given message into a valid
-HTML document. See [»Usage«](#usage) for some examples.
+The package therefore does not have template variables or modifiers.
+Two lines of code should be sufficient to wrap a given text into a valid
+HTML document. One more to add a link to fancy stylesheet.
+
+See [»Usage«](#usage) for some examples.
 
 The package follows the KISS principle.
 
 ## Webapp
 
 This package is used on [html5example.com](https://html5example.com/).
 
-If you are in need of an HTML document once only, then use a commandline tool
-like HTTPie and run `http https://html5example.com > index.html`.
+If you are in need of an HTML document once only, then you may use a 
+commandline tool like HTTPie and run
+`http https://html5example.com > index.html` to save a template file.
 
 The webapp supports some [options](#options) of this package as well,
-for example `http POST https://html5example.com title=Minimal-Template > index.html`
+for example
+`http POST https://html5example.com title=Minimal-Template > index.html`
 to pass a custom title.
 
 ## Requirements
@@ -48,29 +52,42 @@ Packagist Entry https://packagist.org/packages/pixelbrackets/html5-mini-template
 
 https://gitlab.com/pixelbrackets/html5-mini-template/
 
+Mirror https://github.com/pixelbrackets/html5-mini-template
+
 ## Usage
 
-1. Get the example template
+1. Wrap a message into a HTML5 document, return to a PSR-7 implementation
    ```php
-   $document = (new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate())->getMarkup();
+   $template = new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate();
+   $template->setContent('<h1>Status</h1><p>All Systems Operational</p>');
+   return $template->getMarkup();
    ```
 
-1. Get template with custom content and write to file
+1. Wrap a message, use a preconfigured CSS framework CDN
+   (see [»options«](#options) for a list of supported frameworks),
+   and save the document into a file
    ```php
    $template = new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate();
+   $template->setStylesheet('skeleton');
    $template->setContent('<h1>Index</h1><p>Nothing to see here</p>');
    file_put_contents('/var/www/example/index.html', $template->getMarkup());
    ```
 
-1. Get template with custom content, an external link to a CSS framework
-   output the document as response
+1. Wrap a message, set a custom stylesheet URL,
+   set a title, output the document
    ```php
    $template = new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate();
-   $template->setStylesheet('skeleton');
-   $template->setContent('<h1>Status</h1><p>All Systems Operational</p>');
+   $template->setStylesheet('/assets/styles.css');
+   $template->setTitle('Index');
+   $template->setContent('<h1>TOC</h1><ul><li>a</li><li>b</li></ul>');
    echo $template->getMarkup();
    ```
 
+1. Get the example template only (👉 or use the [Webapp](#webapp))
+   ```php
+   echo \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate::getTemplate();
+   ```
+
 ### Options
 
 - `setContent()` the message to show, any HTML string to replace the main
@@ -90,9 +107,12 @@ https://gitlab.com/pixelbrackets/html5-mini-template/
 - `setTitle()` the title is the first headline found in the document, unless
   it is overwritten with this option
 - `setAdditionalMetadata()` any additional metadata like metatags or link
-  references, for example a canonical link to avoid duplicate content - Usage
-  of this option is an indicator that the given use case is too specific and
-  switching to a template engine should be considered
+  references, for example a canonical link to avoid duplicate content
+  - ⚠️ Usage of this option is an indicator that the given use case is too
+    specific and switching to a template engine like the minimal
+    [slim/php-view](https://packagist.org/packages/slim/php-view) or the
+    powerfull [twig/twig](https://packagist.org/packages/twig/twig)
+    should be considered
 
 ## License
 

src/Html5MiniTemplate.php

@@ -67,7 +67,7 @@ class Html5MiniTemplate
     /**
      * Mini Template
      *
-     * @return string
+     * @return void
      */
     public function __construct()
     {
@@ -118,6 +118,16 @@ public function getMarkup()
         return $this->parseMarkup();
     }
 
+    /**
+     * Get example template
+     *
+     * @return string
+     */
+    public static function getTemplate()
+    {
+        return file_get_contents(__DIR__ . '/../resources/template.html');
+    }
+
     /**
      * Set title
      *
@@ -195,7 +205,7 @@ protected function getStylesheetContent()
         $stylesheetUrl = $this->getStylesheetUrl();
 
         // try to get a cached version first
-        $cachefile = sys_get_temp_dir(). '/' . md5($stylesheetUrl) . '.css';
+        $cachefile = sys_get_temp_dir() . '/' . md5($stylesheetUrl) . '.css';
         if (file_exists($cachefile) && (filemtime($cachefile) > (time() - 86400))) { // 1 day
             return file_get_contents($cachefile);
         }

tests/example-page.php

@@ -2,4 +2,7 @@
 
 require __DIR__ . '/../vendor/autoload.php';
 
-echo (new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate())->getMarkup();
+echo \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate::getTemplate();
+
+// same as
+//   echo (new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate())->getMarkup();

tests/unit/Html5MiniTemplateTest.php

@@ -7,9 +7,8 @@ class Html5MiniTemplateTest extends TestCase
 {
     public function testExampleTemplate()
     {
-        $template = new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate();
+        $document = \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate::getTemplate();
 
-        $document = $template->getMarkup();
         $this->assertNotEmpty($document);
         $this->assertStringContainsString('<!DOCTYPE html>', $document);
         $this->assertStringContainsString('<h1>HTML5 Example Page</h1>', $document);