class RestResource
Same name in this branch
- 11.x core/modules/rest/src/Attribute/RestResource.php \Drupal\rest\Attribute\RestResource
Same name in other branches
- 9 core/modules/rest/src/Annotation/RestResource.php \Drupal\rest\Annotation\RestResource
- 8.9.x core/modules/rest/src/Annotation/RestResource.php \Drupal\rest\Annotation\RestResource
- 10 core/modules/rest/src/Attribute/RestResource.php \Drupal\rest\Attribute\RestResource
- 10 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
- class \Drupal\Component\Annotation\Plugin implements \Drupal\Component\Annotation\AnnotationInterface
- class \Drupal\rest\Annotation\RestResource extends \Drupal\Component\Annotation\Plugin
Expanded class hierarchy of RestResource
See also
\Drupal\rest\Plugin\Type\ResourcePluginManager
\Drupal\rest\Plugin\ResourceBase
\Drupal\rest\Plugin\ResourceInterface
Related topics
File
-
core/
modules/ rest/ src/ Annotation/ RestResource.php, line 23
Namespace
Drupal\rest\AnnotationView source
class RestResource extends Plugin {
/**
* The REST resource plugin ID.
*
* @var string
*/
public $id;
/**
* The human-readable name of the REST resource plugin.
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $label;
/**
* The serialization class to deserialize serialized data into.
*
* This property is optional and it does not need to be declared.
*
* @var string
*
* @see \Symfony\Component\Serializer\SerializerInterface's "type" parameter.
*/
public $serialization_class;
/**
* The URI paths that this REST resource plugin provides.
*
* Key-value pairs, with link relation type plugin IDs as keys, and URL
* templates as values.
*
* @var string[]
*
* @see core/core.link_relation_types.yml
*/
public $uri_paths = [];
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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 | 6 |
Plugin::getClass | public | function | Gets the class of the annotated class. | Overrides AnnotationInterface::getClass | 1 |
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 | 1 |
Plugin::parse | protected | function | Parses an annotation into its definition. | ||
Plugin::setClass | public | function | Sets the class of the annotated class. | Overrides AnnotationInterface::setClass | 1 |
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. | 3 | |
RestResource::$id | public | property | The REST resource plugin ID. | ||
RestResource::$label | public | property | The human-readable name of the REST resource plugin. | ||
RestResource::$serialization_class | public | property | The serialization class to deserialize serialized data into. | ||
RestResource::$uri_paths | public | property | The URI paths that this REST resource plugin provides. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.