public function SandwichBase::description in Examples for Developers 8

Same name and namespace in other branches

1. 3.x modules/plugin_type_example/src/SandwichBase.php \Drupal\plugin_type_example\SandwichBase::description()

Provide a description of the sandwich.

Return value

string A string description of the sandwich.

Overrides SandwichInterface::description

1 call to SandwichBase::description()

ExampleMeatballSandwich::description in plugin_type_example/src/Plugin/Sandwich/ExampleMeatballSandwich.php

Provide a description of the sandwich.

1 method overrides SandwichBase::description()

ExampleMeatballSandwich::description in plugin_type_example/src/Plugin/Sandwich/ExampleMeatballSandwich.php

Provide a description of the sandwich.

File

plugin_type_example/src/SandwichBase.php, line 35

Class

SandwichBase

A base class to help developers implement their own sandwich plugins.

Namespace

Drupal\plugin_type_example

Code

public function description() {

  // Retrieve the @description property from the annotation and return it.
  return $this->pluginDefinition['description'];
}