Merge pull request #10 from RaubJo/master

Update to allow setting of cache key and subkey

readme.md

@@ -995,10 +995,10 @@ class MostPopularPosts extends Query implements Cacheable
 }
 ```
 
-You can also dynamically call `->ttl($seconds)` on the query builder to customize
-the TTL of the cache results when querying. You can customize `public $key` property
-to set a custom key for the query but by default the value will be generated based
-on a hash of the query itself. This makes unique queries cacheable under separate
+You can also dynamically call `->ttl($seconds)` on the query builder to customize the TTL of the
+cache results when querying. You can customize `public $key` property or call `->key($key)` and
+optionally `->subKey($subKey)` to set a custom key for the query but by default the value will be
+generated based on a hash of the query itself. This makes unique queries cacheable under separate
 auto-generated keys.
 
 ### How to Bust a Cached Query

src/Buses/Cached.php

@@ -125,6 +125,46 @@ public function ttl(int $ttl = null)
         return $this;
     }
 
+    /**
+     * Get or set the cache key.
+     *
+     * @param string|null $key
+     *
+     * @return string|self
+     */
+    public function key(string $key = null)
+    {
+        $runnable = $this->toBase();
+
+        if (is_null($key)) {
+            return (string) $runnable->key;
+        }
+
+        $runnable->key = $key;
+
+        return $this;
+    }
+
+    /**
+     * Get or set the cache sub key.
+     *
+     * @param string|null $subkey
+     *
+     * @return string|self
+     */
+    public function subkey(string $subkey = null)
+    {
+        $runnable = $this->toBase();
+
+        if (is_null($subkey)) {
+            return (string) $runnable->subkey;
+        }
+
+        $runnable->subkey = $subkey;
+
+        return $this;
+    }
+
     /**
      * Run the query outside the cache.
      *
@@ -298,7 +338,7 @@ protected function tags(): array
      *
      * @return string
      */
-    protected function key(): string
+    protected function getKey(): string
     {
         $runnable = $this->toBase();
 
@@ -314,7 +354,7 @@ protected function key(): string
      *
      * @return string
      */
-    protected function subkey(): string
+    protected function getSubkey(): string
     {
         $runnable = $this->toBase();