loadsys/cakephp-libregistry

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.

CakePHP LibRegistry Plugin

, _(*1)

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., _(*2)

Requirements

• CakePHP 3.0+

Installation

Composer

$ composer require loadsys/cakephp-libregistry:~1.0

Usage

• Invoke the LibRegistry statically:, _(*3)

  <?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:, _(*4)

  <?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., _(*5)

• 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()., _(*6)

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., _(*7)

Reporting Issues

Please use GitHub Isuses for listing any known defects or issues., _(*8)

Development

Please fork and issue a PR targeting the master branch for any new development., _(*9)

The full test suite for the plugin can be run via this command:, _(*10)

$ vendor/bin/phpunit

Code must conform to the Loadsys coding standard, which is based on the CakePHP coding standard:, _(*11)

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

License

MIT, _(*12)

Copyright

Loadsys Web Strategies 2016, _(*13)