og_sm-8.x-1.0/og_sm_taxonomy/src/FormAlter/TermOverviewFormAlter.php

<?php

namespace Drupal\og_sm_taxonomy\FormAlter;

use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Render\Element;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Core\Url;
use Drupal\node\NodeInterface;
use Drupal\og\OgAccessInterface;
use Drupal\og_sm\SiteManagerInterface;
use Drupal\og_sm_context\Plugin\OgGroupResolver\QueryParamGroupResolver;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Helper for taxonomy_overview_terms form alter hook.
 *
 * @see og_sm_taxonomy_form_taxonomy_overview_terms_alter()
 */
class TermOverviewFormAlter implements ContainerInjectionInterface {

  use StringTranslationTrait;

  /**
   * The site manager.
   *
   * @var \Drupal\og_sm\SiteManagerInterface
   */
  protected $siteManager;

  /**
   * The OG access service.
   *
   * @var \Drupal\og\OgAccessInterface
   */
  protected $ogAccess;

  /**
   * Construct a TermOverviewFormAlter object.
   *
   * @param \Drupal\og_sm\SiteManagerInterface $site_manager
   *   The site manager.
   * @param \Drupal\og\OgAccessInterface $og_access
   *   The OG access handler.
   */
  public function __construct(SiteManagerInterface $site_manager, OgAccessInterface $og_access) {
    $this->siteManager = $site_manager;
    $this->ogAccess = $og_access;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static(
      $container->get('og_sm.site_manager'),
      $container->get('og.access')
    );
  }

  /**
   * This is a helper for og_sm_taxonomy_form_taxonomy_overview_terms_alter().
   *
   * @param array $form
   *   The form variable.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   */
  public function formAlter(array &$form, FormStateInterface $form_state) {
    $site = $this->siteManager->currentSite();
    if (!$site) {
      $this->addSiteTitles($form);
      return;
    }

    $this->removeInaccessibleTerms($form);
    $this->alterEmptyText($form, $form_state, $site);
    $this->alterAlphabeticalSubmitHandler($form, $form_state, $site);
  }

  /**
   * Alters terms administration form by adding the Site titles to the terms.
   *
   * @param array $form
   *   The form structure.
   */
  public function addSiteTitles(array &$form) {
    foreach (Element::children($form['terms']) as $key) {
      if (!preg_match('/^tid\:[0-9]+/', $key)) {
        continue;
      }

      $element = &$form['terms'][$key];

      /** @var \Drupal\taxonomy\TermInterface $term */
      $term = $element['#term'];
      $site = $this->siteManager->getSiteFromEntity($term);
      if (!$site) {
        continue;
      }

      $element['term']['#suffix'] = ' <small>(' . $site->label() . ')</small>';
    }
  }

  /**
   * Remove inaccesibe terms.
   *
   * @param array $form
   *   The form structure.
   */
  public function removeInaccessibleTerms(array &$form) {
    foreach (Element::children($form['terms']) as $key) {
      if (!isset($form['terms'][$key]['#term'])) {
        continue;
      }

      /** @var \Drupal\taxonomy\TermInterface $term */
      $term = $form['terms'][$key]['#term'];

      $result = $term->access('view', NULL, TRUE);
      $result->andIf($this->ogAccess->userAccessEntity('view', $form['terms'][$key]['#term']));

      if ($result->isForbidden()) {
        unset($form['terms'][$key]);
      }
    }
  }

  /**
   * Alters the empty text link to add the first Site term for the vocabulary.
   *
   * @param array $form
   *   The form structure.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   * @param \Drupal\node\NodeInterface $site
   *   The site node.
   */
  public function alterEmptyText(array &$form, FormStateInterface $form_state, NodeInterface $site) {
    // Only when there is an empty text element.
    if (empty($form['terms']['#empty'])) {
      return;
    }
    /** @var \Drupal\taxonomy\VocabularyInterface $vocabulary */
    $vocabulary = $form_state->get(['taxonomy', 'vocabulary']);
    $add_term_link = Url::fromRoute('og_sm_taxonomy.vocabulary.term_add', [
      'node' => $site->id(),
      'taxonomy_vocabulary' => $vocabulary->id(),
    ])->toString();

    $form['terms']['#empty'] = $this->t('No terms available. <a href=":link">Add term</a>.', [':link' => $add_term_link]);
  }

  /**
   * Adds a custom submit handler to the alphabetical reset button.
   *
   * @param array $form
   *   The form structure.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   * @param \Drupal\node\NodeInterface $site
   *   The site node.
   *
   * @see og_sm_taxonomy_form_taxonomy_overview_terms_alter()
   */
  public function alterAlphabeticalSubmitHandler(array &$form, FormStateInterface $form_state, NodeInterface $site) {
    $form_state->set('site', $site);

    // Custom submit handler.
    $form['actions']['reset_alphabetical']['#submit'][] = [$this, 'submitReset'];
  }

  /**
   * Custom submit handler for the alphabetical reset button.
   *
   * Adds the current site to the reset alphabetical redirect url in order to
   * keep site context on the confirm page.
   *
   * @param array $form
   *   The form structure.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   */
  public function submitReset(array $form, FormStateInterface $form_state) {
    /** @var \Drupal\Core\Url $redirect_url */
    $redirect_url = $form_state->getRedirect();
    $redirect_url->setRouteParameter(QueryParamGroupResolver::SITE_ID_ARGUMENT, $form_state->get('site')->id());
  }

}