Download the PHP package ivanamat/cakephp3-documents without Composer
On this page you can find all versions of the php package ivanamat/cakephp3-documents. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package cakephp3-documents
CakePHP 3.x - Markdown Documents
Installation
Composer {#composer}
You can install this plugin into your CakePHP application using composer.
The recommended way to install composer packages is:
Git submodule {#gitsubmodule}
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.
Configuration
Load plugin
Database
Import documents.sql config/cheme/documents.sql
or execute the SQL commands.
Bootstrap
Set in your bootstrap file src/config/bootstrap.php
.
Specify your homepage's URL.
Create your own INDEX.md and specify the path.
If the ACL plugin is loaded, you can set action's permissions.
Component and Helper
Documents has a component named DocsComponent and a helper named DocsHelper, both with the same methods.
Methods
slugCategory($id)
$id int Category id
return string Returns category slug
slugDocument($id)
$id int
return string Returns document slug
getCategory($id)
$id int Category id
return object Category
getParentSlug($slug)
$slug string Slug
return string Parent slug
getRelatedDocuments($id)
$id int Category id
return array Array of documents from categories children of the specified category
About CakePHP 3.x - Markdown Documents
CakePHP 3.x - Markdown Documents require CakePHP 3.x - Markdown plugin.
Friendly URLs!
The URLs generated are all friendly.
Example: http://www.example.com/Documents/tutorials/cakephp/plugins/cakephp-3-x-documents
Author
Iván Amat on GitHub
www.ivanamat.es