LanguageSelectionPageConditionIgnoreNeutral.php in Language Selection Page 8.2

Namespace

Drupal\language_selection_page\Plugin\LanguageSelectionPageCondition

File

src/Plugin/LanguageSelectionPageCondition/LanguageSelectionPageConditionIgnoreNeutral.php

<?php

declare (strict_types=1);
namespace Drupal\language_selection_page\Plugin\LanguageSelectionPageCondition;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\language_selection_page\LanguageSelectionPageConditionBase;
use Drupal\language_selection_page\LanguageSelectionPageConditionInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Class for the Ignore Language Neutral plugin.
 *
 * @LanguageSelectionPageCondition(
 *     id="ignore_neutral",
 *     weight=-40,
 *     name=@Translation("Ignore untranslatable (language neutral) entities"),
 *     description=@Translation("Ignore untranslatable entities (such as entities with language set to <em>Not specified</em> or <em>Not applicable</em>, or with content types that are not translatable)"),
 *     runInBlock=TRUE,
 * )
 */
final class LanguageSelectionPageConditionIgnoreNeutral extends LanguageSelectionPageConditionBase implements LanguageSelectionPageConditionInterface {

  /**
   * The route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * LanguageSelectionPageConditionIgnoreNeutral constructor.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The Route Match object.
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param array $plugin_definition
   *   The plugin implementation definition.
   */
  public function __construct(RouteMatchInterface $route_match, array $configuration, $plugin_id, array $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->routeMatch = $route_match;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form[$this
      ->getPluginId()] = [
      '#title' => $this
        ->t('Ignore untranslatable (language neutral) entities.'),
      '#type' => 'checkbox',
      '#default_value' => $this->configuration[$this
        ->getPluginId()],
      '#description' => $this
        ->t('Do not redirect to the language selection page if the entity on the page being viewed is not translatable (such as when it is language neutral, or if the content type it belongs to is not translatable).'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($container
      ->get('current_route_match'), $configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function evaluate() {

    // Check if the "ignore language neutral" option is checked.
    // If so, we will check if the entity is translatable, so that pages for
    // entities with default entity language set to LANGCODE_NOT_APPLICABLE or
    // LANGCODE_NOT_SPECIFIED, or where the content type is not translatable,
    // are ignored.
    if ($this->configuration[$this
      ->getPluginId()]) {
      foreach ($this->routeMatch
        ->getParameters() as $parameter) {
        if ($parameter instanceof ContentEntityInterface) {
          if (!$parameter
            ->isTranslatable()) {
            return $this
              ->block();
          }
        }
      }
    }
    return $this
      ->pass();
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::validateConfigurationForm($form, $form_state);
    $form_state
      ->set($this
      ->getPluginId(), (bool) $form_state
      ->get($this
      ->getPluginId()));
  }

}

Classes

Name	Description
LanguageSelectionPageConditionIgnoreNeutral	Class for the Ignore Language Neutral plugin.