icybee/module-registry

Stores settings and options.

Installs: 1 534

Dependents: 9

Suggesters: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:icanboogie-module

v3.0.0 2016-01-23 17:03 UTC

README

Stores settings, options, and meta data.

<?php

/* @var \ICanBoogie\Application $app */

$registry = $app->registry;

$a = $registry['a_property'];           // null
$a = $registry->get('a_property', 123); // 123

$registry['a_property'] = 123;
$a = $registry['a_property'];           // 123

$app->user->metas['a_property'] = 123;
$app->site->metas['a_property'] = 123;
$app->models['articles']->one->metas['a_property'] = 123;

Requirement

The package requires PHP 5.6 or later.

Installation

The recommended way to install this package is through Composer:

$ composer require icybee/module-registry

This module is part of the modules required by Icybee.

Cloning the repository

The package is available on GitHub, its repository can be cloned with the following command line:

$ git clone https://github.com/Icybee/module-registry.git registry

Documentation

The package is documented as part of the Icybee CMS documentation. The documentation for the package and its dependencies can be generated with the make doc command. The documentation is generated in the docs directory using ApiGen. The package directory can later by cleaned with the make clean command.

Testing

The test suite is ran with the make test command. Composer is automatically installed as well as all the dependencies required to run the suite. The package directory can later be cleaned with the make clean command.

The package is continuously tested by Travis CI.

Build Status

License

The module is licensed under the New BSD License - See the LICENSE file for details.