Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/rest/src/Plugin/ResourceInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\rest\Plugin\ResourceInterface.
6	*/
7
8	namespace Drupal\rest\Plugin;
9
10	use Drupal\Component\Plugin\PluginInspectionInterface;
11
12	/**
13	* Specifies the publicly available methods of a resource plugin.
14	*
15	* @see \Drupal\rest\Annotation\RestResource
16	* @see \Drupal\rest\Plugin\Type\ResourcePluginManager
17	* @see \Drupal\rest\Plugin\ResourceBase
18	* @see plugin_api
19	*
20	* @ingroup third_party
21	*/
22	interface ResourceInterface extends PluginInspectionInterface {
23
24	/**
25	* Returns a collection of routes with URL path information for the resource.
26	*
27	* This method determines where a resource is reachable, what path
28	* replacements are used, the required HTTP method for the operation etc.
29	*
30	* @return \Symfony\Component\Routing\RouteCollection
31	* A collection of routes that should be registered for this resource.
32	*/
33	public function routes();
34
35	/**
36	* Provides an array of permissions suitable for .permissions.yml files.
37	*
38	* A resource plugin can define a set of user permissions that are used on the
39	* routes for this resource or for other purposes.
40	*
41	* @return array
42	* The permission array.
43	*/
44	public function permissions();
45
46	/**
47	* Returns the available HTTP request methods on this plugin.
48	*
49	* @return array
50	* The list of supported methods. Example: array('GET', 'POST', 'PATCH').
51	*/
52	public function availableMethods();
53
54	}