FEATURE: prepare widget for displaying menu on onepage templates

templates/Base/OnePage/Handlers/OnePage.php

@@ -33,13 +33,12 @@ abstract class OnePage implements TemplateHandler
     }
 
     /**
-     * Prepare Content object to be rendered using Blade template
+     * Getter for pages displayed on homepage
      *
-     * @param Content $content
+     * @return array
      */
-    public static function beforeRender(Content & $content)
+    public static function getPagesOnHomepage()
     {
-        if ($content->is_homepage) {
         $pageIds = (array)json_decode(Settings::get(self::HOMEPAGE_PAGES_SETTINGS_KEY, '[]'));
 
         if (empty($pageIds)) {
@@ -55,7 +54,20 @@ abstract class OnePage implements TemplateHandler
             $pages = $pages->where('status', Content::STATUS_PUBLIC);
         }
 
-            $pages = $pages->get();
+        return $pages->get();
+    }
+
+    /**
+     * Prepare Content object to be rendered using Blade template
+     *
+     * @param Content $content
+     *
+     * @return array
+     */
+    public static function beforeRender(Content & $content)
+    {
+        if ($content->is_homepage) {
+            $pages = self::getPagesOnHomepage();
 
             // create real content from pages
             $pagesRaw = $pagesInTemplates = [];

templates/Base/OnePage/Providers/OnePageTemplate.php

@@ -2,6 +2,7 @@
 namespace Templates\Base\OnePage\Providers;
 
 use Illuminate\Support\ServiceProvider;
+use Templates\Base\OnePage\Widgets\OnePageMenu\OnePageMenu;
 
 class OnePageTemplate extends ServiceProvider
 {
@@ -11,20 +12,46 @@ class OnePageTemplate extends ServiceProvider
      * @return void
      */
     public function register()
-    {
+    {        $this->registerTranslations();
     }
 
     public function boot()
     {
-        // register translations
+        $this->registerViews();
-        $this->loadTranslationsFrom(__DIR__ . '/../Resources/lang', 'template');
+        $this->registerWidgets();
-
-        // load views
-        $this->loadViewsFrom(array_merge(array_map(function ($path) {
-            return $path;
-        }, \Config::get('view.paths')), [__DIR__ . '/../Resources/views']), 'template');
 
         // register event service provider for this template
         $this->app->register(EventProvider::class);
     }
+
+    /**
+     * Register translations used in this base template
+     */
+    private function registerTranslations()
+    {
+        // register translations
+        $this->loadTranslationsFrom(__DIR__ . '/../Resources/lang', 'template');
+    }
+
+    /**
+     * Register views used in this template - both visitor's and admin's
+     */
+    private function registerViews()
+    {
+        // load views
+        $this->loadViewsFrom(array_merge(array_map(function ($path) {
+            return $path;
+        }, \Config::get('view.paths')), [__DIR__ . '/../Resources/views']), 'template');
+    }
+
+    /**
+     * Register all widgets related to this template
+     */
+    private function registerWidgets()
+    {
+        $registrator = $this->app->make('registerWidget');
+
+        // register all available widgets
+        $registrator->register(OnePageMenu::class);
+    }
 }

templates/Base/OnePage/Resources/lang/en/widget/menu.php

@@ -0,0 +1,12 @@
+<?php
+return [
+    'name'        => 'One page menu',
+    'description' => 'Simple menu used for one page templates. This menu navigates using nachor links on page. Links are generated automatically using list of pages on homepage.',
+    'new'         => 'Create new menu',
+    'form'        => [
+        'name'           => 'Menu name',
+        'description'    => 'Description',
+        'containerClass' => 'HTML class for container element',
+        'save'           => 'Save',
+    ]
+];

templates/Base/OnePage/Resources/views/admin/widgets/onePageMenu/edit.blade.php

@@ -0,0 +1,15 @@
+@extends('admin.layoutWithNavigation')
+
+@section('pageHeading', @trans('widgets/htmlCode.edit', ['name' => $widget->name]))
+
+@section('content')
+    <div class="col-lg-8">
+        @include('admin.widgets.htmlCode.form', ['action' => route('widgets.postEdit', ['id' => $widget->id])])
+    </div>
+    <div class="col-lg-4">
+        <h3>@lang('widgets/htmlCode.preview')</h3>
+
+        @widgetPreview($widget)
+    </div>
+@stop
+

templates/Base/OnePage/Resources/views/admin/widgets/onePageMenu/form.blade.php

@@ -0,0 +1,27 @@
+<form action="{{$action}}" method="POST">
+    {!! csrf_field() !!}
+    <label class="label-control">
+        @lang('template::widget/menu.form.name')
+    </label>
+    <input class="form-control" type="text" name="name" value="{{old('name', $widget->name)}}"
+           placeholder="@lang('template::widget/menu.form.name')" />
+
+
+    <label class="label-control">
+        @lang('template::widget/menu.form.description')
+    </label>
+    <input class="form-control" type="text" name="description" placeholder="@lang('template::widget/menu.form.description')"
+           value="{{old('description', $widget->description)}}" />
+
+
+    <label class="label-control">
+        @lang('template::widget/menu.form.containerClass')
+    </label>
+
+    <input class="form-control" type="text" name="containerClass" placeholder="@lang('template::widget/menu.form.containerClass')"
+           value="{{old('containerClass', isset($settings->containerClass) ? $settings->containerClass : '')}}" />
+
+    <button type="submit" class="btn btn-primary">
+        @lang('template::widget/menu.form.save')
+    </button>
+</form>

templates/Base/OnePage/Resources/views/admin/widgets/onePageMenu/new.blade.php

@@ -0,0 +1,9 @@
+@extends('admin.layoutWithNavigation')
+
+@section('pageHeading', @trans('template::widget/menu.new'))
+@section('pageDescription', @trans($type->description))
+
+@section('content')
+    @include('template::admin.widgets.onePageMenu.form', ['action' => route('widgets.postNew', ['type' => $type->id])])
+@stop
+

templates/Base/OnePage/Widgets/OnePageMenu/OnePageMenu.php

@@ -0,0 +1,55 @@
+<?php
+namespace Templates\Base\OnePage\Widgets\OnePageMenu;
+
+use App\Models\Widget;
+use App\Widgets\Contracts\WidgetRenderer;
+use App\Widgets\NonInstallableWidget;
+use stdClass;
+
+class OnePageMenu extends NonInstallableWidget
+{
+    /**
+     * Name getter
+     *
+     * @return string
+     */
+    public static function getName()
+    {
+        return 'template::widget/menu.name';
+    }
+
+    /**
+     * Getter for description
+     *
+     * @return string
+     */
+    public static function getDescription()
+    {
+        return 'template::widget/menu.description';
+    }
+
+    /**
+     * Getter for presenter/renderer of this widget
+     *
+     * @return WidgetRenderer
+     */
+    public static function getPresenter()
+    {
+        return Presenter::class;
+    }
+
+    /**
+     * @param Widget $widget
+     * @param stdClass          $data
+     *
+     * @return mixed
+     */
+    public static function save(Widget $widget, stdClass $data)
+    {
+        $widgetSettings = ['containerClass' => isset($data->containerClass) ? $data->containerClass : ''];
+
+        $widget->settings = json_encode($widgetSettings);
+
+        return $widget;
+    }
+}

templates/Base/OnePage/Widgets/OnePageMenu/Presenter.php

@@ -0,0 +1,65 @@
+<?php
+namespace Templates\Base\OnePage\Widgets\OnePageMenu;
+
+use App\Models\Widget;
+use App\Models\WidgetType;
+use App\Widgets\Contracts\WidgetRenderer;
+use Templates\Base\OnePage\Handlers\OnePage;
+
+class Presenter implements WidgetRenderer
+{
+    /**
+     * @var string path to template
+     */
+    public static $template;
+
+    /**
+     * Method used for displaying widget.
+     *
+     * This method renders some HTML code for displaying.
+     *
+     * @param object $settings
+     *
+     * @return mixed
+     * @throws \ErrorException
+     */
+    public static function render($settings)
+    {
+        if (!self::$template) {
+            throw new \ErrorException('Cannot render menu without template! Please, set Presenter::$template variable before rendering.');
+        }
+
+        $pages = OnePage::getPagesOnHomepage();
+
+        return view(self::$template, ['pages' => $pages])->render();
+    }
+
+    /**
+     * Display form for creating new instance of widget
+     *
+     * @param WidgetType $type
+     *
+     * @return mixed
+     */
+    public static function renderAddForm(WidgetType $type)
+    {
+        return view('template::admin.widgets.onePageMenu.new', [
+            'type'     => $type,
+            'widget'   => new Widget(),
+            'settings' => new \stdClass()
+        ]);
+    }
+
+    /**
+     * Display form for editing already existing widget
+     *
+     * @param Widget $widget
+     *
+     * @return mixed
+     */
+    public static function renderEditForm(Widget $widget)
+    {
+        $settings = json_decode($widget->settings);
+        return view('template::admin.widgets.onePageMenu.edit', ['widget' => $widget, 'settings' => $settings]);
+    }
+}