class MaintenanceModeActivate in Automatic Updates 8

Put site into maintenance mode if there are database updates.

Plugin annotation

@DatabaseUpdateHandler(
  id = "maintenance_mode_activate",
  label = "Put site into maintenance mode",
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\automatic_updates\DatabaseUpdateHandlerPluginBase implements DatabaseUpdateHandlerInterface
    • class \Drupal\automatic_updates\Plugin\DatabaseUpdateHandler\MaintenanceModeActivate implements ContainerFactoryPluginInterface

File

src/Plugin/DatabaseUpdateHandler/MaintenanceModeActivate.php, line 19

Namespace

Drupal\automatic_updates\Plugin\DatabaseUpdateHandler

class MaintenanceModeActivate extends DatabaseUpdateHandlerPluginBase implements ContainerFactoryPluginInterface {

  /**
   * The state.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * The logger.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * Constructs a new maintenance mode service.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\State\StateInterface $state
   *   The state.
   * @param \Psr\Log\LoggerInterface $logger
   *   The logger.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, StateInterface $state, LoggerInterface $logger) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->state = $state;
    $this->logger = $logger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('state'), $container
      ->get('logger.channel.automatic_updates'));
  }

  /**
   * {@inheritdoc}
   */
  public function execute() {
    $this->logger
      ->notice('Maintenance mode activated.');
    $this->state
      ->set('system.maintenance_mode', TRUE);
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DatabaseUpdateHandlerPluginBase::label	public	function	Returns the translated plugin label. Overrides DatabaseUpdateHandlerInterface::label
MaintenanceModeActivate::$logger	protected	property	The logger.
MaintenanceModeActivate::$state	protected	property	The state.
MaintenanceModeActivate::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
MaintenanceModeActivate::execute	public	function	Handle database updates. Overrides DatabaseUpdateHandlerInterface::execute
MaintenanceModeActivate::__construct	public	function	Constructs a new maintenance mode service. Overrides PluginBase::__construct
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.