class Sandwich

Defines a Sandwich annotation object.

Provides an example of how to define a new annotation type for use in defining a plugin type. Demonstrates documenting the various properties that can be used in annotations for plugins of this type.

Note that the "@ Annotation" line below is required and should be the last line in the docblock. It's used for discovery of Annotation definitions.

Hierarchy

  • class \Drupal\plugin_type_example\Annotation\Sandwich extends \Drupal\Component\Annotation\Plugin

Expanded class hierarchy of Sandwich

See also

\Drupal\plugin_type_example\SandwichPluginManager

plugin_api

1 file declares its use of Sandwich
SandwichPluginManager.php in modules/plugin_type_example/src/SandwichPluginManager.php

File

View on git.drupalcode.org

modules/plugin_type_example/src/Annotation/Sandwich.php, line 22

Namespace

Drupal\plugin_type_example\Annotation
View source 
class Sandwich extends Plugin {
  
  /**
   * A brief, human readable, description of the sandwich type.
   *
   * This property is designated as being translatable because it will appear
   * in the user interface. This provides a hint to other developers that they
   * should use the Translation() construct in their annotation when declaring
   * this property.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;
  
  /**
   * The number of calories per serving of this sandwich type.
   *
   * This property is a float value, so we indicate that to other developers
   * who are writing annotations for a Sandwich plugin.
   *
   * @var int
   */
  public $calories;

}

Members

Title Modifiers Object type Summary
Sandwich::$calories public property The number of calories per serving of this sandwich type.
Sandwich::$description public property A brief, human readable, description of the sandwich type.