153/maintenance mode

.lando.yml

@@ -4,10 +4,8 @@ config:
   php: 7.4
   webroot: backdrop
   database: mariadb
-  # Although Drush isn't needed/used, the version that Lando includes by default
-  # has a bug that causes all build steps to fail. We therefore need to update
-  # Drush to the latest version just to make sure that build steps run properly.
-  backdrush: 1.x-1.x
+  backdrush: '1.x-1.x'
+
 services:
   appserver:
     build:

commands/state.bee.inc

@@ -0,0 +1,115 @@
+<?php
+/**
+ * @file
+ * Command(s) for getting and setting backdrop states.
+ */
+
+/**
+ * Implements hook_bee_command().
+ */
+function state_bee_command() {
+  return [
+    'state-get' => [
+      'description' => bt('Get the value of a Backdrop state.'),
+      'callback' => 'state_get_bee_callback',
+      'arguments' => [
+        'state' => bt('The name of the state to get.'),
+      ],
+      'aliases' => ['sg, sget'],
+      'bootstrap' => BEE_BOOTSTRAP_FULL,
+      'examples' => [
+        'bee state-get maintanance_mode' => bt('Get the value of the Backdrop state named "maintanance_mode".'),
+      ],
+    ],
+    'state-set' => [
+      'description' => bt('Set the value of a Backdrop state.'),
+      'callback' => 'state_set_bee_callback',
+      'arguments' => [
+        'state' => bt('The name of the state to set.'),
+        'value' => bt('The value to set the state to.'),
+      ],
+      'aliases' => ['ss, sset'],
+      'bootstrap' => BEE_BOOTSTRAP_FULL,
+      'examples' => [
+        'bee state-set maintanance_mode 1' => bt('Set the value of the Backdrop state named "maintanance_mode" to 1.'),
+      ],
+    ],
+    'maintenance-mode' => [
+      'description' => bt('Set the value of maintenance_mode for Backdrop.'),
+      'callback' => 'maintenance_mode_bee_callback',
+      'arguments' => [
+        'value' => bt('The value to set maintenance_mode to.'),
+      ],
+      'aliases' => ['mm',],
+      'bootstrap' => BEE_BOOTSTRAP_FULL,
+      'examples' => [
+        'bee maintanance-mode 1' => bt('Set the value of the Backdrop maintenance_mode to 1.'),
+      ],
+    ],
+  ];
+}
+
+/**
+ * Command callback: Get the value of a Backdrop state.
+ */
+function state_get_bee_callback($arguments, $options) {
+  try {
+    $value = state_get($arguments['state']);
+    $msg = bt('The value of the Backdrop state named "@state" is "@value".', [
+      '@state' => $arguments['state'],
+      '@value' => $value,
+    ]);
+    bee_message($msg, 'status');
+  }
+  catch(ParseError $e) {
+    // This is more readable than the default error we would get from PHP.
+    $err_msg = bt('!msg in: !state', array(
+      '!msg' => $e->getMessage(),
+      '!state' => $arguments['state'],
+    ));
+    bee_message($err_msg, 'error');
+  }
+}
+
+/**
+ * Command callback: Set the value of a Backdrop state.
+ */
+function state_set_bee_callback($arguments, $options) {
+  try {
+    state_set($arguments['state'], (int) $arguments['value']);
+    $msg = bt('The value of the Backdrop state named "@state" is "@value".', [
+      '@state' => $arguments['state'],
+      '@value' => $arguments['value'],
+    ]);
+    bee_message($msg, 'success');
+  }
+  catch(ParseError $e) {
+    // This is more readable than the default error we would get from PHP.
+    $err_msg = bt('!msg in: !state', array(
+      '!msg' => $e->getMessage(),
+      '!state' => $arguments['state'],
+    ));
+    bee_message($err_msg, 'error');
+  }
+}
+
+  /**
+   * Command callback: Set the value of a maintenance_mode for Backdrop.
+   */
+  function maintenance_mode_bee_callback($arguments, $options) {
+    try {
+      state_set('maintenance_mode', (int) $arguments['value']);
+      $msg = bt('The value of the Backdrop maintenance_mode is "@value".', [
+        '@value' => $arguments['value'],
+      ]);
+      bee_message($msg, 'success');
+    }
+    catch(ParseError $e) {
+      // This is more readable than the default error we would get from PHP.
+      $err_msg = bt('!msg in: !value', array(
+        '!msg' => $e->getMessage(),
+        '!value' => $arguments['value'],
+      ));
+      bee_message($err_msg, 'error');
+    }
+  }

tests/backdrop/StateCommandsTest.php

@@ -0,0 +1,43 @@
+<?php
+/**
+ * @file
+ * PHPUnit tests for Bee State commands.
+ */
+
+use PHPUnit\Framework\TestCase;
+
+class StateCommandsTest extends TestCase {
+
+  /**
+   * Make sure that the state-get command works.
+   */
+  public function test_state_get_command_works() {
+    $output_all = shell_exec('bee state-get maintenance_mode');
+    $this->assertStringContainsString('0', $output_all);
+    $this->assertStringContainsString('maintenance_mode', $output_all);
+  }
+
+  /**
+   * Make sure that the state-set command works.
+   */
+  public function test_state_set_command_works() {
+    $output = shell_exec('bee state-get maintenance_mode');
+    $this->assertStringContainsString('maintenance_mode', $output);
+    $this->assertStringContainsString('0', $output);
+
+    $output = shell_exec('bee state-set maintenance_mode 1');
+    $this->assertStringContainsString('1', $output);
+  }
+
+    /**
+   * Make sure that the maintenance-mode command works.
+   */
+  public function test_maintenance_mode_command_works() {
+    $output = shell_exec('bee maintenance_mode 1');
+    $this->assertStringContainsString('maintenance_mode', $output);
+    $this->assertStringContainsString('1', $output);
+
+    $output = shell_exec('bee state-set maintenance_mode 0');
+    $this->assertStringContainsString('0', $output);
+  }
+}

tests/phpunit.xml

@@ -4,6 +4,7 @@
       <file>backdrop/BeeCoreTest.php</file>
       <file>backdrop/CacheCommandsTest.php</file>
       <file>backdrop/ConfigCommandsTest.php</file>
+      <file>backdrop/StateCommandsTest.php</file>
       <file>backdrop/CronCommandsTest.php</file>
       <file>backdrop/DBCommandsTest.php</file>
       <file>backdrop/DBLogCommandsTest.php</file>