arodu/cakelte

CakeLTE: AdminLTE plugin for CakePHP

v2.0.1 2024-03-05 11:41 UTC

Requires

• almasaeed2010/adminlte: ^3.2
• cakephp/cakephp: ^5.0
• friendsofcake/bootstrap-ui: ^5.0

Requires (Dev)

• cakedc/cakephp-phpstan: ^3.1
• cakephp/cakephp-codesniffer: ^5.0
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.1.0

MIT

README

Getting Started

Dependencies

• FriendsOfCake/bootstrap-ui, transparently use Bootstrap 4 with CakePHP 4.
• AdminLTE 3.2, bootstrap 4 admin theme.

Installing

You can install this plugin into your CakePHP application using composer.

The recommended way to install composer packages is:

composer require arodu/cakelte

Configuration

You can load the plugin using the shell command:

bin/cake plugin load CakeLte

add AdminLTE symlink to webroot

bin/cake cakelte install

How to use

Copy the file vendor/arodu/cakelte/config/cakelte.php to config/cakelte.php

cp vendor/arodu/cakelte/config/cakelte.php config/cakelte.php

In this file you can change the cakelte configuration options

use trait into src/View/AppView.php (Recomended)

namespace App\View;

use Cake\View\View;
use CakeLte\View\CakeLteTrait;

class AppView extends View{
  use CakeLteTrait;

  public string $layout = 'CakeLte.default';

  public function initialize(): void{
      parent::initialize();
      $this->initializeCakeLte();
      //...
  }
}

or you can extends from CakeLteView

namespace App\View;

use Cake\View\View;
use CakeLte\View\CakeLteView;

class AppView extends CakeLteView{

  public function initialize(): void{
    parent::initialize();
    //...
  }
}

Options layouts

• CakeLte.default
• CakeLte.login
• CakeLte.top-nav

Create code from bake

bin/cake bake all [command] -t CakeLte

bin/cake bake template [command] -t CakeLte login
bin/cake bake template [command] -t CakeLte register
bin/cake bake template [command] -t CakeLte recovery

To modify the template you can copy one or all the files within your project, copying the following files in the folder templates/plugin/CakeLte/ and keeping the same structure of templates/

Replace the files elements

• Layouts
  • templates/layout/default.php
  • templates/layout/login.php
  • templates/layout/top-nav.php
• Content
  • templates/element/content/header.php
• Header navbar
  • templates/element/header/main.php
  • templates/element/header/menu.php
  • templates/element/header/messages.php
  • templates/element/header/notifications.php
  • templates/element/header/search-default.php
  • templates/element/header/search-block.php
• Footer
  • templates/element/footer/main.php
• Left sidebar
  • templates/element/sidebar/main.php
  • templates/element/sidebar/menu.php
  • templates/element/sidebar/search.php
  • templates/element/sidebar/user.php
• Right sidebar
  • templates/element/aside/main.php

Or you can use the following command to copy all files

bin/cake cakelte copy_files --all

Page debug

Link to debug

echo $this->Html->link(__('CakeLTE debug page'), '/cake_lte/debug' );

// {your-url}/cake_lte/debug

License

This project is licensed under the MIT License - see the LICENSE file for details