Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rinvex/laravel-cacheable
⚠️ [ABANDONED] Rinvex Cacheable is a granular, intuitive, and fluent caching system for eloquent models. Simple, but yet powerful, plug-n-play with no hassle.
https://github.com/rinvex/laravel-cacheable
cache eloquent laravel php query
Last synced: 4 days ago
JSON representation
⚠️ [ABANDONED] Rinvex Cacheable is a granular, intuitive, and fluent caching system for eloquent models. Simple, but yet powerful, plug-n-play with no hassle.
- Host: GitHub
- URL: https://github.com/rinvex/laravel-cacheable
- Owner: rinvex
- License: mit
- Archived: true
- Created: 2017-01-18T08:55:41.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-02-16T01:55:32.000Z (almost 3 years ago)
- Last Synced: 2024-10-30T04:53:49.451Z (3 months ago)
- Topics: cache, eloquent, laravel, php, query
- Language: PHP
- Homepage:
- Size: 141 KB
- Stars: 111
- Watchers: 4
- Forks: 28
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Rinvex Cacheable
⚠️ This package is abandoned and no longer maintained. No replacement package was suggested. ⚠️
👉 If you are interested to step on as the main maintainer of this package, please [reach out to me](https://twitter.com/omranic)!
---
**Rinvex Cacheable** is a granular, intuitive, and fluent caching system for eloquent models. Simple, but yet powerful, plug-n-play with no hassle.
[](https://packagist.org/packages/rinvex/laravel-cacheable)
[](https://scrutinizer-ci.com/g/rinvex/laravel-cacheable/)
[](https://travis-ci.org/rinvex/laravel-cacheable)
[](https://styleci.io/repos/79321486)
[](https://github.com/rinvex/laravel-cacheable/blob/develop/LICENSE)
What this package do -technically- caching eloquent query passing through the `get` method, whatever it is and it's smart enough to indicated any conditions, limit, offset, wheres, orders, groups, ..etc and take that criteria into account when caching and checking for cached version. Also by default any create, update, or delete event will flush all cache for that specific model. It uses default Laravel caching system, and utilizes whatever cache driver you are using. Awesome, right?
## Installation & Usage
1. Install the package via composer:
```shell
composer require rinvex/laravel-cacheable
```
2. Use the `\Rinvex\Cacheable\CacheableEloquent` in your desired model, and you're done!
3. Seriously, that's it!
Check the [`CacheableEloquent`](src/CacheableEloquent.php) source code for more awesome stuff if you need advanced control.
## Optional Features
You can optionally override model caching behaviour per model as follows:
```php
/**
* Indicate if the model cache clear is enabled.
*
* @var bool
*/
protected $cacheClearEnabled = true;
/**
* The model cache driver.
*
* @var string
*/
protected $cacheDriver = 'memcached';
/**
* The model cache lifetime.
*
* @var int
*/
protected $cacheLifetime = -1;
```
## Changelog
Refer to the [Changelog](CHANGELOG.md) for a full history of the project.
## Support
The following support channels are available at your fingertips:
- [Chat on Slack](https://bit.ly/rinvex-slack)
- [Help on Email](mailto:[email protected])
- [Follow on Twitter](https://twitter.com/rinvex)
## Contributing & Protocols
Thank you for considering contributing to this project! The contribution guide can be found in [CONTRIBUTING.md](CONTRIBUTING.md).
Bug reports, feature requests, and pull requests are very welcome.
- [Versioning](CONTRIBUTING.md#versioning)
- [Pull Requests](CONTRIBUTING.md#pull-requests)
- [Coding Standards](CONTRIBUTING.md#coding-standards)
- [Feature Requests](CONTRIBUTING.md#feature-requests)
- [Git Flow](CONTRIBUTING.md#git-flow)
## Security Vulnerabilities
If you discover a security vulnerability within this project, please send an e-mail to [[email protected]]([email protected]). All security vulnerabilities will be promptly addressed.
## About Rinvex
Rinvex is a software solutions startup, specialized in integrated enterprise solutions for SMEs established in Alexandria, Egypt since June 2016. We believe that our drive The Value, The Reach, and The Impact is what differentiates us and unleash the endless possibilities of our philosophy through the power of software. We like to call it Innovation At The Speed Of Life. That’s how we do our share of advancing humanity.
## License
This software is released under [The MIT License (MIT)](LICENSE).
(c) 2016-2021 Rinvex LLC, Some rights reserved.