vendor/webonyx/graphql-php/src/Type/Definition/FieldArgument.php line 76

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace GraphQL\Type\Definition;
  7. use GraphQL\Error\InvariantViolation;
  8. use GraphQL\Language\AST\InputValueDefinitionNode;
  9. use GraphQL\Type\Schema;
  10. use GraphQL\Utils\Utils;
  11. use function array_key_exists;
  12. use function is_array;
  13. use function is_string;
  14. use function sprintf;
  16. class FieldArgument
  17. {
  18.     /** @var string */
  19.     public $name;
  21.     /** @var mixed */
  22.     public $defaultValue;
  24.     /** @var string|null */
  25.     public $description;
  27.     /** @var InputValueDefinitionNode|null */
  28.     public $astNode;
  30.     /** @var mixed[] */
  31.     public $config;
  33.     /** @var Type&InputType */
  34.     private $type;
  36.     /** @param mixed[] $def */
  37.     public function __construct(array $def)
  38.     {
  39.         foreach ($def as $key => $value) {
  40.             switch ($key) {
  41.                 case 'name':
  42.                     $this->name = $value;
  43.                     break;
  44.                 case 'defaultValue':
  45.                     $this->defaultValue = $value;
  46.                     break;
  47.                 case 'description':
  48.                     $this->description = $value;
  49.                     break;
  50.                 case 'astNode':
  51.                     $this->astNode = $value;
  52.                     break;
  53.             }
  54.         }
  55.         $this->config = $def;
  56.     }
  58.     /**
  59.      * @param mixed[] $config
  60.      *
  61.      * @return FieldArgument[]
  62.      */
  63.     public static function createMap(array $config) : array
  64.     {
  65.         $map = [];
  66.         foreach ($config as $name => $argConfig) {
  67.             if (! is_array($argConfig)) {
  68.                 $argConfig = ['type' => $argConfig];
  69.             }
  70.             $map[] = new self($argConfig + ['name' => $name]);
  71.         }
  73.         return $map;
  74.     }
  76.     public function getType() : Type
  77.     {
  78.         if (! isset($this->type)) {
  79.             /**
  80.              * TODO: replace this phpstan cast with native assert
  81.              *
  82.              * @var Type&InputType
  83.              */
  84.             $type       = Schema::resolveType($this->config['type']);
  85.             $this->type = $type;
  86.         }
  88.         return $this->type;
  89.     }
  91.     public function defaultValueExists() : bool
  92.     {
  93.         return array_key_exists('defaultValue', $this->config);
  94.     }
  96.     public function isRequired() : bool
  97.     {
  98.         return $this->getType() instanceof NonNull && ! $this->defaultValueExists();
  99.     }
  101.     public function assertValid(FieldDefinition $parentField, Type $parentType)
  102.     {
  103.         try {
  104.             Utils::assertValidName($this->name);
  105.         } catch (InvariantViolation $e) {
  106.             throw new InvariantViolation(
  107.                 sprintf('%s.%s(%s:) %s', $parentType->name, $parentField->name, $this->name, $e->getMessage())
  108.             );
  109.         }
  110.         $type = $this->getType();
  111.         if ($type instanceof WrappingType) {
  112.             $type = $type->getWrappedType(true);
  113.         }
  114.         Utils::invariant(
  115.             $type instanceof InputType,
  116.             sprintf(
  117.                 '%s.%s(%s): argument type must be Input Type but got: %s',
  118.                 $parentType->name,
  119.                 $parentField->name,
  120.                 $this->name,
  121.                 Utils::printSafe($this->type)
  122.             )
  123.         );
  124.         Utils::invariant(
  125.             $this->description === null || is_string($this->description),
  126.             sprintf(
  127.                 '%s.%s(%s): argument description type must be string but got: %s',
  128.                 $parentType->name,
  129.                 $parentField->name,
  130.                 $this->name,
  131.                 Utils::printSafe($this->description)
  132.             )
  133.         );
  134.     }
  135. }