qobo/cakephp-cms

Cms plugin for CakePHP

Installs: 13 188

Dependents: 0

Suggesters: 0

Stars: 8

Watchers: 15

Forks: 3

Open Issues: 2

Type:cakephp-plugin


README

Build Status Latest Stable Version Total Downloads Latest Unstable Version License codecov BCH compliance

About

Content management plugin for CakePHP 3+.

This plugin is developed by Qobo for Qobrix. It can be used as standalone CakePHP plugin, or as part of the project-template-cakephp installation.

Requirements

Plugins:

Setup

You can install this plugin into your CakePHP application using composer.

The recommended way to install composer packages is:

Install plugin

composer require qobo/cakephp-cms

Load required plugins

bin/cake plugin load Qobo/Utils --bootstrap
bin/cake plugin load Muffin/Trash
bin/cake plugin load Muffin/Slug
bin/cake plugin load Burzum/FileStorage
bin/cake plugin load CakephpTinymceElfinder --routes

Load plugin

bin/cake plugin load Cms --routes --bootstrap

Run migrations

bin/cake migrations migrate -p Burzum/FileStorage
bin/cake migrations migrate -p Cms

Configure AdminLTE theme as per the instructions in Qobo/Utils plugin.

Load CakePHP TinyMCE elFinder helper from initialize() method of src/View/AppView.php:

public function initialize()
{
    $this->loadHelper('Form', ['className' => 'AdminLTE.Form']);
    $this->loadHelper('CakephpTinymceElfinder.TinymceElfinder');
}

To load site management UI component add below lines to your application's bootstrap file.

// config/bootstrap.php
use Cake\Event\EventManager;
use Cms\Event\View\SitesManageListener;
EventManager::instance()->on(new SitesManageListener());

Note, that some of the plugin functionality relies on user authentication being implemented. You can either follow the instructions here or update the references to the Auth component in relevant controllers, models, and template.

Once all is done, navigate to /cms/sites/ to get started with the content management.

WYSIWYG editor

The plugin's WYSIWYG editor is tinyMCE 4.* which is used to create/edit the article content.

Documentation

For documentation see the docs directory of this repository.