rawphp/raw-options

RawOptions is a small package that adds options to a PHP application and is used by RawPHP framework and other applications.

dev-master / 0.x-dev 2014-09-23 07:08 UTC

Requires

• php: >=5.3.0
• rawphp/raw-base: 1.0.0-RC-1
• rawphp/raw-database: 0.*@dev
• rawphp/raw-migrator: 0.*@dev
• rawphp/raw-yaml: 1.0.0-RC-2

Requires (Dev)

• phpdocumentor/phpdocumentor: dev-master
• phpunit/phpunit: 4.2.5
• rawphp/raw-code-standards: 1.*@dev
• satooshi/php-coveralls: dev-master
• squizlabs/php_codesniffer: dev-master

MIT

• Tom Kaczocha

• options

README

Package Features

• Manage application options in the database through key->value pairs.
• Provides a ready-to-go database table migration and an option interface.

Installation

Composer

RawOptions is available via Composer/Packagist.

Add "rawphp/raw-options": "0.*@dev" to the require block in your composer.json and then run composer install.

{
        "require": {
            "rawphp/raw-options": "0.*@dev"
        }
}

You can also simply run the following from the command line:

composer require rawphp/raw-options "0.*@dev"

Tarball

Alternatively, just copy the contents of the RawOptions folder into somewhere that's in your PHP include_path setting. If you don't speak git or just want a tarball, click the 'zip' button at the top of the page in GitHub.

Basic Usage

<?php

use RawPHP\RawOptions\Options;

// IDatabase instance
$database = new Database( );
$database->init( $config );

// instantiate a new instance of options service
$options = new Options( $database );

// add a new option
$options->addOption( $key, $value );

// update an existing option
$options->updateOption( $key, $value );

// get an option
$options->getOption( $key );

// delete an option
$options->deleteOption( $key );

License

This package is licensed under the MIT. Read LICENSE for information on the software availability and distribution.

Contributing

Please submit bug reports, suggestions and pull requests to the GitHub issue tracker.

Changelog

22-09-2014

• Updated to PHP 5.3.

20-09-2014

• Replaced php array configuration with yaml

18-09-2014

• Updated to work with the latest rawphp/rawbase package.

17-09-2014

• Initial Code Commit