WIP - cache relationships

Author: mikebronner

README.md

@@ -1 +1,9 @@
-# Laravel-cached-models
+# Laravel-cached-models
+
+## Features
+- automatic relationship caching.
+- automatic cache flushing when models are change.
+- automatic use of cache flags for cache providers that support them (will flush
+  entire cache for providers that don't).
+- provides simple caching methods for use in query methods for models that take
+  advantage of the automatic cache management features mentioned.

src/Builder.php

@@ -0,0 +1,26 @@
+<?php namespace GeneaLabs\LaravelCachableModel\Traits;
+
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+
+class Builder extends EloquentBuilder
+{
+    protected function eagerLoadRelation(array $models, $name, Closure $constraints)
+    {
+        $relation = $this->getRelation($name);
+        $relation->addEagerConstraints($models);
+        $constraints($relation);
+
+        $parentName = str_slug(get_class($relation->getParent()));
+        $childName = str_slug(get_class($relation->getModel()));
+        $results = cache()->tags([$parentName, $childName])
+            ->rememberForever("{$parentName}-{$childName}-relation", function () use ($relation) {
+                return $relation->getEager();
+            });
+
+        return $relation->match(
+            $relation->initRelation($models, $name),
+            $results,
+            $name
+        );
+    }
+}

src/CachedModel.php

@@ -1,11 +1,35 @@
 <?php namespace GeneaLabs\LaravelCachableModel\Traits;
 
-use Illuminate\Database\Eloquent\Model;
+use Closure;
 use Illuminate\Cache\CacheManager;
 use Illuminate\Cache\TaggableStore;
+use Illuminate\Database\Eloquent\Model;
 
 abstract class CachedModel extends Model
 {
+    protected function getRelationshipFromMethod($method)
+    {
+        $relation = $this->$method();
+
+        if (! $relation instanceof Relation) {
+            throw new LogicException(get_class($this).'::'.$method.' must return a relationship instance.');
+        }
+
+        $results = $this->cache([$method])
+            ->rememberForever(str_slug(get_called_class()) . "-{$method}", function () use ($relation) {
+                return $relation->getResults();
+            });
+
+        return tap($results, function ($results) use ($method) {
+            $this->setRelation($method, $results);
+        });
+    }
+
+    public function newEloquentBuilder($query)
+    {
+        return new Builder($query);
+    }
+
     public static function boot()
     {
         parent::boot();
@@ -45,4 +69,3 @@ public static function flushCache()
             ->flush();
     }
 }
-}