Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tfhinc/ci-realredis
Really Redis! - RealRedis is a wrapper library for phpredis in the Codeigniter framework
https://github.com/tfhinc/ci-realredis
codeigniter-library codeigniter3 phpredis redis redis-library
Last synced: 2 days ago
JSON representation
Really Redis! - RealRedis is a wrapper library for phpredis in the Codeigniter framework
- Host: GitHub
- URL: https://github.com/tfhinc/ci-realredis
- Owner: TFHInc
- License: mit
- Created: 2018-12-01T15:41:23.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-12-04T03:35:15.000Z (about 6 years ago)
- Last Synced: 2025-01-22T02:15:09.465Z (2 days ago)
- Topics: codeigniter-library, codeigniter3, phpredis, redis, redis-library
- Language: PHP
- Homepage:
- Size: 14.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# RealRedis
[![Latest Version on Packagist][ico-version]][link-packagist]
[![PHP Version][ico-php-version]][link-packagist]
[](LICENSE.md)
[![Total Downloads][ico-downloads]][link-downloads]
Really Redis! - RealRedis is a wrapper library for phpredis in the [Codeigniter](https://codeigniter.com/) framework.
## Requirements
- PHP >= 7.1.0
- phpredis
- CodeIgnitor 3.x
## Installation
Install the library via composer:
```bash
composer require tfhinc/ci-realredis
```
Run the post install command to publish the helper and class files to the appropriate CI directories:
```bash
composer --working-dir=vendor/tfhinc/ci-realredis/ run-script publish-files
```
## Loading the Library
There are a few available options for loading the RealRedis library:
### Using the `realredis()` helper function
The RealRedis helper function will resolve the realredis class via the CI instance. It will either load the class or return the existing class instance:
``` php
$this->load->helper('realredis');
```
### Using the RealRedis Class
The RealRedis class can be instantiated when you require it:
``` php
$redis = new TFHInc/RealRedis/RealRedis();
```
### Using the RealRedis CI Library
The RealRedis class can be instantiated when you require it:
``` php
$this->load->library('RealRedis');
```
## Usage
```php
// Use the helper method
$this->CI->load->helper('realredis');
realredis()->get('sample.key');
// Use the RealRedis class
$realredis = new TFHInc\RealRedis\RealRedis();
$realredis->get('sample.key');
// Use the RealRedis CI Library
$this->load->library('RealRedis');
$realredis->get('sample.key');
```
## Contributing
Feel free to create a GitHub issue or send a pull request with any bug fixes. Please see the GutHub issue tracker for isses that require help.
## Acknowledgements
- [Colin Rafuse][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/tfhinc/ci-realredis.svg?style=flat-square
[ico-php-version]: https://img.shields.io/packagist/php-v/tfhinc/ci-realredis.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/tfhinc/ci-realredis.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/tfhinc/ci-realredis
[link-downloads]: https://packagist.org/packages/tfhinc/ci-realredis
[link-author]: https://github.com/crafuse
[link-contributors]: ../../contributors