Wallogit.com
2017 © Pedro Peláez
Twitter Bootstrap 3 support for CakePHP 3
, (*1)
Transparently use Bootstrap 3 with CakePHP 3., (*2)
cd to the root of your app folder (where the composer.json file is) and run the following command:, (*3)
composer require friendsofcake/bootstrap-ui
Then load the plugin by adding the following to your app's config/boostrap.php:, (*4)
\Cake\Core\Plugin::load('BootstrapUI');
or using CakePHP's console:, (*5)
./bin/cake plugin load BootstrapUI
You will need to modify your src/View/AppView class to either extend BootstrapUI\View\UIView or
use the trait BootStrapUI\View\UIViewTrait., (*6)
For a quick setup, just make your AppView class extend BootstrapUI\View\UIView. The base class will handle
the initializing and loading of the BootstrapUI layout.ctp for your app., (*7)
The src\View\AppView.php will look something like the following:, (*8)
namespace App\View;
use BootstrapUI\View\UIView;
class AppView extends UIView
{
/**
* Initialization hook method.
*/
public function initialize()
{
//Don't forget to call the parent::initialize()
parent::initialize();
}
}
If you're adding BootstrapUI to an existing application. It might be easier to use the trait, as it gives you more control over the loading of the layout., (*9)
namespace App\View;
use BootstrapUI\View\UIViewTrait;
use Cake\View\View;
class AppView extends View
{
use UIViewTrait;
/**
* Initialization hook method.
*/
public function initialize()
{
//render the initializeUI method from the UIViewTrait
$this->initializeUI();
}
}
BootstrapUI comes with its own layout.ctp file and examples taken from the Bootstrap framework., (*10)
When no layout for the view is defined the BootstrapUI\View\UIViewTrait will load its own layout.ctp file. You can
override this behavior in two ways., (*11)
$this->layout('layout').BootstrapUI\View\UIViewTrait with $this->initializeUI(['layout' => false]);.If you wish to use your own layout template, just make sure to include:, (*12)
// in the <head>
echo $this->Html->css('path/to/bootstrap.css');
echo $this->Html->script(['path/to/jquery.js', 'path/to/bootstrap.js']);
When using the BootstrapUI layout (or a copy of it), extra layout types (directly taken from the Bootstrap examples). You just need to copy them to your application's layouts directory:, (*13)
cp -R vendor/friendsofcake/bootstrap-ui/src/Template/Layout/examples src/Template/Layout/TwitterBootstrap
You can then simply extend them in your views like so:, (*14)
$this->extend('../Layout/TwitterBootstrap/dashboard');
Available types are:, (*15)
NOTE: Remember to set the stylesheets in the layouts you copy., (*16)
A quick way of getting the Bootstrap assets installed is using bower. Assuming you are in ROOT:, (*17)
bower install bootstrap mkdir -p webroot/css/bootstrap webroot/js/bootstrap webroot/js/jquery webroot/css/fonts cp bower_components/bootstrap/dist/css/* webroot/css/bootstrap/. cp bower_components/bootstrap/dist/js/* webroot/js/bootstrap/. cp bower_components/jquery/dist/* webroot/js/jquery/. cp bower_components/bootstrap/dist/fonts/* webroot/css/fonts/. echo /bower_components >> .gitignore git add .gitignore \ bower.json \ webroot/css/bootstrap \ webroot/js/bootstrap \ webroot/js/jquery
For those of you who want even more automation, some bake templates have been included. Use them like so:, (*18)
$ bin/cake bake.bake [subcommand] -t BootstrapUI
At the core of BootstrapUI is a collection of enhancements for CakePHP core helpers. These helpers replace the HTML templates used to render elements for the views. This allows you to create forms and components that use the Bootstrap styles., (*19)
The current list of enhanced helpers are:, (*20)
BootstrapUI\View\Helper\FlashHelperBootstrapUI\View\Helper\FormHelperBootstrapUI\View\Helper\HtmlHelperBootstrapUI\View\Helper\PaginatorHelperWhen the BootstrapUI\View\UIViewTrait is initialized it loads the above helpers with the same aliases as the
CakePHP core helpers. That means that when you use $this->Form->create() in your views. The helper being used
is from the BootstrapUI plugin., (*21)
echo $this->Form->create($article);
echo $this->Form->control('title');
echo $this->Form->control('published', ['type' => 'checkbox']);
will render this HTML:, (*22)
<form method="post" accept-charset="utf-8" role="form" action="/articles/add">
<div style="display:none;"><input type="hidden" name="_method" value="POST"></div>
<div class="form-group">
<label class="control-label" for="title">Title</label>
<input type="text" name="title" required="required" id="title" class="form-control">
</div>
<div class="form-group">
<input type="hidden" name="published" value="0">
<label for="published">
<input type="checkbox" name="published" value="1" id="published" class="form-control">
Published
</label>
</div>
echo $this->Form->create($article, ['align' => [
'sm' => [
'left' => 6,
'middle' => 6,
'right' => 12
],
'md' => [
'left' => 4,
'middle' => 4,
'right' => 4
]
]]);
echo $this->Form->control('title');
echo $this->Form->control('published', ['type' => 'checkbox']);
will render this HTML:, (*23)
<form method="post" accept-charset="utf-8" role="form" class="form-horizontal" action="/articles/add">
<div style="display:none;"><input type="hidden" name="_method" value="POST"></div>
<div class="form-group">
<label class="control-label col-sm-6 col-md-4" for="title">Title</label>
<div class="col-sm-6 col-md-4">
<input type="text" name="title" required="required" id="title" class="form-control">
</div>
</div>
<div class="form-group">
<div class="col-sm-offset-6 col-sm-6 col-md-offset-4 col-md-4">
<input type="hidden" name="published" value="0">
<label for="published">
<input type="checkbox" name="published" value="1" id="published" class="form-control">
Published
</label>
</div>
</div>
You can configure each of the helpers by passing in extra parameters through the AppView.php., (*24)
Here is an example of changing the prev and next labels for the PaginatorHelper., (*25)
$this->loadHelper(
'Paginator',
[
'className' => 'BootstrapUI.Paginator',
'labels' => [
'prev' => 'previous',
'next' => 'next',
]
]
);
To style auth flash messages properly set the flash key in AuthComponent config as shown:, (*26)
$this->loadComponent('Auth', [
'flash' => [
'element' => 'error',
'key' => 'auth'
],
...
NOTE: Check tests for more examples., (*27)
You can run the tests for BootstrapUI by doing the following:, (*28)
$ composer install
$ ./vendor/bin/phpunit
To ensure your PRs are considered for upstream, you MUST follow the CakePHP coding standards. A pre-commit
hook has been included to automatically run the code sniffs for you. From your project's root directory:, (*29)
cp ./contrib/pre-commit .git/hooks/ chmod 755 .git/hooks/pre-commit
http://github.com/friendsofcake/bootstrap-ui/issues, (*30)
Copyright (c) 2015, Jad Bitar and licensed under The MIT License., (*31)
Twitter Bootstrap 3 support for CakePHP 3
MIT
cakephp bootstrap twitter