Merge branch 'hotfix/177' into develop

weierophinney · weierophinney · commit 1139df96079a · 2018-12-06T17:21:56.000-06:00
Forward port #177
diff --git a/doc/book/helpers/intro.md b/doc/book/helpers/intro.md
@@ -71,6 +71,7 @@ for, and rendering, the various HTML `<head>` tags, such as `HeadTitle`,
 - [Identity](identity.md)
 - [InlineScript](inline-script.md)
 - [JSON](json.md)
+- [Layout](layout.md)
 - [Partial](partial.md)
 - [Placeholder](placeholder.md)
 - [Url](url.md)
diff --git a/doc/book/helpers/layout.md b/doc/book/helpers/layout.md
@@ -0,0 +1,60 @@
+# Layout
+
+The `Layout` helper is used to get and set the template for the layout or to 
+retrieving the root view model.
+
+## Basic Usage
+
+### Change the Layout Template
+
+If you're running a zend-mvc application then the layout template is set in the
+configuration for the [`ViewManager`](https://docs.zendframework.com/zend-mvc/services/#viewmanager).
+
+To change the layout template within a view script, call:
+
+```php
+$this->layout('layout/backend');
+```
+
+Or use the `setTemplate` method:
+
+```php
+$this->layout()->setTemplate('layout/backend');
+```
+
+### Set View Variable on Layout Model
+
+The `Layout` helper can also retrieve the view model for the layout (root): 
+
+```php
+/** @var \Zend\View\Model\ViewModel $rootViewModel */
+$rootViewModel = $this->layout();
+```
+
+This offers the possibility to set variables for the layout script.
+
+#### Set a Single Variable
+
+```php
+$this->layout()->setVariable('infoText', 'Some text for later');
+```
+
+Use in your layout script:
+
+```php
+if (isset($infoText)) {
+    echo $infoText;
+}
+```
+
+#### Set a Set of Variables
+
+```php
+$this->layout()->setVariables([
+    'headerText' => '…',
+    'footerText' => '…',
+]);
+```
+
+More informations related to view models can be found in the
+[quick start](https://docs.zendframework.com/zend-view/quick-start/).
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -25,6 +25,7 @@ pages:
         - Identity: helpers/identity.md
         - InlineScript: helpers/inline-script.md
         - Json: helpers/json.md
+        - Layout: helpers/layout.md
         - Partial: helpers/partial.md
         - Placeholder: helpers/placeholder.md
         - Url: helpers/url.md
