Mercurial > hg > isophonics-drupal-site
diff 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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/lib/Drupal/Component/Plugin/Definition/PluginDefinitionInterface.php Wed Nov 29 16:09:58 2017 +0000 @@ -0,0 +1,54 @@ +<?php + +namespace Drupal\Component\Plugin\Definition; + +/** + * Defines a plugin definition. + * + * Object-based plugin definitions MUST implement this interface. + * + * @ingroup Plugin + */ +interface PluginDefinitionInterface { + + /** + * Gets the unique identifier of the plugin. + * + * @return string + * The unique identifier of the plugin. + */ + public function id(); + + /** + * Sets the class. + * + * @param string $class + * A fully qualified class name. + * + * @return static + * + * @throws \InvalidArgumentException + * If the class is invalid. + */ + public function setClass($class); + + /** + * Gets the class. + * + * @return string + * A fully qualified class name. + */ + public function getClass(); + + /** + * Gets the plugin provider. + * + * The provider is the name of the module that provides the plugin, or "core', + * or "component". + * + * @return string + * The provider. + */ + public function getProvider(); + +}