phpDocumentor\Reflection\Php\Visibility

Complexity

Total Complexity

5

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	4
A	__toString()	0	4	1

<?php
declare(strict_types=1);

/**
 * This file is part of phpDocumentor.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @copyright 2010-2018 Mike van Riel<mike@phpdoc.org>
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Reflection\Php;

use InvalidArgumentException;

/**
 * Value object for visibility values of classes, properties, ect.
 */
final class Visibility
{
    /**
     * constant for protected visibility
     */
    const PUBLIC_ = 'public';

    /**
     * constant for protected visibility
     */
    const PROTECTED_ = 'protected';

    /**
     * constant for private visibility
     */
    const PRIVATE_ = 'private';

    /**
     * @var string value can be public, protected or private
     */
    private $visibility;

    /**
     * Initializes the object.
     *
     * @throws InvalidArgumentException when visibility does not match public|protected|private
     */
    public function __construct(string $visibility)
    {
        $visibility = strtolower($visibility);

        if ($visibility !== static::PUBLIC_ && $visibility !== static::PROTECTED_ && $visibility !== static::PRIVATE_) {
            throw new InvalidArgumentException(
                sprintf('""%s" is not a valid visibility value.', $visibility)
            );
        }

        $this->visibility = $visibility;
    }

    /**
     * Will return a string representation of visibility.
     */
    public function __toString(): string
    {
        return $this->visibility;
    }
}