You are here

class RestResource in Zircon Profile 8.0

Same name and namespace in other branches
  1. 8 core/modules/rest/src/Annotation/RestResource.php \Drupal\rest\Annotation\RestResource

Defines a REST resource annotation object.

Plugin Namespace: Plugin\rest\resource

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

Hierarchy

Expanded class hierarchy of RestResource

See also

\Drupal\rest\Plugin\Type\ResourcePluginManager

\Drupal\rest\Plugin\ResourceBase

\Drupal\rest\Plugin\ResourceInterface

Plugin API

Related topics

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
View source
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

Namesort descending 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.