https://github.com/ciricihq/cake-blocks
A really simple plugin that allows you to manage and display blocks of content
https://github.com/ciricihq/cake-blocks
cake-plugin cakephp plugin
Last synced: 7 months ago
JSON representation
A really simple plugin that allows you to manage and display blocks of content
- Host: GitHub
- URL: https://github.com/ciricihq/cake-blocks
- Owner: ciricihq
- License: gpl-3.0
- Created: 2016-03-04T10:56:36.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-05-29T10:46:11.000Z (over 6 years ago)
- Last Synced: 2025-04-13T07:52:53.997Z (7 months ago)
- Topics: cake-plugin, cakephp, plugin
- Language: PHP
- Size: 43 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
CakePHP Blocks Plugin
=====================
[](https://travis-ci.org/ciricihq/cake-blocks)
[](https://coveralls.io/github/ciricihq/cake-blocks)
[](https://packagist.org/packages/ciricihq/blocks)
[](LICENSE.md)
A really simple plugin that allows you to manage and show small content blocks.
Install
-------
Using [Composer][composer]:
```
composer require ciricihq/blocks
```
You then need to load the plugin. You can use the shell command:
```
bin/cake plugin load Cirici/Blocks
```
or by manually adding statement shown below to your app's `config/bootstrap.php`:
```php
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.
To start using them, just load whatever class you want.
For the `BlockHelper`, on your `AppView`'s initialize method, add:
```php
// src/View/AppView.php
public function initialize()
{
$this->loadHelper('Cirici/Blocks.Block');
}
```
For the `BlockComponent`, on your `AppController`'s initialize:
```php
// 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):
- `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
Bugs & Feedback
---------------
http://github.com/ciricihq/cake-blocks/issues
License
-------
Copyright (c) 2016, [Cirici New Media][cirici] and licensed under [GNU GPL3 license][gnu].
[cakephp]:http://cakephp.org
[composer]:http://getcomposer.org
[gnu]:LICENSE.md
[cirici]:https://cirici.com
[standards]:http://book.cakephp.org/3.0/en/contributing/cakephp-coding-conventions.html