eden / registry
Eden registry component
Installs: 8 596
Dependents: 3
Suggesters: 0
Security: 0
Stars: 0
Watchers: 13
Forks: 0
Open Issues: 0
Requires
- php: >=5.4.1
- eden/array: 4.*
- eden/core: 4.*
README
====
Install
composer install eden/registry
====
Enable Eden
The following documentation uses eden()
in its example reference. Enabling this function requires an extra step as descirbed in this section which is not required if you access this package using the following.
Eden\Registry\Index::i();
When using composer, there is not an easy way to access functions from packages. As a workaround, adding this constant in your code will allow eden()
to be available after.
Eden::DECORATOR;
For example:
Eden::DECORATOR;
eden()->inspect('Hello World');
====
Introduction
Instantiate registry in this manner.
$registry = eden('registry');
====
API
====
get
Gets a value given the path in the registry.
Usage
eden('registry')->get(scalar[, scalar..] $key);
Parameters
scalar[, scalar..] $key
- The registry path; yea i know this is wierd
Returns mixed
Example
eden('registry')->get('foo', 'bar');
====
getArray
Returns the raw array recursively
Usage
eden('registry')->getArray(bool $modified);
Parameters
bool $modified
- whether to return the original data
Returns array
Example
eden('registry')->getArray();
====
isKey
Checks to see if a key is set
Usage
eden('registry')->isKey(*scalar[,scalar..] $key);
Parameters
*scalar[, scalar..] $key
- The registry path; yea i know this is wierd
Returns bool
Example
eden('registry')->isKey('foo', 'bar');
====
remove
Removes a key and everything associated with it
Usage
eden('registry')->remove(*scalar[,scalar..] $key);
Parameters
*scalar[,scalar..] $key
- The registry path; yea i know this is wierd
Returns Eden\Registry\Index
Example
eden('registry')->remove('foo', 'bar');
====
set
Creates the name space given the space and sets the value to that name space
Usage
eden('registry')->set(*scalar[,scalar..] $key, *mixed $value);
Parameters
*scalar[,scalar..] $key
- The registry path; yea i know this is wierd*mixed $value
- The value to set
Returns Eden\Registry\Index
Example
eden('registry')->set('foo', 'bar', 'zoo');
====
Contributions to Eden are following the Github work flow. Please read up before contributing.
##Setting up your machine with the Eden repository and your fork
- Fork the repository
- Fire up your local terminal create a new branch from the
v4
branch of your fork with a branch name describing what your changes are. Possible branch name types:- bugfix
- feature
- improvement
- Make your changes. Always make sure to sign-off (-s) on all commits made (git commit -s -m "Commit message")
##Making pull requests
- Please ensure to run
phpunit
before making a pull request. - Push your code to your remote forked version.
- Go back to your forked version on GitHub and submit a pull request.
- An Eden developer will review your code and merge it in when it has been classified as suitable.