class SchedulerPlugin in Scheduler 2.x

Annotation class for scheduler entity plugins.

@package Drupal\scheduler\Annotation

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\scheduler\Annotation\SchedulerPlugin

1 file declares its use of SchedulerPlugin

SchedulerPluginManager.php in src/SchedulerPluginManager.php

3 classes are annotated with SchedulerPlugin

CommerceProductScheduler in src/Plugin/Scheduler/CommerceProductScheduler.php

Plugin for Commerce Product entity type.

MediaScheduler in src/Plugin/Scheduler/MediaScheduler.php

Plugin for Media entity type.

NodeScheduler in src/Plugin/Scheduler/NodeScheduler.php

Plugin for Node entity type.

File

src/Annotation/SchedulerPlugin.php, line 14

Namespace

Drupal\scheduler\Annotation

class SchedulerPlugin extends Plugin {

  /**
   * The internal id / machine name of the plugin.
   *
   * @var string
   */
  public $id;

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

  /**
   * Description of plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * The entity type.
   *
   * @var string
   */
  public $entityType;

  /**
   * The name of the type/bundle field.
   *
   * @var string
   */
  public $typeFieldName;

  /**
   * Module name that plugin requires.
   *
   * @var string
   */
  public $dependency;

  /**
   * The Form ID of the devel generate form (optional).
   *
   * @var string
   */
  public $develGenerateForm = '';

  /**
   * The route of the scheduled view on the user profile page (optional).
   *
   * @var string
   */
  public $userViewRoute = '';

  /**
   * The event class for Scheduler events relating to activity on the entity.
   *
   * If not specified, it is assumed that the plugin is part of the Scheduler
   * module and the event class will default to Scheduler's namespace.
   *
   * @var string
   */
  public $schedulerEventClass;

  /**
   * The name of the publish action for the entity type (optional).
   *
   * This is used when the action name does not match the default pattern of
   * {entity type id}_publish_action.
   *
   * @var string
   */
  public $publishAction;

  /**
   * The name of the unpublish action for the entity type (optional).
   *
   * This is used when the action name does not match the default pattern of
   * {entity type id}_unpublish_action.
   *
   * @var string
   */
  public $unpublishAction;

}

Members

Name	Modifiers	Type	Description	Overrides
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	1
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
SchedulerPlugin::$dependency	public	property	Module name that plugin requires.
SchedulerPlugin::$description	public	property	Description of plugin.
SchedulerPlugin::$develGenerateForm	public	property	The Form ID of the devel generate form (optional).
SchedulerPlugin::$entityType	public	property	The entity type.
SchedulerPlugin::$id	public	property	The internal id / machine name of the plugin.
SchedulerPlugin::$label	public	property	The readable name of the plugin.
SchedulerPlugin::$publishAction	public	property	The name of the publish action for the entity type (optional).
SchedulerPlugin::$schedulerEventClass	public	property	The event class for Scheduler events relating to activity on the entity.
SchedulerPlugin::$typeFieldName	public	property	The name of the type/bundle field.
SchedulerPlugin::$unpublishAction	public	property	The name of the unpublish action for the entity type (optional).
SchedulerPlugin::$userViewRoute	public	property	The route of the scheduled view on the user profile page (optional).