You are here

Home » API reference » GraphQL 8.3 » GraphQLInterface.php

class GraphQLInterface in GraphQL 8.3

Annotation for GraphQL interface plugins.

Hierarchy

Expanded class hierarchy of GraphQLInterface

1 file declares its use of GraphQLInterface
MockGraphQLPluginTrait.php in tests/src/Traits/MockGraphQLPluginTrait.php
1 string reference to 'GraphQLInterface'
graphql.services.yml in ./graphql.services.yml
graphql.services.yml
10 classes are annotated with GraphQLInterface
Entity in modules/graphql_core/src/Plugin/GraphQL/Interfaces/Entity/Entity.php
Plugin annotation @GraphQLInterface( id = "entity", name = "Entity", type = "entity", description = @Translation("Common entity interface containing generic entity properties.") )
EntityDescribable in modules/graphql_core/src/Plugin/GraphQL/Interfaces/Entity/EntityDescribable.php
Plugin annotation @GraphQLInterface( id = "entity_describable", name = "EntityDescribable", interfaces = {"Entity"}, description = @Translation("Common interface for entities that are describable.") )
EntityOwnable in modules/graphql_core/src/Plugin/GraphQL/Interfaces/Entity/EntityOwnable.php
Plugin annotation @GraphQLInterface( id = "entity_ownable", name = "EntityOwnable", interfaces = {"Entity"}, description = @Translation("Common interface for entities that have a owner."), provider = "user" )
EntityPublishable in modules/graphql_core/src/Plugin/GraphQL/Interfaces/Entity/EntityPublishable.php
Plugin annotation @GraphQLInterface( id = "entity_publishable", name = "EntityPublishable", interfaces = {"Entity"}, description = @Translation("Common interface for entities that are publishable.") )
EntityRevisionable in modules/graphql_core/src/Plugin/GraphQL/Interfaces/Entity/EntityRevisionable.php
Plugin annotation @GraphQLInterface( id = "entity_revisionable", name = "EntityRevisionable", interfaces = {"Entity"}, description = @Translation("Common interface for entities that are revisionable.") )

... See full list

File

src/Annotation/GraphQLInterface.php, line 10

Namespace

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

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

  /**
   * The list of parent interfaces this interface extends.
   *
   * Fields attached to interfaces will be inherited.
   *
   * @var string[]
   */
  public $interfaces = [];

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

}

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
GraphQLInterface::$interfaces public property The list of parent interfaces this interface extends.
GraphQLInterface::$pluginType public property The plugin type. Overrides GraphQLAnnotationBase::$pluginType
GraphQLInterface::$type public property The typed data type of this type.
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