class ActivityTypePlugin in CRM Core 8.2

Defines an activity type plugin annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\crm_core_activity\Annotation\ActivityTypePlugin

2 classes are annotated with ActivityTypePlugin

ActivityTypeWithConfig in modules/crm_core_activity/tests/modules/crm_core_activity_plugin_test/src/Plugin/crm_core_activity/ActivityType/ActivityTypeWithConfig.php

Provides generic plugin for activity type.

Generic in modules/crm_core_activity/src/Plugin/crm_core_activity/ActivityType/Generic.php

Provides generic plugin for activity type.

File

modules/crm_core_activity/src/Annotation/ActivityTypePlugin.php, line 12

Namespace

Drupal\crm_core_activity\Annotation

class ActivityTypePlugin extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the type.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * A brief description of the plugin.
   *
   * This will be shown when adding or configuring this display.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation (optional)
   */
  public $description = '';

}

Members

Name	Modifiers	Type	Description	Overrides
ActivityTypePlugin::$description	public	property	A brief description of the plugin.
ActivityTypePlugin::$id	public	property	The plugin ID.
ActivityTypePlugin::$label	public	property	The human-readable name of the type.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2