class ExampleHamSandwich

Same name in other branches
  1. 3.x modules/plugin_type_example/src/Plugin/Sandwich/ExampleHamSandwich.php \Drupal\plugin_type_example\Plugin\Sandwich\ExampleHamSandwich
  2. 8.x-1.x plugin_type_example/src/Plugin/Sandwich/ExampleHamSandwich.php \Drupal\plugin_type_example\Plugin\Sandwich\ExampleHamSandwich

Provides a ham sandwich.

Because the plugin manager class for our plugins uses attributes for class discovery, our ham sandwich only needs to exist within the Plugin\Sandwich namespace, and provide a Sandwich attribute to be declared as a plugin. This is defined in \Drupal\plugin_type_example\SandwichPluginManager::__construct().

Following this comment is the plugin attribute. This is parsed using the PHP Reflection API and used to generate the plugin definition. Any values defined here will be available in the configuration passed to plugin instances when they are instantiated from the plugin manager.

This should be used for metadata that is specifically required to instantiate the plugin, or for example data that might be needed to display a list of all available plugins where the user selects one. This means many plugin attributes can be reduced to a plugin ID, a label and perhaps a description.

Plugin annotation


@Sandwich(
  id = "ham_sandwich",
  description = @Translation("Ham, mustard, rocket, sun-dried tomatoes."),
  calories = 426
)

Hierarchy

Expanded class hierarchy of ExampleHamSandwich

1 file declares its use of ExampleHamSandwich
PluginTypeExampleTest.php in modules/plugin_type_example/tests/src/Functional/PluginTypeExampleTest.php

File

modules/plugin_type_example/src/Plugin/Sandwich/ExampleHamSandwich.php, line 34

Namespace

Drupal\plugin_type_example\Plugin\Sandwich
View source 
class ExampleHamSandwich extends SandwichBase {
    
    /**
     * Place an order for a sandwich.
     *
     * This is just an example method on our plugin that we can call to get
     * something back.
     *
     * @param array $extras
     *   Array of extras to include with this order.
     *
     * @return string
     *   A description of the sandwich ordered.
     */
    public function order(array $extras) {
        $ingredients = [
            'ham, mustard',
            'rocket',
            'sun-dried tomatoes',
        ];
        $sandwich = array_merge($ingredients, $extras);
        return 'You ordered an ' . implode(', ', $sandwich) . ' sandwich. Enjoy!';
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ExampleHamSandwich::order public function Place an order for a sandwich. Overrides SandwichBase::order
PluginBase::$configuration protected property Configuration information passed into the plugin.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin ID.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Gets the plugin ID of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 6
SandwichBase::calories public function Provide the number of calories per serving for the sandwich. Overrides SandwichInterface::calories
SandwichBase::description public function Provide a description of the sandwich. Overrides SandwichInterface::description 1