interface EntityMonitorUpdateRunnerInterface in Scheduled Updates 8

Provides an interface Update runners that need to monitor entities.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface
  • interface \Drupal\scheduled_updates\Plugin\UpdateRunnerInterface
    • interface \Drupal\scheduled_updates\Plugin\EntityMonitorUpdateRunnerInterface

2 files declare their use of EntityMonitorUpdateRunnerInterface

EmbeddedUpdateRunner.php in src/Plugin/UpdateRunner/EmbeddedUpdateRunner.php

Contains \Drupal\scheduled_updates\Plugin\UpdateRunner\EmbeddedUpdateRunner.

UpdateRunnerUtils.php in src/UpdateRunnerUtils.php

Contains \Drupal\scheduled_updates\UpdateRunnerUtils.

File

src/Plugin/EntityMonitorUpdateRunnerInterface.php, line 17

Namespace

Drupal\scheduled_updates\Plugin

interface EntityMonitorUpdateRunnerInterface extends UpdateRunnerInterface {

  /**
   * Fires when entity of type to be updated is changed.
   *
   * This function is fired every time and entity of the type that the Scheduled Update Type is up
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *
   * @return mixed
   */
  public function onEntityUpdate(ContentEntityInterface $entity);

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	112
EntityMonitorUpdateRunnerInterface::onEntityUpdate	public	function	Fires when entity of type to be updated is changed.	1
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
UpdateRunnerInterface::addUpdatesToQueue	public	function	Add all updates to queue.	1
UpdateRunnerInterface::AFTER_ARCHIVE		constant
UpdateRunnerInterface::AFTER_DELETE		constant
UpdateRunnerInterface::getDescription	public	function	Get the description of the Runner Plugin.	1
UpdateRunnerInterface::getEntityReferenceTargetIds	public	function	Get target entity ids for an entity reference field on a entity.	1
UpdateRunnerInterface::getInvalidUpdateBehavior	public	function	Get how this runner should handle invalid entity updates.	1
UpdateRunnerInterface::getQueue	public	function	Get the Queue for this Update Runner.	1
UpdateRunnerInterface::getReferencingFieldIds	public	function	Get all field ids that are attached to the entity type to be updated and target this update type.	1
UpdateRunnerInterface::INVALID_ARCHIVE		constant
UpdateRunnerInterface::INVALID_DELETE		constant
UpdateRunnerInterface::INVALID_REQUEUE		constant
UpdateRunnerInterface::isRunByCron	public	function	Get whether or not the updates are run by cron.	1
UpdateRunnerInterface::REVISIONS_BUNDLE_DEFAULT		constant
UpdateRunnerInterface::REVISIONS_NO		constant
UpdateRunnerInterface::REVISIONS_YES		constant
UpdateRunnerInterface::runUpdatesInQueue	public	function	Run all updates that are in the queue.	1
UpdateRunnerInterface::setRunByCron	public	function	Set wether or not the updates are run by cron.	1
UpdateRunnerInterface::updateEntityType	public	function	Return the entity id of the entity type being updated.	1
UpdateRunnerInterface::USER_OWNER		constant
UpdateRunnerInterface::USER_REVISION_OWNER		constant
UpdateRunnerInterface::USER_UPDATE_OWNER		constant
UpdateRunnerInterface::USER_UPDATE_RUNNER		constant