Mercurial > hg > isophonics-drupal-site
diff core/modules/rest/src/Annotation/RestResource.php @ 0:4c8ae668cc8c
Initial import (non-working)
author | Chris Cannam |
---|---|
date | Wed, 29 Nov 2017 16:09:58 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/modules/rest/src/Annotation/RestResource.php Wed Nov 29 16:09:58 2017 +0000 @@ -0,0 +1,62 @@ +<?php + +namespace Drupal\rest\Annotation; + +use Drupal\Component\Annotation\Plugin; + +/** + * Defines a REST resource annotation object. + * + * Plugin Namespace: Plugin\rest\resource + * + * For a working example, see \Drupal\dblog\Plugin\rest\resource\DBLogResource + * + * @see \Drupal\rest\Plugin\Type\ResourcePluginManager + * @see \Drupal\rest\Plugin\ResourceBase + * @see \Drupal\rest\Plugin\ResourceInterface + * @see plugin_api + * + * @ingroup third_party + * + * @Annotation + */ +class RestResource extends Plugin { + + /** + * The REST resource plugin ID. + * + * @var string + */ + public $id; + + /** + * The human-readable name of the REST resource plugin. + * + * @ingroup plugin_translatable + * + * @var \Drupal\Core\Annotation\Translation + */ + public $label; + + /** + * The serialization class to deserialize serialized data into. + * + * @see \Symfony\Component\Serializer\SerializerInterface's "type" parameter. + * + * @var string (optional) + */ + 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. + * + * @see core/core.link_relation_types.yml + * + * @var string[] + */ + public $uri_paths = []; + +}