Question

我有以下情况：我想根据当前用户的字段隐藏或显示一些本地任务（Tab）。因此，我实现了hook_menu_local_tasks_alter() in my_module/my_module.module：

function my_module_menu_local_tasks_alter(&$data, $route_name, \Drupal\Core\Cache\RefinableCacheableDependencyInterface &$cacheability) {
  ... some logic ...

  if ($user->get('field_my_field')->getValue() === 'some value')
    unset($data['tabs'][0]['unwanted_tab_0']);
    unset($data['tabs'][0]['unwanted_tab_1']);

  ... some logic ...
}

这工作正常，但是如果field_my_field的值更改，我需要清除缓存。

所以我发现我需要在my_module_menu_local_tasks_alter中实现这样的缓存上下文：

$cacheability
  ->addCacheTags([
    'user.available_regions',
  ]);

我已经这样定义了我的缓存上下文：

my_module/my_module.services.yml：

services:
  cache_context.user.available_regions:
    class: Drupal\my_module\CacheContext\AvailableRegions
    arguments: ['@current_user']
    tags:
      - { name: cache.context }

my_module/src/CacheCotext/AvailableRegions.php:

<?php

namespace Drupal\content_sharing\CacheContext;

use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Cache\Context\CacheContextInterface;
use Drupal\Core\Session\AccountProxyInterface;

/**
* Class AvailableRegions.
*/
class AvailableRegions implements CacheContextInterface {

  protected $currentUser;

  /**
   * Constructs a new DefaultCacheContext object.
   */
  public function __construct(AccountProxyInterface $current_user) {
    $this->currentUser = $current_user;
  }

  /**
  * {@inheritdoc}
  */
  public static function getLabel() {
    return t('Available sub pages.');
  }

  /**
  * {@inheritdoc}
  */
  public function getContext() {
    // Actual logic of context variation will lie here.
    $field_published_sites = $this->get('field_published_sites')->getValue();

    $sites = [];
    foreach ($field_published_sites as $site) {
      $sites[] = $site['target_id'];
    }

    return implode('|', $sites);
  }

  /**
  * {@inheritdoc}
  */
  public function getCacheableMetadata() {
    return new CacheableMetadata();
  }

}

但是，每次更改字段field_my_field的值时，我仍然需要清除缓存，因此上下文无法正常工作。任何人都可以向我指出正确的方向，如何解决此问题或调试这种问题？

Answer 1

代替提供自定义缓存上下文，您应该能够使用core提供的默认可缓存性。我认为问题不仅仅在于可缓存元数据的创建，似乎您的hook_menu_local_tasks_alter正在更改现在不依赖用户的内容。因此，我认为您需要两件事：

表示“此菜单内容现在依赖于用户”的常规缓存上下文，例如。 user缓存上下文。
针对特定用户的缓存标记的附加用法是：“一旦缓存了该缓存，当此用户实体更改时，请重新生成该用户的本地任务”。

请注意，HOOK_menu_local_tasks_alter为$cacheability的第三个参数的可缓存性提供了帮助。 Drupal核心在这里还提供了一种机制，使我们可以说“此缓存数据依赖于另一缓存数据”。

因此，您应该可以执行以下操作：

function my_module_menu_local_tasks_alter(&$data, $route_name, RefinableCacheableDependencyInterface &$cacheability) {
  ... some logic ...

  // We are going to alter content by user.
  $cacheability->addCacheableDependency($user);

  // Note if you still really need your custom context, you could add it.
  // Also note that any user.* contexts should already be covered above.
  $cacheability->addCacheContexts(['some_custom_contexts']);

  if ($user->get('field_my_field')->getValue() === 'some value')
    unset($data['tabs'][0]['unwanted_tab_0']);
    unset($data['tabs'][0]['unwanted_tab_1']);

  ... some logic ...
}

Drupal 8-添加自定义缓存上下文

1 个答案: