README

The LibRegistry provides a mechanism for loading and storing instances of non-Cake PHP libraries. It works a lot like Cake 3's TableRegistry. Object instances can be requested by name and instantiated automatically, or can be loaded into the registry manually.

Requirements

• CakePHP 3.0+

Installation

Composer

$ composer require loadsys/cakephp-libregistry:~1.0

Usage

• Invoke the LibRegistry statically:

   <?php
  
   namespace App\Whatever;
  
   use LibRegistry\LibRegistry;
  
   class MyController extends Controller {
   	public function index() {
   		$myObj = LibRegistry::get('MyObj', ['configs' => 'here']);
   		// (Where the class `src/Lib/MyObj.php` exists.)
   		$myObj->doSomethingNeat();
   	}
   }

• A trait is also provided to load libraries into existing classes:

   <?php
  
   namespace App\Whatever;
  
   use LibRegistry\LibRegistryTrait;
  
   class MyController extends Controller {
   	use LibRegistryTrait;
   	public function index() {
   		$this->loadLib('MyObj', ['configs' => 'here']);
   		$this->MyObj->doSomethingNeat();
   		// Works like loadComponent() in this context.
   	}
   }

Library classes

• Must exist in src/Lib/ in your Cake app or plugin and must be namespaced appropriately.

• Must accept a single array of config values as the sole __construct() argument. Libraries that don't conform to this interface can't be instantiated via LibRegistry::get(), although they can still be stored in the Registry manually via ::set().

Contributing

Code of Conduct

This project has adopted the Contributor Covenant as its code of conduct. All contributors are expected to adhere to this code. Translations are available.

Reporting Issues

Please use GitHub Isuses for listing any known defects or issues.

Development

Please fork and issue a PR targeting the master branch for any new development.

The full test suite for the plugin can be run via this command:

$ vendor/bin/phpunit

Code must conform to the Loadsys coding standard, which is based on the CakePHP coding standard:

$ vendor/bin/phpcs --config-set installed_paths vendor/cakephp/cakephp-codesniffer,vendor/loadsys/loadsys_codesniffer
$ vendor/bin/phpcs -p --standard=Loadsys src

License

MIT

Copyright

Loadsys Web Strategies 2016