class RestResource in Zircon Profile 8

Defines a REST resource annotation object.

Plugin Namespace: Plugin\rest\resource

For a working example, see \Drupal\dblog\Plugin\rest\resource\DBLogResource

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\rest\Annotation\RestResource

See also

\Drupal\rest\Plugin\Type\ResourcePluginManager

\Drupal\rest\Plugin\ResourceBase

\Drupal\rest\Plugin\ResourceInterface

Plugin API

Related topics

Annotations

Annotations for class discovery and metadata description.

REST and Application Integration

Integrating third-party applications using REST and related operations.

2 classes are annotated with RestResource

DBLogResource in core/modules/dblog/src/Plugin/rest/resource/DBLogResource.php

Provides a resource for database watchdog log entries.

EntityResource in core/modules/rest/src/Plugin/rest/resource/EntityResource.php

Represents entities as resources.

File

core/modules/rest/src/Annotation/RestResource.php, line 28

Contains \Drupal\rest\Annotation\RestResource.

Namespace

Drupal\rest\Annotation

class RestResource extends Plugin {

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

  /**
   * The human-readable name of the resource plugin.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

}

Members

Name	Modifiers	Type	Description	Overrides
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	2
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
Plugin::__construct	public	function	Constructs a Plugin object.	1
RestResource::$id	public	property	The resource plugin ID.
RestResource::$label	public	property	The human-readable name of the resource plugin.