App\LaravelRestCms\CacheTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	4
Bugs	1	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	bootCacheTrait()	0	4	1
A	addToCache()	0	4	1
A	removeFromCache()	0	4	1
A	getCache()	0	6	1
A	getModelCache()	0	4	1
A	getCacheKey()	0	8	2
A	cache()	0	8	1

<?php namespace App\LaravelRestCms;

trait CacheTrait {

	/**
	 * The key to use to cache this model
	 * 
	 * @var string
	 */
	public static $cacheKeyPart = 'id';
    
	/**
	 * The number of minutes to cache
	 * 
	 * @var int
	 */
	public static $cacheTime = 3600; 
        
    
	/**
	 * Tie caching features into the Eloquent::boot() method
	 */
	public static function bootCacheTrait()
	{
		static::$cacheTime = \Config::get('laravel-rest-cms.cacheTime');
	}

	/**
	 * Adds a model to the cache
	 * 
	 * @param  string   $model      The name of the model
	 * @return void
	 */
	protected static function addToCache($model)
	{
		$model::cache($model, $model->{$model::$cacheKeyPart}, $model::getModelCache($model));
	}

	/**
	 * Removes a model from the cache
	 * 
	 * @param  string   $model      The name of the model
	 * @return void
	 */
	protected static function removeFromCache($model)
	{
		\Cache::forget($model::getCacheKey($model));
	}

	/**
	 * Retrieves the model
	 * Override this function to create a custom cache with eager loading
	 * 
	 * @param  string $model The name of the model
	 * @return string
	 */
	public static function getModelCache($model)
	{
		return $model;
	}       
    
	/**
	 * Caches a model
	 * 
	 * @param  string   $model      The name of the model
	 * @param  string   $keyPart    The key to use to cache the model (e.g. primary key)
	 * @param  \App\LaravelRestCms\BaseModel $data   The model instance
	 * @return string
	 */
	public static function cache($model, $keyPart, $data)
	{
		$key = static::getCacheKey($model, $keyPart);
		\Cache::forget($key);
		\Cache::put($key, $data, static::$cacheTime);
        
		return $model;
	}       
    
	/**
	 * Caches a model
	 * 
	 * @param  string   $model      The name of the model
	 * @param  string   $keyPart    The key to use to cache the model (e.g. primary key)
	 * @return string
	 */
	public static function getCache($model, $keyPart)
	{
		$key = static::getCacheKey($model, $keyPart);
        
		return \Cache::get($key);
	}
    
	/**
	 * Gets the cache key for a model
	 * 
	 * @param  string   $model      The name of the model
	 * @param  string   $keyPart    The key to use to cache the model (e.g. primary key)
	 * @return string
	 */
	public static function getCacheKey($model, $keyPart = null)
	{
		if (is_null($keyPart)) {
			$keyPart = static::$cacheKeyPart;
		}
        
		return with(new $model)->getTable() . '.' . $keyPart;
	}
}