comparison core/lib/Drupal/Component/Plugin/Definition/PluginDefinitionInterface.php @ 0:4c8ae668cc8c

Initial import (non-working)
author Chris Cannam
date Wed, 29 Nov 2017 16:09:58 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:4c8ae668cc8c
1 <?php
2
3 namespace Drupal\Component\Plugin\Definition;
4
5 /**
6 * Defines a plugin definition.
7 *
8 * Object-based plugin definitions MUST implement this interface.
9 *
10 * @ingroup Plugin
11 */
12 interface PluginDefinitionInterface {
13
14 /**
15 * Gets the unique identifier of the plugin.
16 *
17 * @return string
18 * The unique identifier of the plugin.
19 */
20 public function id();
21
22 /**
23 * Sets the class.
24 *
25 * @param string $class
26 * A fully qualified class name.
27 *
28 * @return static
29 *
30 * @throws \InvalidArgumentException
31 * If the class is invalid.
32 */
33 public function setClass($class);
34
35 /**
36 * Gets the class.
37 *
38 * @return string
39 * A fully qualified class name.
40 */
41 public function getClass();
42
43 /**
44 * Gets the plugin provider.
45 *
46 * The provider is the name of the module that provides the plugin, or "core',
47 * or "component".
48 *
49 * @return string
50 * The provider.
51 */
52 public function getProvider();
53
54 }