You are here

Home » API reference » Language Selection Page 8.2 » LanguageSelectionPageConditionType.php

final class LanguageSelectionPageConditionType in Language Selection Page 8.2

Class for the Type condition plugin.

Plugin annotation


@LanguageSelectionPageCondition(
    id="type",
    weight=-90,
    name=@Translation("Type of operating mode and display"),
    description=@Translation("Select the operating mode and display."),
    runInBlock=FALSE,
)

Hierarchy

Expanded class hierarchy of LanguageSelectionPageConditionType

File

src/Plugin/LanguageSelectionPageCondition/LanguageSelectionPageConditionType.php, line 28

Namespace

Drupal\language_selection_page\Plugin\LanguageSelectionPageCondition
View source 
final class LanguageSelectionPageConditionType extends LanguageSelectionPageConditionBase implements LanguageSelectionPageConditionInterface {

  /**
   * The configuration factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

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

  /**
   * The main content renderer.
   *
   * @var \Drupal\Core\Render\MainContent\MainContentRendererInterface
   */
  protected $mainContentRenderer;

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * Constructs a LanguageSelectionPageConditionType plugin.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param \Drupal\Core\Routing\RouteMatchInterface $current_route_match
   *   The route match service.
   * @param \Drupal\Core\Render\MainContent\MainContentRendererInterface $main_content_renderer
   *   The main content renderer service.
   * @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(ConfigFactoryInterface $config_factory, RequestStack $request_stack, RouteMatchInterface $current_route_match, MainContentRendererInterface $main_content_renderer, array $configuration, $plugin_id, array $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->configFactory = $config_factory;
    $this->requestStack = $request_stack;
    $this->currentRouteMatch = $current_route_match;
    $this->mainContentRenderer = $main_content_renderer;
  }

  /**
   * {@inheritdoc}
   */
  public function alterPageContent(array &$content = [], $destination = '<front>') {

    // @todo update this using the config passed to the plugin.
    $config = $this->configFactory
      ->get('language_selection_page.negotiation');

    // Render the page if we have an array in $content instead of a
    // RedirectResponse. Otherwise, redirect the user.
    if ($config
      ->get('type') === 'standalone' && !$content instanceof RedirectResponse) {
      $content = [
        '#type' => 'page',
        '#title' => $config
          ->get('title'),
        'content' => $content,
      ];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form[$this
      ->getPluginId()] = [
      '#type' => 'select',
      '#multiple' => FALSE,
      '#default_value' => $this->configuration[$this
        ->getPluginId()],
      '#options' => [
        'standalone' => 'Standalone',
        'embedded' => 'Embedded',
        'block' => 'Block',
      ],
      '#description' => $this
        ->t('<ul>
         <li><b>Standalone - Template only</b>: Display the Language Selection Page template only.</li>
         <li><b>Embedded - Template in theme</b>: Insert the Language Selection Page body as <i>{{ content }}</i> in the page template for the current theme.</li>
         <li><b>Block - In a Drupal block</b>: Insert the Language Selection Page in a block <em>Language Selection Block</em>.</li>
       </ul>'),
    ];
    return $form;
  }

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

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

    // Do not return any language if we use Drupal's block method
    // to display the redirection.
    // Be aware that this will automatically assign the default language.
    if ($this->configuration[$this
      ->getPluginId()] === 'block') {
      return $this
        ->block();
    }
    return $this
      ->pass();
  }

  /**
   * {@inheritdoc}
   */
  public function getDestination($destination) {

    // @todo update this using the config passed to the plugin.
    $config = $this->configFactory
      ->get('language_selection_page.negotiation');
    $request = $this->requestStack
      ->getCurrentRequest();

    // If we display the LSP on a page, we must check
    // if the destination parameter is correctly set.
    if ($config
      ->get('type') !== 'block') {
      if (!empty($request
        ->getQueryString())) {
        list(, $destination) = explode('=', $request
          ->getQueryString(), 2);
        $destination = urldecode($destination);
      }
    }
    else {
      $destination = $request
        ->getPathInfo();
    }
    return $destination;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConditionPluginBase::$executableManager protected property The condition manager to proxy execute calls through.
ConditionPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ConditionPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 5
ConditionPluginBase::execute public function Executes the plugin. Overrides ExecutableInterface::execute
ConditionPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConditionPluginBase::isNegated public function Determines whether condition result will be negated. Overrides ConditionInterface::isNegated
ConditionPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConditionPluginBase::setExecutableManager public function Sets the executable manager class. Overrides ConditionInterface::setExecutableManager
ConditionPluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 9
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
ExecutablePluginBase::getConfig public function Gets all configuration values.
ExecutablePluginBase::getConfigDefinition public function Gets the definition of a configuration option.
ExecutablePluginBase::getConfigDefinitions public function Gets an array of definitions of available configuration options.
ExecutablePluginBase::setConfig public function Sets the value of a particular configuration option.
LanguageSelectionPageConditionBase::$weight protected property The condition's weight, order of execution.
LanguageSelectionPageConditionBase::alterPageResponse public function Alter the page response. Overrides LanguageSelectionPageConditionInterface::alterPageResponse
LanguageSelectionPageConditionBase::block public function Wrapper function that returns FALSE. Overrides LanguageSelectionPageConditionInterface::block
LanguageSelectionPageConditionBase::getDescription public function Returns the description of the plugin. Overrides LanguageSelectionPageConditionInterface::getDescription
LanguageSelectionPageConditionBase::getName public function Returns the name of the plugin. Overrides LanguageSelectionPageConditionInterface::getName
LanguageSelectionPageConditionBase::getWeight public function Returns the weight of the plugin. Overrides LanguageSelectionPageConditionInterface::getWeight
LanguageSelectionPageConditionBase::pass public function Wrapper function that returns FALSE. Overrides LanguageSelectionPageConditionInterface::pass
LanguageSelectionPageConditionBase::postConfigSave public function Post config save method. Overrides LanguageSelectionPageConditionInterface::postConfigSave 1
LanguageSelectionPageConditionBase::setWeight public function Set the weight of the plugin. Overrides LanguageSelectionPageConditionInterface::setWeight
LanguageSelectionPageConditionBase::submitConfigurationForm public function Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm 1
LanguageSelectionPageConditionBase::summary public function Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary
LanguageSelectionPageConditionType::$configFactory protected property The configuration factory.
LanguageSelectionPageConditionType::$currentRouteMatch protected property The route match service.
LanguageSelectionPageConditionType::$mainContentRenderer protected property The main content renderer.
LanguageSelectionPageConditionType::$requestStack protected property The request stack.
LanguageSelectionPageConditionType::alterPageContent public function Alter the $content render array used to build the LSP page. Overrides LanguageSelectionPageConditionBase::alterPageContent
LanguageSelectionPageConditionType::buildConfigurationForm public function Form constructor. Overrides ConditionPluginBase::buildConfigurationForm
LanguageSelectionPageConditionType::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LanguageSelectionPageConditionType::evaluate public function Evaluates the condition and returns TRUE or FALSE accordingly. Overrides LanguageSelectionPageConditionBase::evaluate
LanguageSelectionPageConditionType::getDestination public function Find the destination to redirect the user to after choosing the language. Overrides LanguageSelectionPageConditionBase::getDestination
LanguageSelectionPageConditionType::__construct public function Constructs a LanguageSelectionPageConditionType plugin. Overrides ConditionPluginBase::__construct
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.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2