final class DatabaseUpdateHandler in Automatic Updates 8

Defines a DatabaseUpdateHandler annotation object.

Plugin Namespace: Plugin\DatabaseUpdateHandler.

For a working example, see \Drupal\automatic_updates\Plugin\DatabaseUpdateHandler\MaintenanceMode.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\automatic_updates\Annotation\DatabaseUpdateHandler

See also

\Drupal\automatic_updates\DatabaseUpdateHandlerInterface

\Drupal\automatic_updates\DatabaseUpdateHandlerPluginBase

\Drupal\automatic_updates\DatabaseUpdateHandlerPluginManager

hook_database_update_handler_plugin_info_alter()

Plugin API

5 classes are annotated with DatabaseUpdateHandler

ExecuteUpdates in src/Plugin/DatabaseUpdateHandler/ExecuteUpdates.php

Execute database updates.

IgnoreUpdates in src/Plugin/DatabaseUpdateHandler/IgnoreUpdates.php

Ignore database updates.

MaintenanceModeActivate in src/Plugin/DatabaseUpdateHandler/MaintenanceModeActivate.php

Put site into maintenance mode if there are database updates.

MaintenanceModeDisactivate in src/Plugin/DatabaseUpdateHandler/MaintenanceModeDisactivate.php

Remove site from maintenance mode.

RollbackUpdate in src/Plugin/DatabaseUpdateHandler/RollbackUpdate.php

Rollback database updates.

File

src/Annotation/DatabaseUpdateHandler.php, line 23

Namespace

Drupal\automatic_updates\Annotation

final class DatabaseUpdateHandler extends Plugin {

  /**
   * The ID of the handler, should match the service name.
   *
   * @var string
   */
  public $id;

  /**
   * The name of the handler.
   *
   * @var string
   */
  public $label;

}

Members

Name	Modifiers	Type	Description	Overrides
DatabaseUpdateHandler::$id	public	property	The ID of the handler, should match the service name.
DatabaseUpdateHandler::$label	public	property	The name of the handler.
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