You are here

Home » API reference » GraphQL 8.3 » GraphQLEnum.php

class GraphQLEnum in GraphQL 8.3

Annotation for GraphQL scalar plugins.

Hierarchy

Expanded class hierarchy of GraphQLEnum

1 file declares its use of GraphQLEnum
MockGraphQLPluginTrait.php in tests/src/Traits/MockGraphQLPluginTrait.php
1 string reference to 'GraphQLEnum'
graphql.services.yml in ./graphql.services.yml
graphql.services.yml
9 classes are annotated with GraphQLEnum
DisplayModeId in modules/graphql_core/src/Plugin/GraphQL/Enums/DisplayModes/DisplayModeId.php
Plugin annotation @GraphQLEnum( id = "display_mode_id", deriver = "Drupal\graphql_core\Plugin\Deriver\Enums\DisplayModeIdDeriver" )
EntityQueryBundleMode in modules/graphql_core/src/Plugin/GraphQL/Enums/EntityQuery/EntityQueryBundleMode.php
Plugin annotation @GraphQLEnum( id = "entity_query_bundle_mode", name = "EntityQueryBundleMode", values = { "SAME" = { "value" = "same", "description" = @Translation("Loads only entities that share the same bundle with the…
EntityQueryRevisionMode in modules/graphql_core/src/Plugin/GraphQL/Enums/EntityQuery/EntityQueryRevisionMode.php
Plugin annotation @GraphQLEnum( id = "entity_query_revision_mode", name = "EntityQueryRevisionMode", values = { "DEFAULT" = { "value" = "default", "description" = @Translation("Loads the current (default) revisions."), }, …
ImageStyleId in modules/graphql_core/src/Plugin/GraphQL/Enums/Images/ImageStyleId.php
Plugin annotation @GraphQLEnum( id = "image_style_id", name = "ImageStyleId", provider = "image" )
LanguageId in modules/graphql_core/src/Plugin/GraphQL/Enums/Languages/LanguageId.php
Generates an enumeration of numbers.

... See full list

File

src/Annotation/GraphQLEnum.php, line 10

Namespace

Drupal\graphql\Annotation
View source 
class GraphQLEnum extends GraphQLAnnotationBase {

  /**
   * {@inheritdoc}
   */
  public $pluginType = GRAPHQL_ENUM_PLUGIN;

  /**
   * The typed data type of this type.
   *
   * @var string|null
   */
  public $type = NULL;

  /**
   * The enum's key / value pairs.
   *
   * @var array
   */
  public $values = [];

}

Members

Namesort descending Modifiers Type Description Overrides
GraphQLAnnotationBase::$description public property The component description.
GraphQLAnnotationBase::$name public property The component name.
GraphQLAnnotationBase::$response_cache_contexts public property The cache contexts for caching the response.
GraphQLAnnotationBase::$response_cache_max_age public property The cache max age for caching the response.
GraphQLAnnotationBase::$response_cache_tags public property The cache tags for caching the response.
GraphQLAnnotationBase::$schema_cache_contexts public property The cache contexts for caching the type system definition in the schema.
GraphQLAnnotationBase::$schema_cache_max_age public property The cache max age for caching the type system definition in the schema.
GraphQLAnnotationBase::$schema_cache_tags public property The cache tags for caching the type system definition in the schema.
GraphQLAnnotationBase::$weight public property Weight for precedence calculations.
GraphQLAnnotationBase::__construct public function GraphQLAnnotationBase constructor. Overrides Plugin::__construct
GraphQLEnum::$pluginType public property The plugin type. Overrides GraphQLAnnotationBase::$pluginType
GraphQLEnum::$type public property The typed data type of this type.
GraphQLEnum::$values public property The enum's key / value pairs.
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 5
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider