You are here

Home » API reference » GraphQL 8.3 » BlocksByRegion.php

class BlocksByRegion in GraphQL 8.3

List all blocks within a theme region.

Plugin annotation


@GraphQLField(
  id = "blocks_by_region",
  secure = true,
  name = "blocksByRegion",
  type = "[entity:block]",
  parents = {"InternalUrl"},
  arguments = {
    "region" = "String!"
  }
)

Hierarchy

Expanded class hierarchy of BlocksByRegion

File

modules/graphql_core/src/Plugin/GraphQL/Fields/Blocks/BlocksByRegion.php, line 35

Namespace

Drupal\graphql_core\Plugin\GraphQL\Fields\Blocks
View source 
class BlocksByRegion extends FieldPluginBase implements ContainerFactoryPluginInterface {

  /**
   * The theme manager.
   *
   * @var \Drupal\Core\Theme\ThemeManagerInterface
   */
  protected $themeManager;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity repository.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

  /**
   * The subrequest buffer service.
   *
   * @var \Drupal\graphql\GraphQL\Buffers\SubRequestBuffer
   */
  protected $subRequestBuffer;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
    return new static($configuration, $pluginId, $pluginDefinition, $container
      ->get('graphql.buffer.subrequest'), $container
      ->get('theme.manager'), $container
      ->get('entity_type.manager'), $container
      ->get('entity.repository'));
  }

  /**
   * BlocksByRegion constructor.
   *
   * @param array $configuration
   *   The plugin configuration array.
   * @param string $pluginId
   *   The plugin id.
   * @param mixed $pluginDefinition
   *   The plugin definition.
   * @param \Drupal\graphql\GraphQL\Buffers\SubRequestBuffer $subRequestBuffer
   *   The sub-request buffer service.
   * @param \Drupal\Core\Theme\ThemeManagerInterface $themeManager
   *   The theme manager service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager service.
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entityRepository
   *   The entity repository service.
   */
  public function __construct(array $configuration, $pluginId, $pluginDefinition, SubRequestBuffer $subRequestBuffer, ThemeManagerInterface $themeManager, EntityTypeManagerInterface $entityTypeManager, EntityRepositoryInterface $entityRepository) {
    parent::__construct($configuration, $pluginId, $pluginDefinition);
    $this->subRequestBuffer = $subRequestBuffer;
    $this->themeManager = $themeManager;
    $this->entityTypeManager = $entityTypeManager;
    $this->entityRepository = $entityRepository;
  }

  /**
   * {@inheritdoc}
   */
  protected function resolveValues($value, array $args, ResolveContext $context, ResolveInfo $info) {
    if ($value instanceof Url) {
      $activeTheme = $this->themeManager
        ->getActiveTheme();
      $blockStorage = $this->entityTypeManager
        ->getStorage('block');
      $blocks = $blockStorage
        ->loadByProperties([
        'theme' => $activeTheme
          ->getName(),
        'region' => $args['region'],
      ]);
      $resolve = $this->subRequestBuffer
        ->add($value, function () use ($blocks) {
        $blocks = array_filter($blocks, function (Block $block) {
          return array_reduce(iterator_to_array($block
            ->getVisibilityConditions()), function ($value, ConditionInterface $condition) {
            return $value && !$condition
              ->isNegated() == $condition
              ->evaluate();
          }, TRUE);
        });
        uasort($blocks, '\\Drupal\\Block\\Entity\\Block::sort');
        return $blocks;
      });
      return function ($value, array $args, ResolveContext $context, ResolveInfo $info) use ($resolve) {

        /** @var \Drupal\graphql\GraphQL\Cache\CacheableValue $response */
        $response = $resolve();
        $blocks = array_map(function (Block $block) {
          $plugin = $block
            ->getPlugin();
          if ($plugin instanceof BlockContentBlock) {
            return $this->entityRepository
              ->loadEntityByUuid('block_content', $plugin
              ->getDerivativeId());
          }
          else {
            return $block;
          }
        }, $response
          ->getValue());
        foreach ($blocks as $block) {
          (yield new CacheableValue($block, [
            $response,
          ]));
        }
      };
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ArgumentAwarePluginTrait::buildArgumentDefault protected function Builds an argument's default value.
ArgumentAwarePluginTrait::buildArgumentDescription protected function Builds an argument's description.
ArgumentAwarePluginTrait::buildArguments protected function Builds the list of arguments.
ArgumentAwarePluginTrait::buildArgumentType protected function Builds an argument's type.
BlocksByRegion::$entityRepository protected property The entity repository.
BlocksByRegion::$entityTypeManager protected property The entity type manager.
BlocksByRegion::$subRequestBuffer protected property The subrequest buffer service.
BlocksByRegion::$themeManager protected property The theme manager.
BlocksByRegion::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
BlocksByRegion::resolveValues protected function Retrieve the list of field values. Overrides FieldPluginBase::resolveValues
BlocksByRegion::__construct public function BlocksByRegion constructor. Overrides PluginBase::__construct
CacheablePluginTrait::buildCacheContexts protected function
DeprecatablePluginTrait::buildDeprecationReason protected function
DescribablePluginTrait::buildDescription protected function
FieldPluginBase::$isLanguageAware protected property Static cache for `isLanguageAwareField()`
FieldPluginBase::$languageContext protected property The language context service.
FieldPluginBase::$renderer protected property The renderer service. 1
FieldPluginBase::createInstance public static function Overrides FieldPluginInterface::createInstance
FieldPluginBase::getCacheDependencies protected function Retrieve the list of cache dependencies for a given value and arguments. 1
FieldPluginBase::getDefinition public function Returns the plugin's type or field definition for the schema. Overrides FieldPluginInterface::getDefinition
FieldPluginBase::getLanguageContext protected function Get the language context instance.
FieldPluginBase::getRenderer protected function Get the renderer service.
FieldPluginBase::isLanguageAwareField protected function Indicator if the field is language aware. 1
FieldPluginBase::resolve public function 1
FieldPluginBase::resolveDeferred protected function
FieldPluginBase::unwrapResult protected function Unwrap the resolved values.
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.
TypedPluginTrait::buildType protected function