PhpAbac\Manager\AttributeManager

Complexity

Total Complexity

18

Size/Duplication

Total Lines	144
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

91.8%

Importance

Changes	18
Bugs	2	Features	7

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getAttribute()	0	13	2
A	getClassicAttribute()	0	9	1
A	getEnvironmentAttribute()	0	9	1
A	retrieveAttribute()	0	11	4
A	retrieveClassicAttribute()	0	13	3
A	retrieveEnvironmentAttribute()	0	3	1
A	getDynamicAttribute()	0	7	2
A	slugify()	0	15	3

<?php

namespace PhpAbac\Manager;

use PhpAbac\Model\AbstractAttribute;
use PhpAbac\Model\Attribute;
use PhpAbac\Model\EnvironmentAttribute;

class AttributeManager
{
    /** @var array **/
    private $attributes;

    /**
     * @param array $attributes
     */
    public function __construct($attributes)
    {
        $this->attributes = $attributes;
    }
    
    /**
     * @param string $attributeId
     * @return \PhpAbac\Model\AbstractAttribute
     */
    public function getAttribute($attributeId) {
        $attributeKeys = explode('.', $attributeId);
        // The first element will be the attribute ID, then the field ID
        $attributeId = array_shift($attributeKeys);
        $attributeName = implode('.', $attributeKeys);
        // The field ID is also the attribute object property
        $attributeData = $this->attributes[$attributeId];
        return
            ($attributeId === 'environment')
            ? $this->getEnvironmentAttribute($attributeData, $attributeName)
            : $this->getClassicAttribute($attributeData, $attributeName)
        ;
    }
    
    /**
     * @param array $attributeData
     * @param string $property
     * @return \PhpAbac\Model\Attribute
     */
    private function getClassicAttribute($attributeData, $property) {
        return
            (new Attribute())

It seems like you code against a specific sub-type and not the parent class PhpAbac\Model\AbstractAttribute as the method setProperty() does only exist in the following sub-classes of PhpAbac\Model\AbstractAttribute: PhpAbac\Model\Attribute. Maybe you want to instanceof check for one of these explicitly?

            ->setName($attributeData['fields'][$property]['name'])
            ->setType($attributeData['type'])
            ->setProperty($property)
            ->setSlug($this->slugify($attributeData['fields'][$property]['name']))
        ;
    }
    
    /**
     * @param array $attributeData
     * @param string $key
     * @return \PhpAbac\Model\EnvironmentAttribute
     */
    private function getEnvironmentAttribute($attributeData, $key) {
        return
            (new EnvironmentAttribute())

It seems like you code against a specific sub-type and not the parent class PhpAbac\Model\AbstractAttribute as the method setVariableName() does only exist in the following sub-classes of PhpAbac\Model\AbstractAttribute: PhpAbac\Model\EnvironmentAttribute. Maybe you want to instanceof check for one of these explicitly?

            ->setName($attributeData[$key]['name'])
            ->setType('environment')
            ->setVariableName($attributeData[$key]['variable_name'])
            ->setSlug($this->slugify($attributeData[$key]['name']))
        ;
    }

    /**
     * @param AbstractAttribute $attribute
     * @param string $attributeType

There is no parameter named $attributeType. Did you maybe mean $attribute?

     * @param object $user
     * @param object $object
     * @return mixed
     */
    public function retrieveAttribute(AbstractAttribute $attribute, $user, $object = null)
    {
        switch($attribute->getType()) {

Expected 1 space after SWITCH keyword; 0 found

            case 'user':
                return $this->retrieveClassicAttribute($attribute, $user);

$attribute of type object<PhpAbac\Model\AbstractAttribute> is not a sub-type of object<PhpAbac\Model\Attribute>. It seems like you assume a child class of the class PhpAbac\Model\AbstractAttribute to be always present.

            case 'resource':
                return $this->retrieveClassicAttribute($attribute, $object);

$attribute of type object<PhpAbac\Model\AbstractAttribute> is not a sub-type of object<PhpAbac\Model\Attribute>. It seems like you assume a child class of the class PhpAbac\Model\AbstractAttribute to be always present.

It seems like $object defined by parameter $object on line 77 can also be of type null; however, PhpAbac\Manager\AttributeManager::retrieveClassicAttribute() does only seem to accept object, maybe add an additional type check?

            case 'environment':
                return $this->retrieveEnvironmentAttribute($attribute);

$attribute of type object<PhpAbac\Model\AbstractAttribute> is not a sub-type of object<PhpAbac\Model\EnvironmentAttribute>. It seems like you assume a child class of the class PhpAbac\Model\AbstractAttribute to be always present.

        }
    }

    /**
     * @param Attribute $attribute
     * @param object $object
     * @return mixed
     */
    private function retrieveClassicAttribute(Attribute $attribute, $object)
    {
        $propertyPath = explode('.', $attribute->getProperty());
        $propertyValue = $object;
        foreach($propertyPath as $property) {

Expected 1 space after FOREACH keyword; 0 found

            $getter = 'get'.ucfirst($property);
            if(!method_exists($propertyValue, $getter)) {

Expected 1 space after IF keyword; 0 found

                throw new \InvalidArgumentException('There is no getter for the "'.$attribute->getProperty().'" attribute for object "'.get_class($propertyValue).'"');
            }
            $propertyValue = $propertyValue->{$getter}();
        }
        return $propertyValue;
    }
    
    /**
     * 
     * @param \PhpAbac\Model\EnvironmentAttribute $attribute
     * @return mixed
     */
    private function retrieveEnvironmentAttribute(EnvironmentAttribute $attribute) {
        return getenv($attribute->getVariableName());
    }

    /**
     * @param string $slug
     * @param array  $dynamicAttributes
     *
     * @return mixed
     *
     * @throws \InvalidArgumentException
     */
    public function getDynamicAttribute($slug, $dynamicAttributes = [])
    {
        if (!isset($dynamicAttributes[$slug])) {
            throw new \InvalidArgumentException('The "'.$slug.'" attribute is dynamic and its value must be given');
        }
        return $dynamicAttributes[$slug];
    }
    
    /*
     * @param string $name
     * @return string
     */
    public function slugify($name)
    {
        // replace non letter or digits by -
        $name = trim(preg_replace('~[^\\pL\d]+~u', '-', $name), '-');
        // transliterate
        if (function_exists('iconv')) {
            $name = iconv('utf-8', 'us-ascii//TRANSLIT', $name);
        }
        // remove unwanted characters
        $name = preg_replace('~[^-\w]+~', '', strtolower($name));
        if (empty($name)) {
            return 'n-a';
        }
        return $name;
    }
}