Enum.php 1.35 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\Framework\GraphQl\Config\Element;

use Magento\Framework\GraphQl\Config\ConfigElementInterface;

/**
 * Class representing 'enum' GraphQL config element.
 */
class Enum implements ConfigElementInterface
{
    /**
     * @var string
     */
    private $name;

    /**
     * @var array
     */
    private $values;

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

    /**
     * @param string $name
     * @param EnumValue[] $values
     * @param string $description
     */
    public function __construct(
        string $name,
        array $values,
        string $description
    ) {
        $this->name = $name;
        $this->values = $values;
        $this->description = $description;
    }

    /**
     * Get name.
     *
     * @return string
     */
    public function getName() : string
    {
        return $this->name;
    }

    /**
     * Get an array of all possible values for the Enum.
     *
     * @return EnumValue[]
     */
    public function getValues() : array
    {
        return $this->values;
    }

    /**
     * Return human-readable description of Enum.
     *
     * @return string
     */
    public function getDescription() : string
    {
        return $this->description;
    }
}