<?php
namespace Silber\Bouncer\Database;
use App\User;
use Closure;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\Relation;
use Illuminate\Database\Query\Builder;
use Silber\Bouncer\Contracts\Scope as ScopeContract;
use Silber\Bouncer\Database\Scope\Scope;
class Models
{
/**
* Map of bouncer's models.
*
* @var array
*/
protected static $models = [];
/**
* Map of ownership for models.
*
* @var array
*/
protected static $ownership = [];
/**
* Map of bouncer's tables.
*
* @var array
*/
protected static $tables = [];
/**
* The model scoping instance.
*
* @var \Silber\Bouncer\Database\Scope\Scope
*/
protected static $scope;
/**
* Set the model to be used for abilities.
*
* @param string $model
* @return void
*/
public static function setAbilitiesModel($model)
{
static::$models[Ability::class] = $model;
static::updateMorphMap([$model]);
}
/**
* Set the model to be used for roles.
*
* @param string $model
* @return void
*/
public static function setRolesModel($model)
{
static::$models[Role::class] = $model;
static::updateMorphMap([$model]);
}
/**
* Set the model to be used for users.
*
* @param string $model
* @return void
*/
public static function setUsersModel($model)
{
static::$models[User::class] = $model;
static::$tables['users'] = static::user()->getTable();
}
/**
* Set custom table names.
*
* @return void
*/
public static function setTables(array $map)
{
static::$tables = array_merge(static::$tables, $map);
static::updateMorphMap();
}
/**
* Get a custom table name mapping for the given table.
*
* @param string $table
* @return string
*/
public static function table($table)
{
if (isset(static::$tables[$table])) {
return static::$tables[$table];
}
return $table;
}
/**
* Get or set the model scoping instance.
*
* @return mixed
*/
public static function scope(?ScopeContract $scope = null)
{
if (! is_null($scope)) {
return static::$scope = $scope;
}
if (is_null(static::$scope)) {
static::$scope = new Scope;
}
return static::$scope;
}
/**
* Get the classname mapping for the given model.
*
* @param string $model
* @return string
*/
public static function classname($model)
{
if (isset(static::$models[$model])) {
return static::$models[$model];
}
return $model;
}
/**
* Update Eloquent's morph map with the Bouncer models and tables.
*
* @param array|null $classNames
* @return void
*/
public static function updateMorphMap($classNames = null)
{
if (is_null($classNames)) {
$classNames = [
static::classname(Role::class),
static::classname(Ability::class),
];
}
Relation::morphMap($classNames);
}
/**
* Register an attribute/callback to determine if a model is owned by a given authority.
*
* @param string|\Closure $model
* @param string|\Closure|null $attribute
* @return void
*/
public static function ownedVia($model, $attribute = null)
{
if (is_null($attribute)) {
static::$ownership['*'] = $model;
}
static::$ownership[$model] = $attribute;
}
/**
* Determines whether the given model is owned by the given authority.
*
* @return bool
*/
public static function isOwnedBy(Model $authority, Model $model)
{
$type = get_class($model);
if (isset(static::$ownership[$type])) {
$attribute = static::$ownership[$type];
} elseif (isset(static::$ownership['*'])) {
$attribute = static::$ownership['*'];
} else {
$attribute = strtolower(static::basename($authority)).'_id';
}
return static::isOwnedVia($attribute, $authority, $model);
}
/**
* Determines ownership via the given attribute.
*
* @param string|\Closure $attribute
* @return bool
*/
protected static function isOwnedVia($attribute, Model $authority, Model $model)
{
if ($attribute instanceof Closure) {
return $attribute($model, $authority);
}
return $authority->getKey() == $model->{$attribute};
}
/**
* Get an instance of the ability model.
*
* @return \Silber\Bouncer\Database\Ability
*/
public static function ability(array $attributes = [])
{
return static::make(Ability::class, $attributes);
}
/**
* Get an instance of the role model.
*
* @return \Silber\Bouncer\Database\Role
*/
public static function role(array $attributes = [])
{
return static::make(Role::class, $attributes);
}
/**
* Get an instance of the user model.
*
* @return \Illuminate\Database\Eloquent\Model
*/
public static function user(array $attributes = [])
{
return static::make(User::class, $attributes);
}
/**
* Get a new query builder instance.
*
* @param string $table
* @return \Illuminate\Database\Query\Builder
*/
public static function query($table)
{
$query = new Builder(
$connection = static::user()->getConnection(),
$connection->getQueryGrammar(),
$connection->getPostProcessor()
);
return $query->from(static::table($table));
}
/**
* Reset all settings to their original state.
*
* @return void
*/
public static function reset()
{
static::$models = static::$tables = static::$ownership = [];
}
/**
* Get an instance of the given model.
*
* @param string $model
* @return \Illuminate\Database\Eloquent\Model
*/
protected static function make($model, array $attributes = [])
{
$model = static::classname($model);
return new $model($attributes);
}
/**
* Get the basename of the given class.
*
* @param string|object $class
* @return string
*/
protected static function basename($class)
{
if (! is_string($class)) {
$class = get_class($class);
}
$segments = explode('\\', $class);
return end($segments);
}
}