<?php
/**
 * Copyright since 2007 PrestaShop SA and Contributors
 * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/OSL-3.0
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@prestashop.com so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
 * versions in the future. If you wish to customize PrestaShop for your
 * needs please refer to https://devdocs.prestashop.com/ for more information.
 *
 * @author    PrestaShop SA and Contributors <contact@prestashop.com>
 * @copyright Since 2007 PrestaShop SA and Contributors
 * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
 */

declare(strict_types=1);

namespace PrestaShop\PrestaShop\Core\Domain\Profile\Permission\ValueObject;

use PrestaShop\PrestaShop\Core\Domain\Profile\Permission\Exception\InvalidPermissionValueException;

class ControllerPermission implements PermissionInterface
{
    public const VIEW = 'view';
    public const ADD = 'add';
    public const EDIT = 'edit';
    public const DELETE = 'delete';
    public const ALL = 'all';

    public const SUPPORTED_PERMISSIONS = [
        self::VIEW,
        self::ADD,
        self::EDIT,
        self::DELETE,
    ];

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

    /**
     * @param string $permission
     */
    public function __construct(string $permission)
    {
        $this->assertPermissionIsSupported($permission);

        $this->permission = $permission;
    }

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

    protected function assertPermissionIsSupported(string $permission): void
    {
        if (!in_array($permission, static::SUPPORTED_PERMISSIONS)) {
            throw new InvalidPermissionValueException(
                sprintf('Invalid permission "%s" provided', $permission)
            );
        }
    }
}