Merge pull request #9 from rennokki/hotfix/expose-id-on-query-cache

[hotfix] Expose $id on query cache

Author: rennokki

README.md

@@ -253,3 +253,38 @@ class MyCustomBuilder
 In fact, you can also replace any eloquent method within your builder if you use `$this->shouldAvoidCache()` check and retrieve the cached data using `getFromQueryCache()` method, passing the method name as string, and, optionally, an array of columns that defaults to `['*']`.
 
 Notice that the `getFromQueryCache()` method accepts a method name and a `$columns` parameter. If your method doesn't implement the `$columns`, don't pass it.
+
+Note that some functions like `getQueryCacheCallback()` may come with an `$id` parameter.
+The default behaviour of the package doesn't use it, since the query builder uses `->get()` by default that accepts only columns.
+
+However, if your builder replaces functions  like `find()`, `$id` is needed and you will also have to replace the `getQueryCacheCallback()` like so:
+
+```php
+class MyCustomBuilder
+{
+    public function getQueryCacheCallback(string $method = 'get', $columns = ['*'], $id = null)
+    {
+        return function () use ($method, $columns, $id) {
+            $this->avoidCache = true;
+
+            // the function for find() caching
+            // accepts different params
+            if ($method === 'find') {
+                return $this->find($id, $columns);
+            }
+
+            return $this->{$method}($columns);
+        };
+    }
+
+    public function find($id, $columns = ['*'])
+    {
+        // implementing the same logic
+        if (! $this->shouldAvoidCache()) {
+            return $this->getFromQueryCache('find', $columns, $id);
+        }
+
+        return parent::find($id, $columns);
+    }
+}
+```

src/Contracts/QueryCacheModuleInterface.php

@@ -13,4 +13,14 @@ interface QueryCacheModuleInterface
      * @return string
      */
     public function generatePlainCacheKey(string $method = 'get', $id = null, $appends = null): string;
+
+    /**
+     * Get the query cache callback.
+     *
+     * @param  string  $method
+     * @param  array  $columns
+     * @param  string|null  $id
+     * @return \Closure
+     */
+    public function getQueryCacheCallback(string $method = 'get', $columns = ['*'], $id = null);
 }

src/Traits/QueryCacheModule.php

@@ -56,17 +56,18 @@ trait QueryCacheModule
      * Get the cache from the current query.
      *
      * @param  array  $columns
+     * @param  string|null  $id
      * @return array
      */
-    public function getFromQueryCache(string $method = 'get', $columns = ['*'])
+    public function getFromQueryCache(string $method = 'get', $columns = ['*'], $id = null)
     {
         if (is_null($this->columns)) {
             $this->columns = $columns;
         }
 
         $key = $this->getCacheKey('get');
         $cache = $this->getCache();
-        $callback = $this->getQueryCacheCallback($method, $columns);
+        $callback = $this->getQueryCacheCallback($method, $columns, $id);
         $time = $this->getCacheTime();
 
         if ($time instanceof DateTime || $time > 0) {
@@ -81,9 +82,10 @@ public function getFromQueryCache(string $method = 'get', $columns = ['*'])
      *
      * @param  string  $method
      * @param  array  $columns
+     * @param  string|null  $id
      * @return \Closure
      */
-    public function getQueryCacheCallback(string $method = 'get', $columns = ['*'])
+    public function getQueryCacheCallback(string $method = 'get', $columns = ['*'], $id = null)
     {
         return function () use ($method, $columns) {
             $this->avoidCache = true;