added cache expiry

Author: pulkit

README.md

@@ -49,4 +49,28 @@ class Model extends \Eloquent
 
 Caching the model only works with using the `find`, `findMany` or `findOrFail` methods.
 
-If you would like caching behavior like in Laravel 4 then consider using [dwightwatson/rememberable](https://github.com/dwightwatson/rememberable) which adds the `remember` function back into eloquent.
+If you would like caching behavior like in Laravel 4 then consider using [dwightwatson/rememberable](https://github.com/dwightwatson/rememberable) which adds the `remember` function back into eloquent.
+
+You can optinally set the expiry time in minutes for the model, by default it is set to `1440` minutes (24 hours).
+
+```php
+<?php
+
+namespace App;
+
+use PulkitJalan\Cacheable\Cacheable;
+
+class Model extends \Eloquent
+{
+    use Cacheable;
+
+    /**
+     * Set the cache expiry time.
+     *
+     * @var int
+     */
+    public $cacheExpiry = 60;
+}
+```
+
+Models are cached using the models `table name` as the cache tag and the `id` as the key. There are observers which get registered in the trait to also remove from cache when the `updated`, `saved` or `deleted`.

src/Cacheable.php

@@ -7,6 +7,13 @@
 
 trait Cacheable
 {
+    /**
+     * Set the cache expiry time.
+     *
+     * @var int
+     */
+    public $cacheExpiry = 1440;
+
     /**
      * The "booting" method of the model.
      *

src/Eloquent/Builder.php

@@ -15,13 +15,13 @@ class Builder extends IlluminateBuilder
      * @param  array  $columns
      * @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection|null
      */
-    public function find($id, $columns = ['*'], $expire = 60)
+    public function find($id, $columns = ['*'])
     {
         if (is_array($id)) {
             return $this->findMany($id, $columns);
         }
 
-        return Cache::tags($this->model->getTable())->remember($id, $expire, function () use ($id, $columns) {
+        return Cache::tags($this->model->getTable())->remember($id, $this->model->cacheExpiry, function () use ($id, $columns) {
             return parent::find($id, $columns);
         });
     }
@@ -33,40 +33,16 @@ public function find($id, $columns = ['*'], $expire = 60)
      * @param  array  $columns
      * @return \Illuminate\Database\Eloquent\Collection
      */
-    public function findMany($ids, $columns = ['*'], $expire = 60)
+    public function findMany($ids, $columns = ['*'])
     {
         if (empty($ids)) {
             return $this->model->newCollection();
         }
 
         return $this->model->newCollection(
-            Cache::tags($this->model->getTable())->rememberMany($ids, $expire, function ($ids) use ($columns) {
+            Cache::tags($this->model->getTable())->rememberMany($ids, $this->model->cacheExpiry, function ($ids) use ($columns) {
                 return parent::findMany($ids, $columns)->all();
             })
         );
     }
-
-    /**
-     * Find a model by its primary key or throw an exception.
-     *
-     * @param  mixed  $id
-     * @param  array  $columns
-     * @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection
-     *
-     * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
-     */
-    public function findOrFail($id, $columns = ['*'], $expire = 60)
-    {
-        $result = $this->find($id, $columns, $expire);
-
-        if (is_array($id)) {
-            if (count($result) == count(array_unique($id))) {
-                return $result;
-            }
-        } elseif (! is_null($result)) {
-            return $result;
-        }
-
-        throw (new ModelNotFoundException)->setModel(get_class($this->model));
-    }
 }