Cached some model properties and remove useless eager loading (#253)
* Cached some model properties and remove useless eager loading * Remove ray call * Remove double loading of forms * Add disableCache feature when needed
This commit is contained in:
112
app/Models/Traits/CachesAttributes.php
Normal file
112
app/Models/Traits/CachesAttributes.php
Normal file
@@ -0,0 +1,112 @@
|
||||
<?php
|
||||
|
||||
namespace App\Models\Traits;
|
||||
|
||||
use Closure;
|
||||
use Illuminate\Contracts\Cache\Factory as CacheFactoryContract;
|
||||
use Illuminate\Contracts\Cache\Repository as CacheRepository;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use InvalidArgumentException;
|
||||
|
||||
/**
|
||||
* @property string|null $attributeCachePrefix
|
||||
* @property string|null $attributeCacheStore
|
||||
* @property string[]|null $cachableAttributes
|
||||
*
|
||||
* @mixin Model
|
||||
*/
|
||||
trait CachesAttributes
|
||||
{
|
||||
/** @var array<string, mixed> */
|
||||
protected $attributeCache = [];
|
||||
|
||||
protected $disabledCache = [];
|
||||
|
||||
public static function bootCachesAttributes(): void
|
||||
{
|
||||
static::deleting(function (Model $model): void {
|
||||
/** @var Model|CachableAttributes $model */
|
||||
$model->flush();
|
||||
});
|
||||
}
|
||||
|
||||
public function disableCache($key)
|
||||
{
|
||||
$this->disabledCache[] = $key;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function remember(string $attribute, ?int $ttl, Closure $callback)
|
||||
{
|
||||
if (in_array($attribute, $this->disabledCache)) {
|
||||
return value($callback);
|
||||
}
|
||||
|
||||
if ($ttl === 0 || ! $this->exists) {
|
||||
if (! isset($this->attributeCache[$attribute])) {
|
||||
$this->attributeCache[$attribute] = value($callback);
|
||||
}
|
||||
|
||||
return $this->attributeCache[$attribute];
|
||||
}
|
||||
|
||||
if ($ttl === null) {
|
||||
return $this->getCacheRepository()->rememberForever($this->getCacheKey($attribute), $callback);
|
||||
}
|
||||
|
||||
if ($ttl < 0) {
|
||||
throw new InvalidArgumentException("The TTL has to be null, 0 or any positive number - you provided `{$ttl}`.");
|
||||
}
|
||||
|
||||
return $this->getCacheRepository()->remember($this->getCacheKey($attribute), $ttl, $callback);
|
||||
}
|
||||
|
||||
public function rememberForever(string $attribute, Closure $callback)
|
||||
{
|
||||
return $this->remember($attribute, null, $callback);
|
||||
}
|
||||
|
||||
public function forget(string $attribute): bool
|
||||
{
|
||||
unset($this->attributeCache[$attribute]);
|
||||
|
||||
if (! $this->exists) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return $this->getCacheRepository()->forget($this->getCacheKey($attribute));
|
||||
}
|
||||
|
||||
public function flush(): bool
|
||||
{
|
||||
$result = true;
|
||||
|
||||
foreach ($this->cachableAttributes ?? [] as $attribute) {
|
||||
$result = $this->forget($attribute) ? $result : false;
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
protected function getCacheKey(string $attribute): string
|
||||
{
|
||||
return implode('.', [
|
||||
$this->attributeCachePrefix ?? 'model_attribute_cache',
|
||||
$this->getConnectionName() ?? 'connection',
|
||||
$this->getTable(),
|
||||
$this->getKey(),
|
||||
$attribute,
|
||||
$this->updated_at?->timestamp ?? '0'
|
||||
]);
|
||||
}
|
||||
|
||||
protected function getCacheRepository(): CacheRepository
|
||||
{
|
||||
return $this->getCacheFactory()->store($this->attributeCacheStore);
|
||||
}
|
||||
|
||||
protected function getCacheFactory(): CacheFactoryContract
|
||||
{
|
||||
return app('cache');
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user