🍰 CakePHP utilities
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config Revert "Use ROOT instead of dirname (task #8712)" Dec 7, 2018
src Remove `uniqueItems` from view schema (task #9483) Jan 11, 2019
tests
webroot
.bettercodehub.yml
.codeclimate.yml
.editorconfig
.gitattributes Updated configuration (task #8244) Oct 29, 2018
.gitignore
.stickler.yml
.travis.yml
LICENSE Copyright years update (task #5220) Jan 18, 2018
README.md
composer.json Lock CakePHP to < 3.7 (task #8712) Dec 7, 2018
phpcs.xml.dist
phpstan.neon.dist
phpunit.xml.dist

README.md

CakePHP3.x Qobo Utils Plugin

Build Status Latest Stable Version Total Downloads Latest Unstable Version License codecov BCH compliance

A variety of utilities that are common and useful for several of our plugins and application.

This plugin is developed by Qobo for Qobrix. It can be used as standalone CakePHP plugin, or as part of the project-template-cakephp installation.

Usage

Install the pugin with composer:

composer require qobo/cakephp-utils

Load the plugin:

bin/cake plugin load Qobo/Utils --bootstrap

Check that the plugin is loaded:

bin/cake plugin loaded

The above should output the list of loaded plugins, with Qobo/Utils being one of them.

Functionality

AdminLTE

One of the primary objectives of this plugin is to simplify the loading and configuration of the AdminLTE theme CakePHP plugin. Here is what you need to set it up.

Load the AdminLTE plugin:

bin/cake plugin load AdminLTE --routes --bootstrap

Load AdminLTE plugin configuration at the bottom of config/bootstrap.php:

Configure::load('admin_lte', 'default');

Here is an example configuration you can stick into config/admin_lte.php:

<?php
return [
    'Theme' => [
        'folder' => ROOT,
        'title' => 'My App',
        'logo' => [
            // This will be displayed when main menu is collapsed.
            // You can use an <img> tag in here or anything else you want.
            'mini' => 'A',
            // This will be displayed when main menu is expanded.
            // You can use an <img> tag in here or anything else you want.
            'large' => 'My App',
        ],
        'login' => [
            'show_remember' => true,
            'show_register' => false,
            'show_social' => false,
        ],
    ],
];

Load AdminLTE theme in beforeRender() method of src/Controller/AppController.php:

// At the top of the file, together with other use statements:
use Cake\Core\Configure;

public function beforeRender(Event $event)
{
    $this->viewBuilder()->theme('AdminLTE');
    $this->set('theme', Configure::read('Theme'));
    // $this->set('user', $this->Auth->user());
    $this->set('user', []);
}

Load AdminLTE Form Helper in initialize() method of src/View/AppView.php:

public function initialize()
{
    $this->loadHelper('Form', ['className' => 'AdminLTE.Form']);
}

For more information on initializing and configuring the AdminLTE theme, see plugin documentation