BlockPluginHasSettingsTrayFormAccessCheck.php in Drupal 10

Namespace

Drupal\settings_tray\Access

File

core/modules/settings_tray/src/Access/BlockPluginHasSettingsTrayFormAccessCheck.php

<?php

namespace Drupal\settings_tray\Access;

use Drupal\block\BlockInterface;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Block\BlockPluginInterface;
use Drupal\Core\Plugin\PluginWithFormsInterface;
use Drupal\Core\Routing\Access\AccessInterface;

/**
 * Determines whether the requested block has a 'settings_tray' form.
 *
 * @internal
 */
class BlockPluginHasSettingsTrayFormAccessCheck implements AccessInterface {

  /**
   * Checks access for accessing a block's 'settings_tray' form.
   *
   * @param \Drupal\block\BlockInterface $block
   *   The block whose 'settings_tray' form is being accessed.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   */
  public function access(BlockInterface $block) {

    /** @var \Drupal\Core\Block\BlockPluginInterface $block_plugin */
    $block_plugin = $block
      ->getPlugin();
    return $this
      ->accessBlockPlugin($block_plugin);
  }

  /**
   * Checks access for accessing a block plugin's 'settings_tray' form.
   *
   * @param \Drupal\Core\Block\BlockPluginInterface $block_plugin
   *   The block plugin whose 'settings_tray' form is being accessed.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   *
   * @see settings_tray_preprocess_block()
   */
  public function accessBlockPlugin(BlockPluginInterface $block_plugin) {
    return AccessResult::allowedIf($block_plugin instanceof PluginWithFormsInterface && $block_plugin
      ->hasFormClass('settings_tray'));
  }

}

Classes

Name	Description
BlockPluginHasSettingsTrayFormAccessCheck	Determines whether the requested block has a 'settings_tray' form.