core/modules/Blog/Article/Handlers/Article.php

<?php
namespace Modules\Blog\Article\Handlers;

use App\CMS\Contracts\Content\AdvancedContentModifier;
use App\CMS\Contracts\Content\ContentTitles;
use App\CMS\Contracts\Modules\InstallableModule;
use App\CMS\Handlers\Handler;
use App\Http\Controllers\Admin\Contents\EditContent;
use App\Http\Controllers\Controller;
use App\Http\Requests\Request;
use App\Models\ActionLog\ActionLogType;
use App\Models\Content\Content;
use App\Models\Module;
use App\Models\User;
use Modules\Blog\Article\Entities\Comment;

class Article extends Handler implements ContentTitles, AdvancedContentModifier, InstallableModule
{
    /**
     * 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)
    {
        $content->comments = [];
        if (isset($content->module_settings->allowComments) && $content->module_settings->allowComments) {
            $content->comments = Comment::where('content_id', $content->id)
                                        ->with('author')
                                        ->where('approved', 1)
                                        ->orderBy('created_at')
                                        ->get();
        }

        return Controller::VisitorsView($content->template, ['page' => $content, 'extra' => $parameters]);
    }

    public static function getExtendedFormInputsCreate()
    {
        $sections = parent::getExtendedFormInputsCreate();

        $sections['basicInfo'] = 'article::admin.content.basicInfo';

        return $sections;
    }

    public static function getExtendedFormInputsEdit()
    {
        return self::getExtendedFormInputsCreate();
    }

    /**
     * Save module-specific values into database
     *
     * @param Content $content
     * @param Request $request
     *
     * @return mixed|void
     */
    public static function createNew(Content &$content, Request $request)
    {
        $content->module_settings = json_encode(['allowComments' => (int)$request->has('allowComments')]);
    }

    /**
     * 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)
    {
        $fields = ['allowComments' => 'allowComments'];

        // get data and try to save them
        $data = EditContent::getFields($request, $fields);

        $data['allowComments'] = (int)$data['allowComments'];

        list($revision, $changedColumns) = $content->updateWithHistory($fields, $data, $revisionID);

        // return amount of changed columns
        return $changedColumns;
    }

    /**
     * Register admin menu
     *
     * @param User $user
     */
    public static function registerAdminMenu(User $user)
    {
        parent::registerAdminMenu($user);

        $menu = \Menu::instance('mainMenu');

        $blogSubmenu = $menu->whereTitle(trans('article::module.blog'));
        if (!$blogSubmenu) {
            $blogSubmenu = $menu->dropdown(trans('article::module.blog'), function ($sub) {
            }, 20, ['icon' => 'fa fa-fw fa-book']);
        }

        $blogSubmenu->dropdown(trans('article::module.name'), function ($sub) {
            $sub->route('content.new', trans('article::article.new'), ['id' => config('article.alias')], 10, ['icon' => 'fa fa-fw fa-pencil']);
            $sub->route('content.overview', trans('article::article.overview'), ['id' => config('article.alias')], 30, ['icon' => 'fa fa-fw fa-book']);
        }, 10, ['icon' => 'fa fa-fw fa-book']);

        $blogSubmenu->route('comments.overview', trans('article::module.commentsOverview'), [], 20, ['icon' => 'fa fa-fw fa-commenting-o']);
    }

    /**
     * Install module
     */
    public static function install()
    {
        $types = [
            [
                'string_id' => 'commentCreated',
                'name'      => 'article::comments.events.names.commentCreated',
                'value'     => 'article::comments.events.descriptions.commentCreated',
            ],
            [
                'string_id' => 'commentDeleted',
                'name'      => 'article::comments.events.names.commentDeleted',
                'value'     => 'article::comments.events.descriptions.commentDeleted',
            ],
            [
                'string_id' => 'commentApproved',
                'name'      => 'article::comments.events.names.commentApproved',
                'value'     => 'article::comments.events.descriptions.commentApproved',
            ],

        ];
        foreach ($types as $type) {
            ActionLogType::create($type);
        }
    }

    /**
     * Uninstalls module
     *
     * @param Module $module
     *
     * @return mixed|void
     */
    public static function uninstall(Module $module)
    {
        ActionLogType::whereIn('string_id', ['commentCreated', 'commentDeleted', 'commentApproved'])
                     ->delete();
    }

    /**
     * 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()
    {
        return trans('article::module.allArticles');
    }

    /**
     * Title displayed above for for creating new content page
     *
     * @return string
     */
    public static function getCreateNewTitle()
    {
        return trans('article::module.newArticle');
    }

    /**
     * Title for form displayed for editin content page
     *
     * @param Content $content
     *
     * @return mixed
     */
    public static function getEditTitle(Content $content)
    {
        return trans('article::module.editArticle');
    }

    /**
     * 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)
    {
    }

    /**
     * Load some extra data for content management form?
     *
     * @param Content $content
     *
     * @return mixed
     */
    public static function loadExtraData(Content $content)
    {
    }

    /**
     * Does this module support categories?
     *
     * @return boolean
     */
    public static function supportCategories()
    {
        return true;
    }
}