ivanamat/cakephp3-documents

CakePHP 3.x - Markdown Documents

CakePHP 3.x - Markdown Documents

Installation

Composer

You can install this plugin into your CakePHP application using composer., _(*1)

The recommended way to install composer packages is:, _(*2)

composer require ivanamat/cakephp3-documents

Git submodule

    git submodule add git@github.com:ivanamat/cakephp3-documents.git plugins/Documents
    git submodule init
    git submodule update

Manual installation

Download the .zip or .tar.gz file, unzip and rename the plugin folder "cakephp3-documents" to "Documents" then copy the folder to your plugins folder., _(*3)

Configuration

Load plugin

    Plugin::load('Documents', ['bootstrap' => false, 'routes' => true]);

Database

Import documents.sql config/cheme/documents.sql or execute the SQL commands., _(*4)

    # documents.sql

    DROP TABLE IF EXISTS `categories`;
    CREATE TABLE `categories` (
      `id` int(11) NOT NULL AUTO_INCREMENT,
      `parent_id` int(11) DEFAULT NULL,
      `lft` int(11) DEFAULT NULL,
      `rght` int(11) DEFAULT NULL,
      `name` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
      `slug` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
      `description` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
      `public` tinyint(1) NOT NULL DEFAULT '0',
      `created` datetime NOT NULL,
      `modified` datetime DEFAULT NULL,
      PRIMARY KEY (`id`),
      UNIQUE KEY `slug` (`slug`)
    ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

    DROP TABLE IF EXISTS `documents`;
    CREATE TABLE `documents` (
      `id` int(11) NOT NULL AUTO_INCREMENT,
      `category_id` int(11) DEFAULT NULL,
      `user_id` int(11) NOT NULL,
      `title` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
      `slug` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
      `body` text COLLATE utf8_unicode_ci,
      `created` datetime DEFAULT NULL,
      `modified` datetime DEFAULT NULL,
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

Bootstrap

Set in your bootstrap file src/config/bootstrap.php., _(*5)

Specify your homepage's URL., _(*6)

    Configure::write('Documents.home', ['plugin' => false, 'controller' => 'Pages', 'action' => 'display', 'home']);

Create your own INDEX.md and specify the path., _(*7)

    Configure::write('Documents.index', '../INDEX.md');

If the ACL plugin is loaded, you can set action's permissions., _(*8)

    /**
     * Allow CategoriesController actions
     * @actions: index, edit
     */
    Configure::write('Categories.auth.allow', ['index','edit']);

    /**
     * Allow DocumentsController actions
     * @actions: index, view, add, edit, delete
     **/
    Configure::write('Documents.auth.allow', ['index','view']);

Component and Helper

Documents has a component named DocsComponent and a helper named DocsHelper, both with the same methods., _(*9)

Methods

slugCategory($id)

$id int Category id, _(*10)

return string Returns category slug, _(*11)

    $slug = $this->Docs->slugCategory($id);
    # Example $slug value: 'proyectos/cakephp/plugins'
    echo '<a href="/' . $this->plugin . DS . $slug . '"><strong>'.$category->title.'</strong></a>';

slugDocument($id)

$id int, _(*12)

return string Returns document slug, _(*13)

    $slug = $this->Docs->slugDocument($id);
    # Example $slug value: 'proyectos/cakephp/plugins/cakephp-3-x-markdown-documents'
    echo '<a href="/' . $this->plugin . DS . $slug . '"><strong>'.$document->title.'</strong></a>';

getCategory($id)

$id int Category id, _(*14)

return object Category, _(*15)

    $category = $this->Docs->getCategory($id);
    echo '<h2>'.$category->title.'</h2>';

getParentSlug($slug)

$slug string Slug, _(*16)

return string Parent slug, _(*17)

    # $slug = 'projects/cakephp/plugins/cakephp-3-x-markdown-documents'
    $parentSlug = $this->Docs->getParentSlug($slug);
    # $parentSlug will output 'projects/cakephp/plugins'
    echo '<a href="/' . $this->plugin . DS . $parentSlug . '"><strong>Parent category</strong></a>';

getRelatedDocuments($id)

$id int Category id, _(*18)

return array Array of documents from categories children of the specified category, _(*19)

    $relatedDocuments = $this->Docs->getParentSlug($slug);
    foreach($relatedDocuments as $document) {
        echo '<h4>' . $document->title . '</h4>';
        echo $this->Markdown->parse($document->body);
    }

About CakePHP 3.x - Markdown Documents

CakePHP 3.x - Markdown Documents require CakePHP 3.x - Markdown plugin., _(*20)

Friendly URLs!

The URLs generated are all friendly., _(*21)

Example: http://www.example.com/Documents/tutorials/cakephp/plugins/cakephp-3-x-documents, _(*22)

Author

Iván Amat on GitHub
www.ivanamat.es, _(*23)