Charcoal\User\Acl\Permission

Complexity

Total Complexity

6

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	4	1
A	setIdent()	0	10	2
A	ident()	0	4	1
A	setName()	0	5	1
A	name()	0	4	1

<?php

namespace Charcoal\User\Acl;

use InvalidArgumentException;

// Module `charcoal-core` dependencies
use Charcoal\Model\AbstractModel;

// Module `charcoal-base` dependencies
use Charcoal\Object\CategorizableInterface;
use Charcoal\Object\CategorizableTrait;

// Module `charcoal-translation` dependencies
use Charcoal\Translation\TranslationString;

/**
 * A permission is a simple string, that can be read with additional data (name + category) from storage.
 */
class Permission extends AbstractModel implements CategorizableInterface
{
    use CategorizableTrait;

    /**
     * @var string $ident
     */
    private $ident;

    /**
     * @var TranslationString $name
     */
    private $name;

    /**
     * Permission can be used as a string (ident).
     *
     * @return string
     */
    public function __toString()
    {
        return (string)$this->ident;
    }

    /**
     * @param string $ident The permission identifier.
     * @throws InvalidArgumentException If the ident is not a string.
     * @return Permission Chainable
     */
    public function setIdent($ident)
    {
        if (!is_string($ident)) {
            throw new InvalidArgumentException(
                'Permission ident needs to be a string'
            );
        }
        $this->ident = $ident;
        return $this;
    }

    /**
     * @return string
     */
    public function ident()
    {
        return $this->ident;
    }

    /**
     * @param mixed $name The permission name / label.
     * @return Permission Chainable
     */
    public function setName($name)
    {
        $this->name = new TranslationString($name);
        return $this;
    }

    /**
     * @return TranslationString
     */
    public function name()
    {
        return $this->name;
    }
}