cakedc/cakephp-book

CakeDC/Book plugin for CakePHP

2.2.1 2023-09-15 08:11 UTC

Requires

• cakephp/cakephp: ^4.0
• html2text/html2text: ^4.3

Requires (Dev)

• phpunit/phpunit: ^5.7.14|^6.0

MIT

README

cakephp-book allows you to search in the official CakePHP documentation directly from the console.

Requirements

• CakePHP 4.0+
• PHP 7.2+

Installation

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

The recommended way to install composer packages is:

composer require cakedc/cakephp-book

Configuration

You can load the plugin using the shell command:

bin/cake plugin load CakeDC/Book

Or you can manually add the loading statement in the src/Application.php file of your application:

public function bootstrap() {
    parent::bootstrap();
    $this->addPlugin('CakeDC/Book');
}

Basic Usage

bin/cake book <parameter>

parameter = parameter to look for in the documentation

Examples:

bin/cake book Text
bin/cake book "Virtual Fields"

Support

For bugs and feature requests, please use the issues section of this repository.

Commercial support is also available, contact us for more information.

Contributing

This repository follows the CakeDC Plugin Standard. If you'd like to contribute new features, enhancements or bug fixes to the plugin, please read our Contribution Guidelines for detailed instructions.

License

Copyright 2020 - 2022 Cake Development Corporation (CakeDC). All rights reserved.

Licensed under the MIT License. Redistributions of the source code included in this repository must retain the copyright notice found in each file.