Initial work on improving cache helpers.

Author: scottboms

classes/Feed.php

@@ -11,6 +11,7 @@
 use Kirby\Toolkit\Collection;
 use Kirby\Toolkit\Obj;
 use Kirby\Toolkit\Str;
+use Scottboms\Mastodon\Helpers\CacheKey;
 
 use function option;
 
@@ -56,7 +57,7 @@ private function __construct(array $options = []) {
 	protected function getUserId(): ?string
 	{
 		$cache = kirby()->cache('scottboms.mastodon');
-		$cacheKey = 'userid-' . $this->options['username'] . '@' . $this->options['server'];
+		$cacheKey = CacheKey::forUserId($this->options['username'], $this->options['server']);
 
 		// return cached id if available
 		if ($userId = $cache->get($cacheKey)) {
@@ -100,7 +101,7 @@ public static function build(array $options = []): self
 	public function getAccountInfo(): array
 	{
 		$cache = kirby()->cache('scottboms.mastodon');
-		$cacheKey = 'account-info-' . $this->options['username'] . '@' . $this->options['server'];
+		$cacheKey = CacheKey::forAccountInfo($this->options['username'], $this->options['server']);
 
 		// try to return cached account info
 		if ($cached = $cache->get($cacheKey)) {
@@ -167,13 +168,19 @@ public function buildFeedUrl(): string
     return $feedUrl;
   }
 
-  public static function getFeed($feedUrl): array|string
+  public static function getFeed($feedUrl, array $options = []): array|string
 	{
 		// fetch and decode the json data
 		// see: https://getkirby.com/docs/reference/objects/http/remote/get
 		// and https://getkirby.com/docs/reference/objects/http/remote/request
-		$cacheKey = static::resolveCacheKey();
-		$cache = kirby()->cache('scottboms.mastodon');
+
+    $instance = static::build($options);
+    $cache = kirby()->cache('scottboms.mastodon');
+
+    $server = $instance->options['server'];
+    $userId = $instance->options['userid'];
+
+		$cacheKey = CacheKey::forFeed($server, $userId);
 
 		// try to get cached feed
 		if ($cached = $cache->get($cacheKey)) {
@@ -187,7 +194,7 @@ public static function getFeed($feedUrl): array|string
 			$json_data = $request->json();
 
 			// store in cache, e.g., for 15 minutes
-			$ttl = option('scottboms.mastodon.cachettl', 900); // 15 min default
+			$ttl = $instance->options['cachettl'] ?? 900;
 			$cache->set($cacheKey, $json_data, $ttl);
 
 			return $json_data;
@@ -201,11 +208,16 @@ public static function getFeed($feedUrl): array|string
 	/*
 	 * @var Bool
 	 */
-	public static function clearFeedCache(): bool
+	public static function clearFeedCache(array $options = []): bool
 	{
-		$cacheKey = static::resolveCacheKey();
+		$instance = static::build($options);
 		$cache = kirby()->cache('scottboms.mastodon');
 
+		$server = $instance->options['server'];
+		$userId = $instance->options['userid'];
+
+		$cacheKey = CacheKey::forFeed($server, $userId);
+
 		return $cache->remove($cacheKey);
 	}
 

index.php

@@ -12,7 +12,8 @@
 **/
 
 load([
-	'Scottboms\Mastodon\Feed' => __DIR__ . '/classes/Feed.php'
+	'Scottboms\Mastodon\Feed' => __DIR__ . '/classes/Feed.php',
+	'Scottboms\Mastodon\Helpers\CacheKey' => __DIR__ . '/src/Helpers/CacheKey.php',
 ]);
 
 use Scottboms\Mastodon\Feed;
@@ -47,6 +48,11 @@
 		'api' => [
 			'routes' => require __DIR__ . '/lib/routes.php'
 		],
+		'autoload' => [
+			'psr-4' => [
+				'Scottboms\\Mastodon\\' => __DIR__ . '/src',
+			]
+		],
 		'areas' => [
 			'mastodon-feed' => function ($kirby) {
 				return [

src/Helpers/CacheKey.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Scottboms\Mastodon\Helpers;
+
+use Exception;
+
+class CacheKey
+{
+	public static function forFeed(string $server, string $userId): string
+	{
+		if (empty($server) || empty($userId)) {
+			throw new Exception('Cannot resolve feed cache key: missing server or userId.');
+		}
+
+		return "mastodon-feed-{$server}-{$userId}";
+	}
+
+	public static function forUserId(string $username, string $server): string
+	{
+		if (empty($username) || empty($server)) {
+			throw new Exception('Cannot resolve userid cache key: missing username or server.');
+		}
+
+		return "userid-{$username}@{$server}";
+	}
+
+	public static function forAccountInfo(string $username, string $server): string
+	{
+		if (empty($username) || empty($server)) {
+			throw new Exception('Cannot resolve account info cache key: missing username or server.');
+		}
+
+		return "account-info-{$username}@{$server}";
+	}
+}