Backpack\CRUD\app\Library\CrudPanel\Traits\Access

Complexity

Total Complexity

18

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	allowAccess()	0	7	2
A	denyAccess()	0	7	2
A	hasAccessToAll()	0	9	3
A	hasAccessOrFail()	0	7	2
A	getAccessCondition()	0	3	1
A	hasAccessCondition()	0	3	1
A	setAccessCondition()	0	4	2
A	hasAccess()	0	10	2
A	hasAccessToAny()	0	9	3

<?php

namespace Backpack\CRUD\app\Library\CrudPanel\Traits;

use Backpack\CRUD\app\Exceptions\AccessDeniedException;

trait Access
{
    /**
     * Set an operation as having access using the Settings API.
     *
     * @param  string|array  $operation
     * @return bool
     */
    public function allowAccess(array|string $operation) : bool
    {
        foreach ((array) $operation as $op) {
            $this->set($op.'.access', true);

It seems like set() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        return $this->hasAccessToAll($operation);
    }

    /**
     * Disable the access to a certain operation, or the current one.
     *
     * @param  string|array  $operation  [description]
     * @return [type] [description]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

     */
    public function denyAccess(array|string $operation)
    {
        foreach ((array) $operation as $op) {
            $this->set($op.'.access', false);
        }

        return ! $this->hasAccessToAny($operation);
    }

    /**
     * Check if a operation is allowed for a Crud Panel. Return false if not.
     *
     * @param  string  $operation
     * @param  \Model  $entry

The type Model was not found. Maybe you did not declare it correctly or list all dependencies?

     * @return bool
     */
    public function hasAccess(string $operation, $entry = null) : bool
    {
        $condition = $this->get($operation.'.access');

It seems like get() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        if (is_callable($condition)) {
            $entry = $entry ?? $this->getCurrentEntry();

It seems like getCurrentEntry() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return $condition($entry);
        }

        return $condition ?? false;
    }

    /**
     * Check if any operations are allowed for a Crud Panel. Return false if not.
     *
     * @param  string|array  $operation_array
     * @param  \Model  $entry
     * @return bool
     */
    public function hasAccessToAny(array|string $operation_array, $entry = null) : bool
    {
        foreach ((array) $operation_array as $key => $operation) {
            if ($this->hasAccess($operation, $entry) == true) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

                return true;
            }
        }

        return false;
    }

    /**
     * Check if all operations are allowed for a Crud Panel. Return false if not.
     *
     * @param  array  $operation_array  Permissions.
     * @param  \Model  $entry
     * @return bool
     */
    public function hasAccessToAll(array|string $operation_array, $entry = null) : bool
    {
        foreach ((array) $operation_array as $key => $operation) {
            if (! $this->hasAccess($operation, $entry)) {
                return false;
            }
        }

        return true;
    }

    /**
     * Check if a operation is allowed for a Crud Panel. Fail if not.
     *
     * @param  string  $operation
     * @param  \Model  $entry
     * @return bool
     *
     * @throws \Backpack\CRUD\Exception\AccessDeniedException in case the operation is not enabled
     */
    public function hasAccessOrFail(string $operation, $entry = null) : bool
    {
        if (! $this->hasAccess($operation, $entry)) {
            throw new AccessDeniedException(trans('backpack::crud.unauthorized_access', ['access' => $operation]));
        }

        return true;
    }

    /**
     * Get an operation's access condition, if set. A condition
     * can be anything, but usually a boolean or a callable.
     *
     * @param  string  $operation
     * @return bool|callable|null
     */
    public function getAccessCondition(string $operation) : bool|callable|null
    {
        return $this->get($operation.'.access');
    }

    /**
     * Set the condition under which an operation is allowed for a Crud Panel.
     *
     * @param  string|array  $operation
     * @param  bool|callable|null  $condition
     * @return void
     */
    public function setAccessCondition(array|string $operation, bool|callable|null $condition) : void
    {
        foreach ((array) $operation as $op) {
            $this->set($op.'.access', $condition);
        }
    }

    /**
     * Check if an operation has an access condition already set.
     * A condition can be anything, but usually a boolean or a callable.
     *
     * @param  string  $operation
     * @return bool
     */
    public function hasAccessCondition(string $operation) : bool
    {
        return $this->get($operation.'.access') !== null;
    }

}