You are here

class MaintenanceModeEnabled in JSON-RPC 8

Same name and namespace in other branches
  1. 2.x modules/jsonrpc_core/src/Plugin/jsonrpc/Method/MaintenanceModeEnabled.php \Drupal\jsonrpc_core\Plugin\jsonrpc\Method\MaintenanceModeEnabled

RPC method to enable or disable maintenance mode.

@JsonRpcMethod( id = "maintenance_mode.isEnabled", usage = @Translation("Enables or disables the maintenance mode."), access = {"administer site configuration"}, params = { "enabled" = @JsonRpcParameterDefinition(schema={"type"="boolean"}), } ),

Hierarchy

Expanded class hierarchy of MaintenanceModeEnabled

File

modules/jsonrpc_core/src/Plugin/jsonrpc/Method/MaintenanceModeEnabled.php, line 23

Namespace

Drupal\jsonrpc_core\Plugin\jsonrpc\Method
View source
class MaintenanceModeEnabled extends JsonRpcMethodBase {
  const ENABLED = 'enabled';
  const DISABLED = 'disabled';

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

  /**
   * MaintenanceModeEnabled constructor.
   *
   * @param array $configuration
   *   The configuration.
   * @param string $plugin_id
   *   The ID of the plugin.
   * @param \Drupal\jsonrpc\MethodInterface $plugin_definition
   *   The plugin definition.
   * @param \Drupal\Core\State\StateInterface $state
   *   The state API service.
   */
  public function __construct(array $configuration, $plugin_id, MethodInterface $plugin_definition, StateInterface $state) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->state = $state;
  }

  /**
   * Create an instance of this plugin.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The DI container.
   * @param array $configuration
   *   The configuration.
   * @param string $plugin_id
   *   The ID of the plugin.
   * @param mixed $plugin_definition
   *   The plugin definition.
   *
   * @return \Drupal\jsonrpc_core\Plugin\jsonrpc\Method\MaintenanceModeEnabled
   *   An instance of the MaintenanceModeEnabled plugin.
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('state'));
  }

  /**
   * {@inheritdoc}
   */
  public function execute(ParameterBag $parameters) {
    $enabled = $parameters
      ->get('enabled');
    $this->state
      ->set('system.maintenance_mode', $enabled);
    return $this->state
      ->get('system.maintenance_mode') ? static::ENABLED : static::DISABLED;
  }

  /**
   * {@inheritdoc}
   */
  public static function outputSchema() {
    return [
      'type' => 'string',
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
JsonRpcMethodBase::$rpcRequest private property The RPC request for the current invocation.
JsonRpcMethodBase::currentRequest protected function The RPC request for the current invocation.
JsonRpcMethodBase::methodDefinition protected function The RPC method definition for the current invocation.
MaintenanceModeEnabled::$state protected property The state API service.
MaintenanceModeEnabled::create public static function Create an instance of this plugin. Overrides JsonRpcMethodBase::create
MaintenanceModeEnabled::DISABLED constant
MaintenanceModeEnabled::ENABLED constant
MaintenanceModeEnabled::execute public function Executes the action with the parameters passed in. Overrides ExecutableWithParamsInterface::execute
MaintenanceModeEnabled::outputSchema public static function Provides the schema that describes the results of the RPC method. Overrides JsonRpcMethodBase::outputSchema
MaintenanceModeEnabled::__construct public function MaintenanceModeEnabled constructor. Overrides JsonRpcMethodBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.