interface SchedulerPluginInterface in Scheduler 2.x
Interface for Scheduler entity plugin definition.
Hierarchy
- interface \Drupal\scheduler\SchedulerPluginInterface
Expanded class hierarchy of SchedulerPluginInterface
All classes that implement SchedulerPluginInterface
File
- src/
SchedulerPluginInterface.php, line 8
Namespace
Drupal\schedulerView source
interface SchedulerPluginInterface {
/**
* Get the label.
*
* @return mixed
* The label.
*/
public function label();
/**
* Get the description.
*
* @return mixed
* The description.
*/
public function description();
/**
* Get the type of entity supported by this plugin.
*
* @return string
* The name of the entity type.
*/
public function entityType();
/**
* Get the name of the "type" field for the entity.
*
* @return string
* The name of the type/bundle field for this entity type.
*/
public function typeFieldName();
/**
* Get module dependency.
*
* @return string
* The name of the required module.
*/
public function dependency();
/**
* Get the id of the Devel Generate form for this entity type. Optional.
*
* @return string
* The form id.
*/
public function develGenerateForm();
/**
* Get the route of the user page scheduled view. Optional.
*
* @return string
* The route id.
*/
public function userViewRoute();
/**
* Get the scheduler event class.
*
* Optional. Defaults to '\Drupal\scheduler\Event\Scheduler{Type}Events' the
* event class within the Scheduler module namespace.
*
* @return string
* The event class.
*/
public function schedulerEventClass();
/**
* Get the publish action name of the entity type.
*
* Optional. Defaults to the commonly used {entity type id}_publish_action.
*
* @return string
* The action name.
*/
public function publishAction();
/**
* Get the unpublish action name of the entity type.
*
* Optional. Defaults to the commonly used {entity type id}_unpublish_action.
*
* @return string
* The action name.
*/
public function unpublishAction();
/**
* Get all the type/bundle objects for this entity.
*
* @return array
* The type/bundle objects.
*/
public function getTypes();
/**
* Get the form IDs for entity add/edit forms.
*
* @return array
* A list of add/edit form ids for all bundles in this entity type.
*/
public function entityFormIds();
/**
* Get the form IDs for entity type add/edit forms.
*
* @return array
* A list of add/edit form ids for this entity type.
*/
public function entityTypeFormIds();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
SchedulerPluginInterface:: |
public | function | Get module dependency. | 1 |
SchedulerPluginInterface:: |
public | function | Get the description. | 1 |
SchedulerPluginInterface:: |
public | function | Get the id of the Devel Generate form for this entity type. Optional. | 1 |
SchedulerPluginInterface:: |
public | function | Get the form IDs for entity add/edit forms. | 1 |
SchedulerPluginInterface:: |
public | function | Get the type of entity supported by this plugin. | 1 |
SchedulerPluginInterface:: |
public | function | Get the form IDs for entity type add/edit forms. | 1 |
SchedulerPluginInterface:: |
public | function | Get all the type/bundle objects for this entity. | 1 |
SchedulerPluginInterface:: |
public | function | Get the label. | 1 |
SchedulerPluginInterface:: |
public | function | Get the publish action name of the entity type. | 1 |
SchedulerPluginInterface:: |
public | function | Get the scheduler event class. | 1 |
SchedulerPluginInterface:: |
public | function | Get the name of the "type" field for the entity. | 1 |
SchedulerPluginInterface:: |
public | function | Get the unpublish action name of the entity type. | 1 |
SchedulerPluginInterface:: |
public | function | Get the route of the user page scheduled view. Optional. | 1 |