class PersistedQuery in GraphQL 8.4

Annotation for persisted query plugins.

@codeCoverageIgnore

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\graphql\Annotation\PersistedQuery

1 string reference to 'PersistedQuery'

graphql.services.yml in ./graphql.services.yml

graphql.services.yml

File

src/Annotation/PersistedQuery.php, line 14

Namespace

Drupal\graphql\Annotation

class PersistedQuery extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

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

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

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

}

Members

Name	Modifiers	Type	Description	Overrides
PersistedQuery::$description	public	property	The component description.
PersistedQuery::$id	public	property	The plugin ID.
PersistedQuery::$label	public	property	The component label.
PersistedQuery::__construct	public	function	PersistedQuery constructor. Overrides Plugin::__construct
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