class ExampleHamSandwich

Provides a ham sandwich.

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

The following is the plugin annotation. This is parsed by Doctrine to make the plugin definition. Any values defined here will be available in the plugin definition.

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 annotations 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

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\plugin_type_example\SandwichBase extends \Drupal\Component\Plugin\PluginBase implements \Drupal\plugin_type_example\SandwichInterface
    • class \Drupal\plugin_type_example\Plugin\Sandwich\ExampleHamSandwich extends \Drupal\plugin_type_example\SandwichBase

Expanded class hierarchy of ExampleHamSandwich

File

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

Namespace

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