Unique pages

README.md

@@ -52,6 +52,27 @@ php artisan migrate
 1. Go to **yourapp/admin/page** and see how it works.
 2. Define your own templates in app/PageTemplates.php using the Backpack\CRUD API.
 
+## Unique pages usage
+
+Unique pages are pages that exist only once. You can not create a second instance nor delete the current one. 
+**Only editing**
+
+Each unique page is defined like a page template in app/UniquePages.php using the backpack\CRUD API.
+It will be available for editing in the backend at  
+`< route_prefix >/unique/< page_function_slug >`
+
+For users to access the editing page for the page `about_us` you could add a menu item like so:
+(remember the url will use the slug of your function)
+
+```html
+<li><a href="{{ url(config('backpack.base.route_prefix').'/unique/about-us') }}"><i class="fa fa-file-o"></i> <span>Pages</span></a></li>
+```
+
+**Unique pages can easily use revisions**
+
+Be sure to subclass `Backpack\PageManager\app\Models\Page` and follow the docs on setting up revisions for your CRUD.
+After that just set the config value `unique_page_revisions` to `true`and you are ready to go.
+
 ## Example front-end
 
 No front-end is provided (Backpack only takes care of the admin panel), but for most projects this front-end code will be all you need:

src/PageManagerServiceProvider.php

@@ -33,6 +33,8 @@ public function boot()
         $this->publishes([__DIR__.'/resources/views' => base_path('resources/views')], 'views');
         // publish PageTemplates trait
         $this->publishes([__DIR__.'/app/PageTemplates.php' => app_path('PageTemplates.php')], 'trait');
+        // publish UniquePages trait
+        $this->publishes([__DIR__.'/app/UniquePages.php' => app_path('UniquePages.php')], 'trait');
         // publish migrations
         $this->publishes([__DIR__.'/database/migrations' => database_path('migrations')], 'migrations');
         // public config

src/app/Http/Controllers/Admin/PageCrudController.php

@@ -4,20 +4,24 @@
 
 use App\PageTemplates;
 // VALIDATION: change the requests to match your own file names if you need form validation
+use Backpack\PageManager\app\TraitReflections;
 use Backpack\CRUD\app\Http\Controllers\CrudController;
 use Backpack\PageManager\app\Http\Requests\PageRequest as StoreRequest;
 use Backpack\PageManager\app\Http\Requests\PageRequest as UpdateRequest;
 
 class PageCrudController extends CrudController
 {
     use PageTemplates;
+    use TraitReflections;
 
     public function setup($template_name = false)
     {
         parent::__construct();
 
         $modelClass = config('backpack.pagemanager.page_model_class', 'Backpack\PageManager\app\Models\Page');
 
+        $this->checkForTemplatesAndUniquePagesNotDistinct();
+
         /*
         |--------------------------------------------------------------------------
         | BASIC CRUD INFORMATION
@@ -27,6 +31,8 @@ public function setup($template_name = false)
         $this->crud->setRoute(config('backpack.base.route_prefix').'/page');
         $this->crud->setEntityNameStrings(trans('backpack::pagemanager.page'), trans('backpack::pagemanager.pages'));
 
+        $template_names = collect($this->getTemplates())->pluck('name');
+        $this->crud->addClause('whereIn', 'template', $template_names);
         /*
         |--------------------------------------------------------------------------
         | COLUMNS
@@ -179,23 +185,6 @@ public function useTemplate($template_name = false)
         }
     }
 
-    /**
-     * Get all defined templates.
-     */
-    public function getTemplates($template_name = false)
-    {
-        $templates_array = [];
-
-        $templates_trait = new \ReflectionClass('App\PageTemplates');
-        $templates = $templates_trait->getMethods(\ReflectionMethod::IS_PRIVATE);
-
-        if (! count($templates)) {
-            abort(503, trans('backpack::pagemanager.template_not_found'));
-        }
-
-        return $templates;
-    }
-
     /**
      * Get all defined template as an array.
      *

src/app/Http/Controllers/Admin/UniquePageCrudController.php

@@ -0,0 +1,190 @@
+<?php
+
+namespace Backpack\PageManager\app\Http\Controllers\Admin;
+
+use App\UniquePages;
+use Backpack\PageManager\app\TraitReflections;
+use Backpack\CRUD\app\Http\Controllers\CrudController;
+use Backpack\CRUD\app\Http\Controllers\CrudFeatures\SaveActions;
+
+class UniquePageCrudController extends CrudController
+{
+    use SaveActions;
+    use UniquePages;
+    use TraitReflections;
+
+    public function setup()
+    {
+        parent::__construct();
+
+        $modelClass = config('backpack.pagemanager.unique_page_model_class', 'Backpack\PageManager\app\Models\Page');
+
+        $this->checkForTemplatesAndUniquePagesNotDistinct();
+
+        /*
+        |--------------------------------------------------------------------------
+        | BASIC CRUD INFORMATION
+        |--------------------------------------------------------------------------
+        */
+        $this->crud->setModel($modelClass);
+        // don't set route or entity names here. these depend on the page you are editing
+
+        // unique pages can not be created nor deleted
+        $this->crud->denyAccess('create');
+        $this->crud->denyAccess('delete');
+
+        if (config('backpack.pagemanager.unique_page_revisions')) {
+            $this->crud->allowAccess('revisions');
+        }
+    }
+
+    /**
+     * As we want to edit pages by slug we need a new edit function.
+     *
+     * @param string $slug the page slug
+     * @return Response
+     */
+    public function uniqueEdit($slug)
+    {
+        $model = $this->crud->model;
+        $entry = $model::findBySlug($slug);
+
+        if (! $entry) {
+            $entry = $this->createMissingPage($slug);
+        }
+
+        $this->uniqueSetup($entry);
+
+        return parent::edit($entry->id);
+    }
+
+    public function update($slug, $id)
+    {
+        $this->setRoute($slug);
+
+        return parent::updateCrud();
+    }
+
+    public function setRoute($slug)
+    {
+        $this->crud->setRoute(config('backpack.base.route_prefix').'/unique/'.$slug);
+    }
+
+    /**
+     * Populate the update form with basic fields, that all pages need.
+     *
+     * @param Model $page the page entity
+     */
+    public function addDefaultPageFields($page)
+    {
+        $this->crud->addField([
+            'name' => 'template',
+            'type' => 'hidden',
+        ]);
+        $this->crud->addField([
+            'name' => 'name',
+            'type' => 'hidden',
+        ]);
+        $this->crud->addField([
+            'name' => 'title',
+            'type' => 'hidden',
+        ]);
+        $this->crud->addField([
+            'name' => 'slug',
+            'type' => 'hidden',
+        ]);
+
+        $this->crud->addField([
+            'name' => 'open',
+            'type' => 'custom_html',
+            'value' => $this->buttons($page),
+        ]);
+    }
+
+    public function buttons($page)
+    {
+        $openButton = $page->getOpenButton();
+        $revisionsButton = view('crud::buttons.revisions', ['crud' => $this->crud, 'entry' => $page]);
+
+        return $openButton.' '.$revisionsButton;
+    }
+
+    public function createMissingPage($slug)
+    {
+        $pages = collect($this->getUniquePages());
+
+        $slugs = $pages->mapWithKeys(function ($page) {
+            return [str_slug($page->name) => $page->name];
+        });
+
+        if (! $page = $slugs->pull($slug)) {
+            abort(404);
+        }
+
+        $model = $this->crud->model;
+
+        return $model::create([
+            'template' => $page,
+            'name' => camel_case($page),
+            'title' => camel_case($page),
+            'slug' => $slug,
+        ]);
+    }
+
+    public function uniqueRevisions($slug, $id)
+    {
+        $model = $this->crud->model;
+        $entry = $model::findBySlugOrFail($slug);
+
+        $this->uniqueSetup($entry);
+
+        return parent::listRevisions($entry->id);
+    }
+
+    public function restoreUniqueRevision($slug, $id)
+    {
+        $model = $this->crud->model;
+        $entry = $model::findBySlugOrFail($slug);
+
+        $this->uniqueSetup($entry);
+
+        return parent::restoreRevision($id);
+    }
+
+    protected function uniqueSetup($entry)
+    {
+        $this->setRoute($entry->slug);
+
+        $this->addDefaultPageFields($entry);
+        $this->crud->setEntityNameStrings($this->crud->makeLabel($entry->template), '');
+
+        $this->{$entry->template}();
+    }
+
+    /*
+    |--------------------------------------------------------------------------
+    | SaveActions overrides
+    |--------------------------------------------------------------------------
+    */
+
+    /**
+     * Overrides trait version to remove.
+     */
+    public function getSaveAction()
+    {
+        $saveCurrent = [
+            'value' => $this->getSaveActionButtonName('save_and_back'),
+            'label' => $this->getSaveActionButtonName('save_and_back'),
+        ];
+
+        return [
+            'active' => $saveCurrent,
+            'options' => [],
+        ];
+    }
+
+    public function setSaveAction($forceSaveAction = null)
+    {
+        // do nothing to preserve session value for other crud
+    }
+}

src/app/PageTemplates.php

@@ -58,14 +58,4 @@ private function services()
                         'placeholder' => trans('backpack::pagemanager.content_placeholder'),
                     ]);
     }
-
-    private function about_us()
-    {
-        $this->crud->addField([
-                        'name' => 'content',
-                        'label' => trans('backpack::pagemanager.content'),
-                        'type' => 'wysiwyg',
-                        'placeholder' => trans('backpack::pagemanager.content_placeholder'),
-                    ]);
-    }
 }

src/app/TraitReflections.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Backpack\PageManager\app;
+
+trait TraitReflections
+{
+    public function checkForTemplatesAndUniquePagesNotDistinct()
+    {
+        if (config('backpack.pagemanager.page_model_class') != config('backpack.pagemanager.unique_page_model_class')) {
+            return;
+        }
+
+        $uniquePages = collect($this->getUniquePages())->pluck('name');
+        $templates = collect($this->getTemplates())->pluck('name');
+
+        if ($uniquePages->intersect($templates)->isNotEmpty()) {
+            throw new \Exception('Templates and unique pages should not have the same function names when same model class is used.');
+        }
+    }
+
+    /**
+     * Get all defined unique pages.
+     */
+    public function getUniquePages()
+    {
+        $pages_trait = new \ReflectionClass('App\UniquePages');
+        $pages = $pages_trait->getMethods(\ReflectionMethod::IS_PRIVATE);
+
+        return $pages;
+    }
+
+    /**
+     * Get all defined templates.
+     */
+    public function getTemplates($template_name = false)
+    {
+        $templates_array = [];
+
+        $templates_trait = new \ReflectionClass('App\PageTemplates');
+        $templates = $templates_trait->getMethods(\ReflectionMethod::IS_PRIVATE);
+
+        if (! count($templates)) {
+            abort(503, trans('backpack::pagemanager.template_not_found'));
+        }
+
+        return $templates;
+    }
+}

src/app/UniquePages.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace App;
+
+trait UniquePages
+{
+    /*
+    |--------------------------------------------------------------------------
+    | Unique pages for Backpack\PageManager
+    |--------------------------------------------------------------------------
+    |
+    | Each unique page has its own method, that define what fields should show up using the Backpack\CRUD API.
+    | Use snake_case for naming and PageManager will generate the page on first edit
+    |
+    | Any fields defined here will show up after the standard page fields:
+    | - select template (hidden and fix)
+    | - page name (only seen by admins) (hidden and fix)
+    | - page title
+    | - page slug (hidden and fix, slug of method name)
+    */
+
+    private function about_us()
+    {
+        $this->crud->addField([
+            'name' => 'content',
+            'label' => trans('backpack::pagemanager.content'),
+            'type' => 'wysiwyg',
+            'placeholder' => trans('backpack::pagemanager.content_placeholder'),
+        ]);
+    }
+}