Added ChildPages component

Author: Luke Towers

Plugin.php

@@ -27,6 +27,7 @@ public function pluginDetails()
     public function registerComponents()
     {
         return [
+            '\RainLab\Pages\Components\ChildPages' => 'childPages',
             '\RainLab\Pages\Components\StaticPage' => 'staticPage',
             '\RainLab\Pages\Components\StaticMenu' => 'staticMenu',
             '\RainLab\Pages\Components\StaticBreadcrumbs' => 'staticBreadcrumbs'

components/ChildPages.php

@@ -0,0 +1,60 @@
+<?php namespace RainLab\Pages\Components;
+
+use Cms\Classes\ComponentBase;
+
+class ChildPages extends ComponentBase
+{
+    /**
+     * @var \RainLab\Pages\Components\StaticPage A reference to the static page component
+     */
+    protected $staticPageComponent;
+
+    /**
+     * @var array Array of \RainLab\Pages\Classes\Page references to the child static page objects for the current page
+     */
+    protected $childPages;
+
+    /**
+     * @var array Child pages data
+     * [
+     *      'url' => '',
+     *      'title' => '',
+     *      'page' => \RainLab\Pages\Classes\Page,
+     *      'viewBag' => array,
+     *      'is_hidden' => bool,
+     *      'navigation_hidden' => bool,
+     * ]
+     */
+    public $pages = [];
+
+    public function componentDetails()
+    {
+        return [
+            'name'        => 'rainlab.pages::lang.component.child_pages_name',
+            'description' => 'rainlab.pages::lang.component.child_pages_description'
+        ];
+    }
+
+    public function onRun()
+    {
+        // Check if the staticPage component is attached to the rendering template
+        $this->staticPageComponent = $this->findComponentByName('staticPage');
+        if ($this->staticPageComponent->pageObject) {
+            $this->childPages = $this->staticPageComponent->pageObject->getChildren();
+
+            if ($this->childPages) {
+                foreach ($this->childPages as $childPage) {
+                    $viewBag = $childPage->settings['components']['viewBag'];
+                    $this->pages = array_merge($this->pages, [[
+                        'url'                => @$viewBag['url'],
+                        'title'              => @$viewBag['title'],
+                        'page'               => $childPage,
+                        'viewBag'            => $viewBag,
+                        'is_hidden'          => @$viewBag['is_hidden'],
+                        'navigation_hidden'  => @$viewBag['navigation_hidden'],
+                    ]]);
+                }
+            }
+        }
+    }
+}

components/childpages/default.htm

@@ -0,0 +1,9 @@
+{% if __SELF__.pages is not empty %}
+    <ul>
+        {% for page in __SELF__.pages %}
+            <li>
+                <a href="{{ page.url | app }}">{{ page.title }}</a>
+            </li>
+        {% endfor %}
+    </ul>
+{% endif %}

docs/component-childpages.md

@@ -0,0 +1,35 @@
+# Component: Child Pages (childPages)
+
+## Purpose
+Outputs a list of child pages of the current page
+
+## Default output
+
+The default component partial outputs a simple nested unordered list:
+
+```html
+<ul>
+    <li>
+        <a href="{{ page.url | app }}">{{ page.title }}</a>
+    </li>
+</ul>
+```
+
+You might want to render the list with your own code. The `childPages.pages` variable is an array of arrays representing the child pages. Each of the arrays has the following items:
+
+Property | Type | Description
+-------- | ---- | -----------
+`url` | `string` | The relative URL for the page (use `{{ url | app }}` to get the absolute URL)
+`title` | `string` | Page title
+`page` | `RainLab\Pages\Classes\Page` | The page object itself
+`viewBag` | `array` | Contains all the extra data used by the page
+`is_hidden` | `bool` | Whether the page is hidden (only accessible to backend users)
+`navigation_hidden` | `bool` | Whether the page is hidden in automaticaly generated contexts (i.e menu)
+
+## Example of custom markup for component
+
+```html
+{% for page in childPages.pages %}
+    <li><a href="{{ page.url | app }}">{{ page.title }}</a></li>
+{% endfor %}
+```

lang/en/lang.php

@@ -137,5 +137,7 @@
         'static_menu_code_description' => 'Specify a code of the menu the component should output.',
         'static_breadcrumbs_name' => 'Static breadcrumbs',
         'static_breadcrumbs_description' => 'Outputs breadcrumbs for a static page.',
+        'child_pages_name' => 'Child pages',
+        'child_pages_description' => 'Displays a list of child pages for the current page',
     ]
 ];