App\LaravelRestCms\BaseModel

Complexity

Total Complexity

19

Size/Duplication

Total Lines	193
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	6

Importance

Changes	4
Bugs	2	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getTable()	0	4	1
A	boot()	0	11	4
A	savedEvent()	0	9	1
A	deletingEvent()	0	9	1
A	getSingular()	0	8	3
A	getPlural()	0	8	3
A	formatTableName()	0	4	1
B	validate()	0	20	5

<?php namespace App\LaravelRestCms;

use Illuminate\Contracts\Validation\ValidationException;
use Illuminate\Database\Query\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Foundation\Validation\ValidatesRequests;
use Illuminate\Support\MessageBag;
use Illuminate\Support\Pluralizer;
use Illuminate\Support\Singular;

/**
 * Class BaseModel
 * 
 * @method \Illuminate\Database\Query\Builder whereIn(string $column, mixed $values, string $boolean, bool $not)
 */
abstract class BaseModel extends Model {

	use CacheTrait;
	use SearchTrait;
	use ValidatesRequests;

	/**
	 * The table name
	 * 
	 * @var string
	 */
	protected $table;
	
	/**
	 * The singular version of the table name
	 * 
	 * @var string
	 */
	protected $singular;
	
	/**
	 * The plural version of the table name
	 * 
	 * @var string
	 */
	protected $plural;

	/**
	 * The Validator object
	 * 
	 * @var \Validator
	 */
	protected $validation;

	/**
	 * Rules to validate when creating a model
	 * 
	 * @var array
	 */
	protected static $createRules;

	/**
	 * Rules to validate when updating a model
	 * 
	 * @var array
	 */
	protected static $updateRules;

	/**
	 * Rules to validate when updating a model, which concatenates with static::$createRules
	 * Overide this if using different PKs
	 * Ignored if static::$updateRules is populated
	 * 
	 * @var array
	 */
	protected static $updateRulesConcat = [	
		'id' => 'required|integer'
	];

	/**
	 * Indicates if the model should be attributed with created_by and updated_by
	 * 
	 * @var bool
	 */
	public $attirbution = false;

	/**
	 * The "booting" method of the model.
	 *
	 * @return void
	 */
	protected static function boot()
	{
		if (!is_null(static::$updateRules) && !is_null(static::$updateRulesConcat) && sizeof(static::$updateRulesConcat)) {
			static::$updateRules = static::$createRules + static::$updateRulesConcat; 
		}

		parent::boot();

		static::savedEvent();
		static::deletingEvent();
	}	 
	
	/**
	 * Gets the table name of the model
	 * Override this for custom names to be used in the caching engine
	 * 
	 * @return string
	 */
	public function getTable()
	{
		return $this->table;
	}

	/**
	 * Hooks into the "saved" event
	 * 
	 * @return void
	 */
	protected static function savedEvent()
	{
		static::saved(function($model)
		{
			static::addToCache($model);

			return true;
		});
	}

	/**
	 * Hooks into the "deleting" event
	 * 
	 * @return void
	 */
	protected static function deletingEvent()
	{
		static::deleting(function($model)
		{
		   static::removeFromCache($model);

			return true;
		});
	}
	
	/**
	 * Retrieves the singular name of the table
	 * 
	 * @param  boolean $format
	 * @return string
	 */
	public function getSingular($format = false)
	{
		if (!isset($this->singular)) {
			$this->singular = Pluralizer::singular($this->table);
		}

		return $format ? $this->formatTableName($this->singular) : $this->singular;
	}	
	
	/**
	 * Retrieves the plural name of the table
	 * 
	 * @param  boolean $format
	 * @return string
	 */
	public function getPlural($format = false)
	{
		if (!isset($this->plural)) {
			$this->plural = Pluralizer::plural($this->table);
		}

		return $format ? $this->formatTableName($this->plural) : $this->plural;
	}
	
	/**
	 * Formats the table name into a human readable format
	 * 
	 * @param  string $name
	 * @return string
	 */
	protected static function formatTableName($name)
	{
		return ucwords(str_replace('_', ' ', $name));
	}
	
	/**
	 * Validates a model
	 * 
	 * @param  array  	$data     
	 * @param  boolean 	$isUpdate 
	 * @return boolean            
	 */
	public function validate($data, $isUpdate = false)
	{
		if ($isUpdate) {
			$rules = static::$updateRules;
		} else {
			$rules = static::$createRules;
		}

		if (is_null($rules)) {
			throw new \Exception(new MessageBag(['Could not find ' . ($isUpdate ? 'update' : 'create') . ' rules for ' . get_class($this)]));
		}

		$this->validation = \Validator::make($data, $rules);
		
		if (!$this->validation->passes()) {
			throw new ValidationException(new MessageBag($this->validation->errors()->all()));
		}

		return true;
	}
}