Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rougin/spark-plug
Codeigniter applications as single variables.
https://github.com/rougin/spark-plug
codeigniter-library core-library php-library spark-plug
Last synced: 2 days ago
JSON representation
Codeigniter applications as single variables.
- Host: GitHub
- URL: https://github.com/rougin/spark-plug
- Owner: rougin
- License: mit
- Created: 2015-06-13T13:14:48.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-09-29T03:42:58.000Z (about 4 years ago)
- Last Synced: 2024-03-14T15:49:38.412Z (7 months ago)
- Topics: codeigniter-library, core-library, php-library, spark-plug
- Language: PHP
- Homepage: https://roug.in/spark-plug/
- Size: 68.4 KB
- Stars: 15
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-codeigniter - Spark Plug - Another way to access CodeIgniter's instance. (Libraries)
README
# Spark Plug
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]][link-license]
[![Build Status][ico-travis]][link-travis]
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]Spark Plug is a special PHP library that returns [Codeigniter](https://codeigniter.com/) applications as single variables. This package might be useful when testing applications to frameworks such as [PHPUnit](https://phpunit.de/).
## Installation
Install `Spark Plug` through [Composer](https://getcomposer.org/):
``` bash
$ composer require rougin/spark-plug
```## Basic Usage
### Using the `Instance` helper
``` php
$ci = Rougin\SparkPlug\Instance::create();// You can now use the CI_Controller instance
$ci->load->helper('inflector');
```### Using the `SparkPlug` class
``` php
use Rougin\SparkPlug\SparkPlug;$sparkplug = SparkPlug($GLOBALS, $_SERVER);
$ci = $sparkplug->instance();
$ci->load->helper('inflector');
```### Modify constants to be defined
``` php
use Rougin\SparkPlug\SparkPlug;$sparkplug = SparkPlug($GLOBALS, $_SERVER);
// Sets the value of the APPPATH constant
$sparkplug->set('APPPATH', '/path/to/app');$ci = $sparkplug->instance();
```Available constants to be modified:
* `APPPATH`
* `VENDOR`
* `VIEWPATH`**NOTE**: If you set a new `APPPATH` value, the value of `VIEWPATH` will be set to `APPPATH/views`.
### Mock `CI_Controller` for unit testing
``` php
use Rougin\SparkPlug\Instance;class SampleTest extends \PHPUnit_Framework_TestCase
{
public function testCodeigniterInstance()
{
// Directory path to the test application
$application = __DIR__ . '/TestApp';// Instance::create($path, $_SERVER, $GLOBALS)
$ci = Instance::create($application);$this->assertInstanceOf('CI_Controller', $ci);
}
}
```## Changelog
Please see [CHANGELOG][link-changelog] for more information what has changed recently.
## Testing
``` bash
$ composer test
```## Credits
- [All contributors][link-contributors]
## License
The MIT License (MIT). Please see [LICENSE][link-license] for more information.
[ico-code-quality]: https://img.shields.io/scrutinizer/g/rougin/spark-plug.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/rougin/spark-plug.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/rougin/spark-plug.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/rougin/spark-plug/master.svg?style=flat-square
[ico-version]: https://img.shields.io/packagist/v/rougin/spark-plug.svg?style=flat-square[link-changelog]: https://github.com/rougin/spark-plug/blob/master/CHANGELOG.md
[link-code-quality]: https://scrutinizer-ci.com/g/rougin/spark-plug
[link-contributors]: https://github.com/rougin/spark-plug/contributors
[link-downloads]: https://packagist.org/packages/rougin/spark-plug
[link-license]: https://github.com/rougin/spark-plug/blob/master/LICENSE.md
[link-packagist]: https://packagist.org/packages/rougin/spark-plug
[link-scrutinizer]: https://scrutinizer-ci.com/g/rougin/spark-plug/code-structure
[link-travis]: https://travis-ci.org/rougin/spark-plug