mirko-pagliai/me-tools

MeTools plugin for CakePHP

3.0.3-RC4 2024-03-11 23:41 UTC

Requires

• php: >=8.1
• ext-json: *
• cakephp/cakephp: ^5.0
• mirko-pagliai/php-tools: ~1.9.3

Requires (Dev)

• ext-fileinfo: *
• cakephp/cakephp-codesniffer: ^5.0
• mirko-pagliai/cakephp-assets: ^1.5.7
• phpstan/phpstan: ^1.10.38
• phpunit/phpunit: ^10.1.0 <=10.5.3
• vimeo/psalm: ^5.15.0

Suggests

• axllent/jquery: To use jQuery, the JavaScript library
• fortawesome/font-awesome: To use Font Awesome's icons
• mirko-pagliai/cakephp-assets: A CakePHP plugin to allows you to generate assets
• twbs/bootstrap: To use Bootstrap, the world's most popular framework for building responsive, mobile-first sites

Conflicts

• components/jquery: *

MIT

• Mirko Pagliai

README

MeTools is a CakePHP plugin to improve applications development. It provides some useful tools, such as components, helpers and javascript libraries. Refer to our API to discover them all.

Installation

You can install the plugin via composer:

$ composer require --prefer-dist mirko-pagliai/me-tools

Then you have to load the plugin. For more information on how to load the plugin, please refer to the Cookbook.

Simply, you can execute the shell command to enable the plugin:

bin/cake plugin load MeTools

This would update your application's bootstrap method.

Installation on older CakePHP and PHP versions

Recent packages and the master branch require at least CakePHP 4.2 and PHP 7.4 and the current development of the code is based on these and later versions of CakePHP and PHP. However, there are still some branches compatible with previous versions of CakePHP and PHP.

For PHP 7.2 or later

The php7.2 branch requires at least PHP 7.2.

In this case, you can install the package as well:

$ composer require --prefer-dist mirko-pagliai/me-tools:dev-php7.2

Note that the php7.2 branch will no longer be updated as of May 13, 2022, except for security patches, and it matches the 2.20.9 version.

Use the theme for Bake

MeTools includes a theme for Bake. For information on Bake's themes, refer to the CookBook.

If you want to use this theme, don't forget to use the --theme MeTools option when you Bake, or to set the theme as default:

<?php
// in src/Application::bootstrapCli() before loading the 'Bake' plugin.
Configure::write('Bake.theme', 'MeTools');

How to extract POT files

First, copy the CakePHP binaries (at least bin/cake and bin/cake.php), adapting bin/cake.php to the plugin.

For example, it might look like this:

#!/usr/bin/php -q
<?php
declare(strict_types=1);

require_once dirname(__DIR__) . '/tests/bootstrap.php';

use App\Application;
use Cake\Console\CommandRunner;

// Build the runner with an application and root executable name.
$runner = new CommandRunner(new Application(APP . '/config'), 'cake');
exit($runner->run($argv));

Then run the extract command in the console:

$ bin/cake i18n extract --paths config,src,templates --overwrite

Versioning

For transparency and insight into our release cycle and to maintain backward compatibility, MeTools will be maintained under the Semantic Versioning guidelines.