Drupal State

Drupal State 是 Drupal 中一个非常重要的概念。在 Drupal 中，一个 state 表示着某个东西的当前状态。这个东西可以是网站上的一个表单、一个节点或者一个用户等等。当一个 state 改变的时候，Drupal 会触发相应的事件，从而执行相应的操作。

Drupal State 的基础概念

State key

一个 state key 是一个字符串，用来唯一标识一个 state。在 Drupal 中，通常这个字符串是一个由两个部分构成的字符串，由冒号分隔。第一部分是一个常量字符串，用来表示这个 state 所在的模块或者子系统。第二部分是一个描述这个 state 的字符串。

例如，system.maintenance_mode 这个 state key 表示系统维护模式的状态。

State value

一个 state value 是当前 state 的值。这个值可以是任何 PHP 值，例如一个布尔值、一个字符串或者一个数组。

Setting a state

要设置一个 state，你需要调用 state_set() 函数。这个函数接受两个参数，第一个参数是 state key，第二个参数是 state value。

例如，下面的代码设置了系统维护模式的状态为开启：

state_set('system.maintenance_mode', TRUE);

Getting a state

要获取一个 state，你需要调用 state_get() 函数，这个函数接受一个参数，就是 state key。如果这个 state 存在，则函数返回 state 的值，否则返回 NULL。

例如，下面的代码获取了当前系统维护模式的状态：

$maintenance_mode = state_get('system.maintenance_mode');

Drupal State 的高级应用

State API

Drupal 提供了一个 State API，用于简化 state 的管理。这个 API 包括了一些函数，可以帮助你设置和获取 state。这些函数包括：

• state_set()：设置一个 state。
• state_get()：获取一个 state。
• state_del()：删除一个 state。
• state_get_multiple()：获取多个 state。

这些函数使用起来非常简单。例如，下面的代码使用 State API 来设置和获取当前系统维护模式的状态：

// 设置维护模式为开启状态
\Drupal::state()->set('system.maintenance_mode', TRUE);

// 获取维护模式的状态值
$maintenance_mode = \Drupal::state()->get('system.maintenance_mode');

State Events

Drupal 提供了一些 State Events，当一个 state 改变的时候，这些事件会被触发。你可以使用这些事件来执行一些额外的操作。

这些事件包括：

• state_changed：当一个 state 改变的时候触发。这个事件包含三个参数：state key、旧的 state value 和新的 state value。
• state_changed_SYSTEM：当一个系统级别的 state 改变的时候触发。这个事件包含三个参数：state key、旧的 state value 和新的 state value。

使用这些事件也非常简单。例如，下面的代码使用 State Events 来记录用户登录历史：

use Drupal\Core\State\StateEvents;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

class UserLoginHistory implements EventSubscriberInterface {

  public static function getSubscribedEvents() {
    $events[StateEvents::STATE_CHANGED]['onStateChanged'] = array('onStateChanged');
    return $events;
  }

  public function onStateChanged(StateChangeEvent $event) {
    $key = $event->getKey();
    $new_value = $event->getNewValue();
    if ($key == 'user.login.history') {
      $log = \Drupal::logger('user_login');
      $log->info(t('User login history changed: @history', ['@history' => print_r($new_value, TRUE)]));
    }
  }
}

总结

Drupal State 是 Drupal 中非常重要的概念，用来表示某个东西的当前状态。要使用 Drupal State，你需要了解 state key 和 state value，以及如何设置和获取 state。另外，你还可以使用 State API 来简化 state 的管理，使用 State Events 来执行额外的操作。