block_visibility_groups.module in Block Visibility Groups 8

Contains block_visibility_groups.module.

File

block_visibility_groups.module

<?php

/**
 * @file
 * Contains block_visibility_groups.module.
 */
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Url;

/**
 * Implements hook_help().
 */
function block_visibility_groups_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {

    // Main module help for the block_visibility_groups module.
    case 'help.page.block_visibility_groups':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('Allows the site administrator to easily manage complex visibility settings that apply to any block placed in a visibility group.');
      $output .= t('The visibility settings for all blocks in the group can be edited on one administration form.') . '</p>';
      return $output;
    default:
  }
}

/**
 * Implements hook_entity_type_alter().
 */
function block_visibility_groups_entity_type_alter(array &$entity_types) {

  /**
   * @var \Drupal\Core\Config\Entity\ConfigEntityType $block_type;
   */
  $block_type = $entity_types['block'];
  $block_type
    ->setHandlerClass('list_builder', 'Drupal\\block_visibility_groups\\BlockVisibilityGroupedListBuilder');
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function block_visibility_groups_form_block_form_alter(&$form, FormStateInterface &$form_state, $form_id) {
  $form['actions']['submit']['#submit'][] = 'block_visibility_groups_block_form_submit';
  if (isset($form['visibility']['condition_group']['block_visibility_group']['#default_value']) && $form['visibility']['condition_group']['block_visibility_group']['#default_value']) {
    $storage = \Drupal::entityTypeManager()
      ->getStorage('block_visibility_group');

    /** @var \Drupal\block_visibility_groups\Entity\BlockVisibilityGroup $group */
    $group = $storage
      ->load($form['visibility']['condition_group']['block_visibility_group']['#default_value']);
    if (!$group
      ->isAllowOtherConditions()) {
      _block_visibility_groups_remove_conditions($form['visibility']);
    }
  }
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function block_visibility_groups_form_block_delete_form_alter(&$form, FormStateInterface &$form_state, $form_id) {
  $form['actions']['submit']['#submit'][] = 'block_visibility_groups_block_form_submit';
}

/**
 * Helper function to remove other groups from the form.
 *
 * @internal
 */
function _block_visibility_groups_remove_conditions(&$form) {
  $keys = array_diff(array_keys($form), [
    'visibility_tabs',
    'condition_group',
  ]);
  $form = array_diff_key($form, array_flip($keys));
}

/**
 * Submit call back for block edit and delete forms.
 *
 * @internal
 */
function block_visibility_groups_block_form_submit($form, FormStateInterface $form_state) {
  if ($block_visibility_group_query = $form_state
    ->getTemporaryValue('block_visibility_group_query')) {
    _block_visibility_groups_add_group_to_redirect($form_state, $block_visibility_group_query);
  }
  else {

    // If group was sent in query string redirect to that group.
    if ($group = Drupal::request()
      ->get('block_visibility_group')) {
      if ($form['#form_id'] == 'block_delete_form') {
        _block_visibility_groups_add_group_to_redirect($form_state, $group);
        return;
      }

      /* @var \Drupal\block\BlockInterface $block */
      $block = $form_state
        ->getFormObject()
        ->getEntity();
      $condition_info = $block
        ->getVisibilityCondition('condition_group')
        ->getConfiguration();
      if (!empty($condition_info['block_visibility_group'])) {
        _block_visibility_groups_add_group_to_redirect($form_state, $condition_info['block_visibility_group']);
      }
    }
  }
}

/**
 * Helper function to add group id to the form state redirect.
 *
 * @internal
 */
function _block_visibility_groups_add_group_to_redirect(FormStateInterface $form_state, $group_id) {
  $redirect = $form_state
    ->getRedirect();
  if ($redirect && $redirect instanceof Url) {
    $query = $redirect
      ->getOption('query');
    $query['block_visibility_group'] = $group_id;
    $redirect
      ->setOption('query', $query);
  }
}

Functions

Name	Description
block_visibility_groups_block_form_submit	Submit call back for block edit and delete forms.
block_visibility_groups_entity_type_alter	Implements hook_entity_type_alter().
block_visibility_groups_form_block_delete_form_alter	Implements hook_form_FORM_ID_alter().
block_visibility_groups_form_block_form_alter	Implements hook_form_FORM_ID_alter().
block_visibility_groups_help	Implements hook_help().
_block_visibility_groups_add_group_to_redirect	Helper function to add group id to the form state redirect.
_block_visibility_groups_remove_conditions	Helper function to remove other groups from the form.