drupal-graphql / graphql

src/Annotation/GraphQLAnnotationBase.php

<?php

namespace Drupal\graphql\Annotation;

use Doctrine\Common\Annotations\AnnotationException;

The type Doctrine\Common\Annotations\AnnotationException was not found. Maybe you did not declare it correctly or list all dependencies?

use Drupal\Component\Annotation\Plugin;

The type Drupal\Component\Annotation\Plugin was not found. Maybe you did not declare it correctly or list all dependencies?

use Drupal\Core\Cache\CacheBackendInterface;

The type Drupal\Core\Cache\CacheBackendInterface was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Annotation for GraphQL input type plugins.
 *
 * @Annotation
 */
abstract class GraphQLAnnotationBase extends Plugin {

  /**
   * The plugin type.
   *
   * The type of component. Field, Interface, Type, Scalar ...
   *
   * @var string
   *
   * @see graphql.module
   */
  public $pluginType = NULL;

  /**
   * The component name.
   *
   * @var string
   */
  public $name;

  /**
   * The component description.
   *
   * @var string
   */
  public $description = '';

  /**
   * Weight for precedence calculations.
   *
   * If multiple components with the same name are available, the highest
   * weight wins.
   *
   * @var int
   */
  public $weight = 0;

  /**
   * The cache contexts for caching the type system definition in the schema.
   *
   * @var array
   */
  public $schema_cache_contexts = [];

  /**
   * The cache tags for caching the type system definition in the schema.
   *
   * @var array
   */
  public $schema_cache_tags = [];

  /**
   * The cache max age for caching the type system definition in the schema.
   *
   * @var array
   */
  public $schema_cache_max_age = CacheBackendInterface::CACHE_PERMANENT;

  /**
   * The cache contexts for caching the response.
   *
   * @var array
   */
  public $response_cache_contexts = ['user.permissions'];

  /**
   * The cache tags for caching the response.
   *
   * @var array
   */
  public $response_cache_tags = [];

  /**
   * The cache max age for caching the response.
   *
   * @var array
   */
  public $response_cache_max_age = CacheBackendInterface::CACHE_PERMANENT;

  /**
   * GraphQLAnnotationBase constructor.
   *
   * @param $values
   *   The plugin annotation values.
   *
   * @throws \Doctrine\Common\Annotations\AnnotationException
   *   In case of missing required annotation values.
   */
  public function __construct($values) {
    if (!array_key_exists('id', $values) || !$values['id']) {
      throw new AnnotationException('GraphQL plugin is missing an "id" property.');
    }
    parent::__construct($values);
  }

}