Charcoal\User\Acl\Manager

Complexity

Total Complexity

17

Size/Duplication

Total Lines	109
Duplicated Lines	18.35 %

Coupling/Cohesion

Components	0
Dependencies	4

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	loadPermissions()	0	6	2
B	loadDatabasePermissions()	0	29	3
C	addRoleAndPermissions()	20	36	11

<?php

namespace Charcoal\User\Acl;

// Dependencies from `ext-pdo`
use PDO;
use PDOException;

// Dependencies from 'PSR-3' (Logging)
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;

// Dependencies from `zendframework/zend-permissions`
use Zend\Permissions\Acl\Acl;
use Zend\Permissions\Acl\Role\GenericRole as Role;

This use statement conflicts with another class in this namespace, Charcoal\User\Acl\Role.

use Zend\Permissions\Acl\Resource\GenericResource as Resource;

/**
 * Manage ACL roles and permissions from config (arrays) or database.
 */
class Manager implements LoggerAwareInterface
{
    use LoggerAwareTrait;

    /**
     * Constructor options:
     * - `logger`
     *
     * @param array $data Constructor options.
     */
    public function __construct(array $data)
    {
        $this->setLogger($data['logger']);
    }

    /**
     * @param Acl    $acl         The Zend Acl instant to load permissions to.
     * @param array  $permissions The array of permissions, in [role=>details] array.
     * @param string $resource    The Acl resource (string identifier) to load roles and permissions into.
     * @return void
     */
    public function loadPermissions(Acl &$acl, array $permissions, $resource = '')
    {
        foreach ($permissions as $role => $rolePermissions) {
            $this->addRoleAndPermissions($acl, $role, $rolePermissions, $resource);
        }
    }

    /**
     * @param Acl    $acl      The Zend Acl instance to load permissions to.
     * @param PDO    $db       The PDO database instance.
     * @param string $table    The table where to fetch the roles and permissions.
     * @param string $resource The Acl resource (string identifier) to load roles and permissions into.
     * @return void
     */
    public function loadDatabasePermissions(Acl &$acl, PDO $db, $table, $resource = '')
    {
        // Quick-and-dirty sanitization
        $table = preg_replace('/[^A-Za-z0-9 ]/', '', $table);

        $q = '
            SELECT
                `ident`,
                `parent`,
                `denied`,
                `allowed`,
                `superuser`
            FROM
                `'.$table.'`
            ORDER BY
                `position` ASC';

        $this->logger->debug($q);

        // Put inside a try-catch block because ACL is optional; table might not exist.
        try {
            $sth = $db->query($q);
            while ($row = $sth->fetch(PDO::FETCH_ASSOC)) {
                $this->addRoleAndPermissions($acl, $row['ident'], $row, $resource);
            }
        } catch (PDOException $e) {
            $this->logger->warning('Can not fetch ACL roles: '.$e->getMessage());
        }
    }

    /**
     * @param Acl    $acl         The Zend Acl instant to add permissions to.
     * @param string $role        The role (string identifier) to add.
     * @param array  $permissions The permissions details (array) to add.
     * @param string $resource    The Acl resource (string identifier) to add roles and permissions into.
     * @return void
     */
    private function addRoleAndPermissions(Acl &$acl, $role, array $permissions, $resource)
    {
        if (!$acl->hasRole($role)) {
            // Add role
            $parentRole = isset($permissions['parent']) ? $permissions['parent'] : null;
            $newRole = new Role($role);
            $acl->addRole($newRole, $parentRole);
        }

        if (isset($permissions['superuser']) && $permissions['superuser']) {
            $acl->allow($role);
            return;
        }

        if (isset($permissions['allowed'])) {

This code seems to be duplicated across your project.

            if (is_string($permissions['allowed'])) {
                $allowedPermissions = explode(',', $permissions['allowed']);
            } else {
                $allowedPermissions = $permissions['allowed'];
            }
            foreach ($allowedPermissions as $allowed) {
                $acl->allow($role, $resource, $allowed);
            }
        }

        if (isset($permissions['denied'])) {

This code seems to be duplicated across your project.

            if (is_string($permissions['denied'])) {
                $deniedPermissions = explode(',', $permissions['denied']);
            } else {
                $deniedPermissions = $permissions['denied'];
            }
            foreach ($deniedPermissions as $denied) {
                $acl->deny($role, $resource, $denied);
            }
        }
    }
}