File "IsAbility.php"

Full Path: /home/pulsehostuk9/public_html/invoicer.pulsehost.co.uk/vendor/silber/bouncer/src/Database/Scope/IsAbility.php
File size: 5.97 KB
MIME-type: text/x-php
Charset: utf-8

<?php

namespace Silber\Bouncer\Database\Concerns;

use App\User;
use Illuminate\Database\Eloquent\Relations\MorphToMany;
use Silber\Bouncer\Constraints\constrainer;
use Silber\Bouncer\Constraints\Group;
use Silber\Bouncer\Database\Models;
use Silber\Bouncer\Database\Queries\AbilitiesForModel;
use Silber\Bouncer\Database\Role;
use Silber\Bouncer\Database\Scope\TenantScope;
use Silber\Bouncer\Database\Titles\AbilityTitle;

trait IsAbility
{
    /**
     * Boot the is ability trait.
     *
     * @return void
     */
    public static function bootIsAbility()
    {
        TenantScope::register(static::class);

        static::creating(function ($ability) {
            Models::scope()->applyToModel($ability);

            if (is_null($ability->title)) {
                $ability->title = AbilityTitle::from($ability)->toString();
            }
        });
    }

    /**
     * Get the options attribute.
     *
     * @return array
     */
    public function getOptionsAttribute()
    {
        if (empty($this->attributes['options'])) {
            return [];
        }

        return json_decode($this->attributes['options'], true);
    }

    /**
     * Set the "options" attribute.
     *
     * @return void
     */
    public function setOptionsAttribute(array $options)
    {
        $this->attributes['options'] = json_encode($options);
    }

    /**
     * CHecks if the ability has constraints.
     *
     * @return bool
     */
    public function hasConstraints()
    {
        return ! empty($this->options['constraints']);
    }

    /**
     * Get the ability's constraints.
     *
     * @return \Silber\Bouncer\Constraints\Constrainer
     */
    public function getConstraints()
    {
        if (empty($this->options['constraints'])) {
            return new Group();
        }

        $data = $this->options['constraints'];

        return $data['class']::fromData($data['params']);
    }

    /**
     * Set the ability's constraints.
     *
     * @return $this
     */
    public function setConstraints(Constrainer $constrainer)
    {
        $this->options = array_merge($this->options, [
            'constraints' => $constrainer->data(),
        ]);

        return $this;
    }

    /**
     * Create a new ability for a specific model.
     *
     * @param  \Illuminate\Database\Eloquent\Model|string  $model
     * @param  string|array  $attributes
     * @return static
     */
    public static function createForModel($model, $attributes)
    {
        $model = static::makeForModel($model, $attributes);

        $model->save();

        return $model;
    }

    /**
     * Make a new ability for a specific model.
     *
     * @param  \Illuminate\Database\Eloquent\Model|string  $model
     * @param  string|array  $attributes
     * @return static
     */
    public static function makeForModel($model, $attributes)
    {
        if (is_string($attributes)) {
            $attributes = ['name' => $attributes];
        }

        if ($model === '*') {
            return (new static)->forceFill($attributes + [
                'entity_type' => '*',
            ]);
        }

        if (is_string($model)) {
            $model = new $model;
        }

        return (new static)->forceFill($attributes + [
            'entity_type' => $model->getMorphClass(),
            'entity_id' => $model->exists ? $model->getKey() : null,
        ]);
    }

    /**
     * The roles relationship.
     */
    public function roles(): MorphToMany
    {
        $relation = $this->morphedByMany(
            Models::classname(Role::class),
            'entity',
            Models::table('permissions')
        )->withPivot('forbidden', 'scope');

        return Models::scope()->applyToRelation($relation);
    }

    /**
     * The users relationship.
     */
    public function users(): MorphToMany
    {
        $relation = $this->morphedByMany(
            Models::classname(User::class),
            'entity',
            Models::table('permissions')
        )->withPivot('forbidden', 'scope');

        return Models::scope()->applyToRelation($relation);
    }

    /**
     * Get the identifier for this ability.
     *
     * @return string
     */
    final public function getIdentifierAttribute()
    {
        $slug = $this->attributes['name'];

        if ($this->attributes['entity_type'] !== null) {
            $slug .= '-'.$this->attributes['entity_type'];
        }

        if ($this->attributes['entity_id'] !== null) {
            $slug .= '-'.$this->attributes['entity_id'];
        }

        if ($this->attributes['only_owned']) {
            $slug .= '-owned';
        }

        return strtolower($slug);
    }

    /**
     * Get the ability's "slug" attribute.
     *
     * @return string
     */
    public function getSlugAttribute()
    {
        return $this->getIdentifierAttribute();
    }

    /**
     * Constrain a query to having the given name.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder  $query
     * @return string|array $name
     * @return bool $strict
     * @return void
     */
    public function scopeByName($query, $name, $strict = false)
    {
        $names = (array) $name;

        if (! $strict && $name !== '*') {
            $names[] = '*';
        }

        $query->whereIn("{$this->table}.name", $names);
    }

    /**
     * Constrain a query to simple abilities.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder  $query
     * @return void
     */
    public function scopeSimpleAbility($query)
    {
        $query->whereNull("{$this->table}.entity_type");
    }

    /**
     * Constrain a query to an ability for a specific model.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder  $query
     * @param  \Illuminate\Database\Eloquent\Model|string  $model
     * @param  bool  $strict
     * @return void
     */
    public function scopeForModel($query, $model, $strict = false)
    {
        (new AbilitiesForModel)->constrain($query, $model, $strict);
    }
}