CakePHP Blocks Plugin

, _(*1)

A really simple plugin that allows you to manage and show small content blocks., _(*2)

Install

Using Composer:, _(*3)

composer require ciricihq/blocks

You then need to load the plugin. You can use the shell command:, _(*4)

bin/cake plugin load Cirici/Blocks

or by manually adding statement shown below to your app's config/bootstrap.php:, _(*5)

Plugin::load('Cirici/Blocks');

Usage

There's a Trait that does all the job, and we've created a BlockHelper and a BlockComponent so you can use them easily on your CakePHP app., _(*6)

To start using them, just load whatever class you want., _(*7)

For the BlockHelper, on your AppView's initialize method, add:, _(*8)

// src/View/AppView.php
public function initialize()
{
    $this->loadHelper('Cirici/Blocks.Block');
}

For the BlockComponent, on your AppController's initialize:, _(*9)

// src/Controller/AppController.php
public function initialize()
{
    $this->loadComponent('Cirici/Blocks.Block');
}

Methods

Right now there are just two methods available (as said, this plugin is really simple):, _(*10)

get: retrieves the entire Block entity by its slug.
getContents: just returns the Block's content field contents.

Patches & Features

Fork
Mod, fix
Test - this is important, so it's not unintentionally broken
Commit - do not mess with license, todo, version, etc. (if you do change any, bump them into commits of their own that I can ignore when I pull)
Pull request - bonus point for topic branches