[FEATURE] ✨ Enable method chaining

Refactor all methods to enable fluent interfaces.

Author: pixelbrackets

README.md

@@ -73,13 +73,13 @@ Mirror https://github.com/pixelbrackets/html5-mini-template
    file_put_contents('/var/www/example/index.html', $template->getMarkup());
    ```
 
-1. Wrap a message, set a custom stylesheet URL,
-   set a title, output the document
+1. Wrap a message, set your own stylesheet URL, set a title,
+   output the document
    ```php
-   $template = new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate();
-   $template->setStylesheet('/assets/styles.css');
-   $template->setTitle('Index');
-   $template->setContent('<h1>TOC</h1><ul><li>a</li><li>b</li></ul>');
+   $template = (new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate())
+       ->setStylesheet('/assets/styles.css')
+       ->setTitle('Index')
+       ->setContent('<h1>TOC</h1><ul><li>a</li><li>b</li></ul>');
    echo $template->getMarkup();
    ```
 

src/Html5MiniTemplate.php

@@ -139,11 +139,12 @@ public static function getTemplate()
      * Set title
      *
      * @param string $title Set document title, description and header
-     * @return void
+     * @return Html5MiniTemplate
      */
     public function setTitle($title)
     {
         $this->title = $title;
+        return $this;
     }
 
     /**
@@ -168,11 +169,12 @@ protected function getTitle()
      * @param string $stylesheet Use keywords for one of the preselected stylesheets
      * (see $listOfStylesheets, eg. »skeleton«), an empty string to remove the
      * style tag or the URL to any other existing stylesheet (eg. »/styles.css«)
-     * @return void
+     * @return Html5MiniTemplate
      */
     public function setStylesheet($stylesheet)
     {
         $this->stylesheet = $stylesheet;
+        return $this;
     }
 
     /**
@@ -185,11 +187,12 @@ public function setStylesheet($stylesheet)
      * its content rendered inline in a STYLE-tag.
      *
      * @param string $mode Set render mode, either Html5MiniTemplate::STYLE_LINK or Html5MiniTemplate::STYLE_INLINE
-     * @return void
+     * @return Html5MiniTemplate
      */
     public function setStylesheetMode($mode)
     {
         $this->stylesheetMode = $mode;
+        return $this;
     }
 
     /**
@@ -233,21 +236,23 @@ protected function getStylesheetContent()
      * Set any additional metadata like metatags or link references.
      *
      * @param string $metadata Additional metadata for document head
-     * @return void
+     * @return Html5MiniTemplate
      */
     public function setAdditionalMetadata($metadata)
     {
         $this->additionalMetadata = $metadata;
+        return $this;
     }
 
     /**
      * Set markup for document body
      *
      * @param string $text Markup for document body
-     * @return void
+     * @return Html5MiniTemplate
      */
     public function setContent($text)
     {
         $this->content = $text;
+        return $this;
     }
 }

tests/status-page.php

@@ -2,7 +2,13 @@
 
 require __DIR__ . '/../vendor/autoload.php';
 
-$template = new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate();
-$template->setStylesheet('skeleton');
-$template->setContent('<h1>Status</h1><p>All Systems Operational</p>');
-echo $template->getMarkup();
+//$template = new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate();
+//$template->setStylesheet('skeleton');
+//$template->setContent('<h1>Status</h1><p>All Systems Operational</p>');
+//echo $template->getMarkup();
+
+$markup = (new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate())
+    ->setStylesheet('skeleton')
+    ->setContent('<h1>Status</h1><p>All Systems Operational</p>')
+    ->getMarkup();
+echo $markup;

tests/unit/Html5MiniTemplateTest.php

@@ -121,4 +121,15 @@ public function testAdditionalMetadata()
         $document = $template->getMarkup();
         $this->assertStringContainsString('canonical', $document);
     }
+
+    public function testFluentInterface()
+    {
+        $document = (new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate())
+            ->setStylesheet('/style.css')
+            ->setContent('Hello World')
+            ->setTitle('Index')
+            ->setAdditionalMetadata('<link rel="canonical" href="https://html5example.com/">')
+            ->getMarkup();
+        $this->assertNotEmpty($document);
+    }
 }