Download the PHP package beep/cachoid without Composer
On this page you can find all versions of the php package beep/cachoid. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package cachoid
Short Description Cachoid provides an expressive API for caching models, collections, and paginators.
License MIT
Informations about the package cachoid
Cachoid
Cachoid provides an expressive API for caching models, collections, and paginators, utilizing the Laravel Taggable Cache Stores.
Documentation is currently under work.
Installation
First, install Cachoid via the Composer Package manager:
Next, you should add the CachoidServiceProvider
to the providers
array of your config/app.php
configuration file:
If Cachoid
facade usage is preferred, add to the aliases
array of your config/app.php
:
Finally, add the Beep\Cachoid\Cacheable
trait to the model you would like to make cacheable. This trait will register a model observer to keep the model synchronized with Cachoid:
Configuration
Configuring Model Identifiers
By default, each Eloquent model is synced by its model identifier, and through the Cache driver. If you would like to customize the identifier, you may override the cacheableAs
method on the Model.
Eloquent Models
Retrieving Models by Identifier
remember
allows us to easily cache an Eloquent model. When a record is fresh, it will instead retrieve it:
Or more simply put:
Paginators
remember
and rememberForever
allow us to easily cache an entire paginator of data (e.g. Eloquent Models). When models are within the paginator, they are uniquely tagged with a lowercase, snake cased name of the class hyphenated with the identifer.
The remember
method will cache the paginator unless it already exists in the cache.
Of course, you may add uniqueness such as the page and results per page.
Or more simply put...
Collections
Section ToDo
ToDo
- Documentation clean-up.
- An extensive set of tests, with Mockery, and a build-up of the SQLite "feature" tests (such as ModelObserverTest)
- Current page resolution for the PaginatorAdapter.
All versions of cachoid with dependencies
illuminate/cache Version ^5.4
illuminate/database Version ^5.4
mockery/mockery Version ^0.9.9