FEATURE: change directory structure

app/CMS/Contracts/AppHandler.php

@@ -0,0 +1,97 @@
+<?php
+namespace App\CMS\Handlers\Contracts;
+
+use App\Http\Requests\Request;
+use App\Models\Content\Content;
+
+interface AppHandler extends BaseModuleHandler
+{
+    /**
+     * Render given module into visitor area.
+     *
+     * @param Content $content    DB model from table contents
+     * @param array   $parameters parameters used for modifications/custom settings of given model
+     *
+     * @return mixed
+     */
+    public function render(Content $content, $parameters);
+
+    public static function getHistoryHandler();
+
+    /**
+     * Load some extra data for content management form?
+     *
+     * @param Content $content
+     *
+     * @return mixed
+     */
+    public static function loadExtraData(Content $content);
+
+    /**
+     * Save module-specific values into database
+     *
+     * @param Content $content
+     * @param Request $request
+     *
+     * @return mixed
+     * @internal param Widget $widget
+     */
+    public static function createNew(Content &$content, Request $request);
+
+    /**
+     * Method used for editing existing content page.
+     *
+     * Reason why it is separated from createNew() method is simple - we need to save history of changes.
+     *
+     * @param Content $content
+     * @param Request $request
+     *
+     * @param         $revisionID string ID of revision used
+     *
+     * @return int number of edited fields
+     */
+    public static function edit(Content &$content, Request $request, $revisionID);
+
+    /**
+     * Method called right after content page is marked as deleted
+     *
+     * This method is supposed to clean after "deleted" page.
+     *
+     * @param Content $content
+     *
+     * @return mixed
+     */
+    public static function delete(Content $content);
+
+    /**
+     * Getter for section names in creating/editing content resource
+     *
+     * @return mixed
+     */
+    public static function getExtendedFormSections();
+
+    /**
+     * Getter for views used in extended part of form for creating new content
+     *
+     * This method should return pairs <section, view-name>. View is returned only as name in plain text
+     *
+     * @return array of views/templates/html codes divided into section
+     */
+    public static function getExtendedFormInputsCreate();
+
+    /**
+     * Getter for extended part of form for editing existing content
+     *
+     * Basically, this method may be
+     *
+     * @return array of views/templates/html codes divided into section
+     */
+    public static function getExtendedFormInputsEdit();
+
+    /**
+     * Does this module support categories?
+     *
+     * @return boolean
+     */
+    public static function supportCategories();
+}

app/CMS/Contracts/BaseModuleHandler.php

@@ -0,0 +1,25 @@
+<?php
+namespace App\CMS\Handlers\Contracts;
+
+use App\Models\User;
+
+interface BaseModuleHandler
+{
+    /**
+     * Register admin menu (or multiple ones)
+     *
+     * This cannot be in ServiceProvider because Session is started at middleware. And ServiceProvider is called before
+     * starting any middleware..
+     *
+     * @param User $user model of logged user
+     */
+    public static function registerAdminMenu(User $user);
+
+    /**
+     * Install module.
+     *
+     * This method is called after inserting info about module into database. It can be called only using Artisan in
+     * CLI.
+     */
+    public static function install();
+}

app/CMS/Contracts/Content/ContentTitles.php

@@ -0,0 +1,40 @@
+<?php
+namespace App\CMS\Handlers\Contracts;
+
+use App\Models\Content\Content;
+
+/**
+ * Interface ContentTitles
+ *
+ * Classes which implement this interface get the ability to rewrite default text on edit/create/overview of content
+ * page.
+ *
+ * @package App\CMS\Handlers\Contracts
+ */
+interface ContentTitles
+{
+    /**
+     * Get translated title for pages overview of given type.
+     *
+     * This value is used for rendering list of all content pages of given type in administration.
+     *
+     * @return string
+     */
+    public static function getOverviewTitle();
+
+    /**
+     * Title displayed above for for creating new content page
+     *
+     * @return string
+     */
+    public static function getCreateNewTitle();
+
+    /**
+     * Title for form displayed for editin content page
+     *
+     * @param Content $content
+     *
+     * @return mixed
+     */
+    public static function getEditTitle(Content $content);
+}

app/CMS/Contracts/Content/HistoryHandler.php

@@ -0,0 +1,9 @@
+<?php
+namespace App\CMS\Handlers\Contracts;
+
+interface HistoryHandler
+{
+    public static function parseColumnName($name);
+
+    public static function parseChangedValue($changeset);
+}

app/CMS/Contracts/Search/SearchHandler.php

@@ -0,0 +1,17 @@
+<?php
+namespace App\CMS\Handlers\Contracts;
+
+interface SearchHandler {
+    public function getId();
+
+    public function getName();
+
+    /**
+     * Search for given patttern/term
+     *
+     * @param string $term searched word
+     *
+     * @return array list of found objects
+     */
+    public function search($term);
+}

app/CMS/Contracts/Search/SearchPresenterHandler.php

@@ -0,0 +1,14 @@
+<?php
+namespace App\CMS\Handlers\Contracts;
+
+interface SearchPresenterHandler
+{
+    /**
+     * Method for rendering list of found results
+     *
+     * @param $foundItems
+     *
+     * @return mixed
+     */
+    public function render($foundItems);
+}

app/CMS/Contracts/TemplateHandler.php

@@ -0,0 +1,64 @@
+<?php
+namespace App\CMS\Handlers\Contracts;
+
+use App\Http\Requests\Request;
+use App\Models\Content\Content;
+use App\Models\Module;
+
+/**
+ * Interface TemplateHandler
+ *
+ * Inerface used for registering template into CMS core.
+ *
+ * @package App\CMS\Handlers\Contracts
+ */
+interface TemplateHandler extends BaseModuleHandler
+{
+    /**
+     * Uninstall template
+     *
+     * Delete some items in database, delete files etc.
+     *
+     * @param Module $template
+     */
+    public static function uninstall(Module $template);
+
+    /**
+     * Get list of registered templates and supported modules.
+     *
+     * Returned array is expected to be array of arrays with following items: module, namespace and templateName.
+     * Example:
+     * return [
+     *    ['module' => 'Article', 'templateName' => 'article::template.name']
+     * ];
+     *
+     * When no "namespace" is specified, value strtolower(module) is used instaed.
+     *
+     * @return array
+     */
+    public static function getPublicTemplatePaths();
+
+    /**
+     * Prepare Content object to be rendered using Blade template
+     *
+     * @param Content $content
+     */
+    public static function beforeRender(Content & $content);
+
+    /**
+     * Modify input data into format which can be understood by edit template
+     *
+     * @param Content $content
+     */
+    public static function beforePopulatingEditForm(Content & $content);
+
+    /**
+     * Slightly modify Content object before saving into database.
+     *
+     * This way we can do almost whatever we want - even in template
+     *
+     * @param Content $content
+     * @param Request $request
+     */
+    public static function beforeSave(Content & $content, Request $request);
+}

app/CMS/Contracts/Widgets/AdminDashboardWidget.php

@@ -0,0 +1,12 @@
+<?php
+namespace App\CMS\Contracts\Widgets;
+
+interface AdminDashboardWidget extends PublicWidget
+{
+    /**
+     * Getter for list of all roles which are allowed to display the widget
+     *
+     * @return array
+     */
+    public static function renderForRoles();
+}

app/CMS/Contracts/Widgets/InstallableWidget.php

@@ -0,0 +1,17 @@
+<?php
+namespace App\CMS\Contracts\Widgets;
+
+interface InstallableWidget extends PublicWidget  {
+
+    /**
+     * Function for installing given widget
+     *
+     * @return mixed
+     */
+    public static function install();
+
+    /**
+     * Function for uninstalling widget
+     */
+    public static function uninstall();
+}

app/CMS/Contracts/Widgets/MenuExtensionHandler.php

@@ -0,0 +1,15 @@
+<?php
+namespace App\CMS\Widgets\Contracts;
+
+interface MenuExtensionHandler {
+
+    public function getName();
+    public function getDescription();
+    public function getId();
+    
+    public function getPossibleValues();
+
+    public function getFormExtensionTemplate();
+
+    public function save();
+}

app/CMS/Contracts/Widgets/PublicWidget.php

@@ -0,0 +1,36 @@
+<?php
+namespace App\CMS\Contracts\Widgets;
+
+use App\Models\Widgets\Widget;
+
+interface PublicWidget
+{
+    /**
+     * Name getter
+     *
+     * @return string
+     */
+    public static function getName();
+
+    /**
+     * Getter for description
+     *
+     * @return string
+     */
+    public static function getDescription();
+
+    /**
+     * Getter for presenter/renderer of this widget
+     *
+     * @return WidgetRenderer
+     */
+    public static function getPresenter();
+
+    /**
+     * @param Widget    $widget
+     * @param \stdClass $data
+     *
+     * @return mixed
+     */
+    public static function save(Widget $widget, \stdClass $data);
+}

app/CMS/Contracts/Widgets/WidgetRenderer.php

@@ -0,0 +1,37 @@
+<?php
+namespace App\CMS\Contracts\Widgets;
+
+use App\Models\Widgets\Widget;
+use App\Models\Widgets\WidgetType;
+
+interface WidgetRenderer
+{
+    /**
+     * Method used for displaying widget.
+     *
+     * This method renders some HTML code for displaying.
+     *
+     * @param Widget $settings
+     *
+     * @return mixed
+     */
+    public static function render(Widget $settings);
+
+    /**
+     * Display form for creating new instance of widget
+     *
+     * @param WidgetType $type
+     *
+     * @return mixed
+     */
+    public static function renderAddForm(WidgetType $type);
+
+    /**
+     * Display form for editing already existing widget
+     *
+     * @param Widget $widget
+     *
+     * @return mixed
+     */
+    public static function renderEditForm(Widget $widget);
+}