class HttpStatusCodeDisplayVariant in Page Manager 8.4

Same name and namespace in other branches

8 src/Plugin/DisplayVariant/HttpStatusCodeDisplayVariant.php \Drupal\page_manager\Plugin\DisplayVariant\HttpStatusCodeDisplayVariant

Provides a variant that returns a response with an HTTP status code.

Plugin annotation


@DisplayVariant(
  id = "http_status_code",
  admin_label = @Translation("HTTP status code")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Display\VariantBase implements VariantInterface uses RefinableCacheableDependencyTrait, PluginDependencyTrait
    class \Drupal\page_manager\Plugin\DisplayVariant\HttpStatusCodeDisplayVariant implements ContextAwareVariantInterface, ContainerFactoryPluginInterface

Expanded class hierarchy of HttpStatusCodeDisplayVariant

1 file declares its use of HttpStatusCodeDisplayVariant

SerializationTest.php in tests/src/Kernel/SerializationTest.php

File

src/Plugin/DisplayVariant/HttpStatusCodeDisplayVariant.php, line 23

Namespace

Drupal\page_manager\Plugin\DisplayVariant

View source

class HttpStatusCodeDisplayVariant extends VariantBase implements ContextAwareVariantInterface, ContainerFactoryPluginInterface {

  /**
   * The alias manager.
   *
   * @var \Drupal\path_alias\AliasManagerInterface
   */
  protected $aliasManager;

  /**
   * An array of collected contexts.
   *
   * This is only used on runtime, and is not stored.
   *
   * @var \Drupal\Component\Plugin\Context\ContextInterface[]
   */
  protected $contexts = [];

  /**
   * List of codes with redirect action.
   *
   * @var array
   */
  public static $redirectCodes = [
    301,
    302,
    303,
    305,
    307,
    308,
  ];

  /**
   * Gets the contexts.
   *
   * @return \Drupal\Component\Plugin\Context\ContextInterface[]
   *   An array of set contexts, keyed by context name.
   */
  public function getContexts() {
    return $this->contexts;
  }

  /**
   * Sets the contexts.
   *
   * @param \Drupal\Component\Plugin\Context\ContextInterface[] $contexts
   *   An array of contexts, keyed by context name.
   */
  public function setContexts(array $contexts) {
    $this->contexts = $contexts;
  }

  /**
   * Constructs a new HttpStatusCodeDisplayVariant.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\path_alias\AliasManagerInterface $alias_manager
   *   The alias manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, AliasManagerInterface $alias_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->aliasManager = $alias_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {

    // Get all possible status codes defined by Symfony.
    $options = Response::$statusTexts;

    // Move 403/404/500 to the top.
    $options = [
      '404' => $options['404'],
      '403' => $options['403'],
      '500' => $options['500'],
    ] + $options;

    // Add the HTTP status code, so it's easier for people to find it.
    array_walk($options, function ($title, $code) use (&$options) {
      $options[$code] = $this
        ->t('@code (@title)', [
        '@code' => $code,
        '@title' => $title,
      ]);
    });
    $form['status_code'] = [
      '#title' => $this
        ->t('HTTP status code'),
      '#type' => 'select',
      '#default_value' => $this->configuration['status_code'],
      '#options' => $options,
    ];
    $state_conditions = [];
    foreach (self::$redirectCodes as $code) {
      $state_conditions[] = [
        'value' => $code,
      ];
    }
    $form['redirect_location'] = [
      '#title' => $this
        ->t('HTTP redirect location'),
      '#type' => 'textfield',
      '#default_value' => $this->configuration['redirect_location'],
      '#states' => [
        'visible' => [
          ':input[name="variant_settings[status_code]"]' => $state_conditions,
        ],
        'required' => [
          ':input[name="variant_settings[status_code]"]' => $state_conditions,
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $configuration = parent::defaultConfiguration();
    $configuration['status_code'] = '404';
    $configuration['redirect_location'] = '';
    return $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['status_code'] = $form_state
      ->getValue('status_code');
    $this->configuration['redirect_location'] = $form_state
      ->getValue('redirect_location');
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $status_code = $this->configuration['status_code'];
    if ($status_code == 200) {
      return [];
    }
    elseif (in_array($status_code, self::$redirectCodes, TRUE)) {
      $redirect_location = $this->configuration['redirect_location'];
      $params = $this
        ->getParameterNames($redirect_location);
      $contexts = $this
        ->getContexts();
      foreach ($params as $param) {
        if (!isset($contexts[$param])) {
          continue;
        }

        /** @var \Drupal\Component\Plugin\Context\ContextInterface $context */
        $context = $contexts[$param];
        $value = $this
          ->variableToString($context
          ->getContextValue());
        if ($value === FALSE) {
          continue;
        }
        $redirect_location = str_replace('{' . $param . '}', $value, $redirect_location);
        if ($alias = $this->aliasManager
          ->getAliasByPath($redirect_location)) {
          $redirect_location = $alias;
        }
      }
      $response = new TrustedRedirectResponse($redirect_location, $status_code);
      $response
        ->send();
      exit;
    }
    else {
      throw new HttpException($status_code);
    }
  }

  /**
   * Gets the names of all parameters for this path.
   *
   * @param string $path
   *   The path to return the parameter names for.
   *
   * @return string[]
   *   An array of parameter names for the given path.
   */
  public function getParameterNames($path) {
    if (preg_match_all('|\\{(\\w+)\\}|', $path, $matches)) {
      return $matches[1];
    }
    return [];
  }

  /**
   * Convert variable to string.
   *
   * @param mixed $var
   *   The variable to convert into string.
   *
   * @return bool|string
   *   String representation for this variable.
   */
  protected function variableToString($var) {
    if (is_array($var)) {
      $result = FALSE;
    }
    elseif (!is_object($var)) {
      $result = settype($var, 'string') ? $var : FALSE;
    }
    elseif (is_object($var)) {
      if (method_exists($var, '__toString')) {
        $result = (string) $var;
      }
      elseif (method_exists($var, 'id')) {
        $result = $var
          ->id();
      }
      else {
        $result = FALSE;
      }
    }
    else {
      $result = FALSE;
    }
    return $result;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::getCacheContexts	public	function		3
CacheableDependencyTrait::getCacheMaxAge	public	function		3
CacheableDependencyTrait::getCacheTags	public	function		3
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
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
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
HttpStatusCodeDisplayVariant::$aliasManager	protected	property	The alias manager.
HttpStatusCodeDisplayVariant::$contexts	protected	property	An array of collected contexts.
HttpStatusCodeDisplayVariant::$redirectCodes	public static	property	List of codes with redirect action.
HttpStatusCodeDisplayVariant::build	public	function	Builds and returns the renderable array for the display variant. Overrides VariantInterface::build
HttpStatusCodeDisplayVariant::buildConfigurationForm	public	function	Form constructor. Overrides VariantBase::buildConfigurationForm
HttpStatusCodeDisplayVariant::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
HttpStatusCodeDisplayVariant::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides VariantBase::defaultConfiguration
HttpStatusCodeDisplayVariant::getContexts	public	function	Gets the contexts. Overrides ContextAwareVariantInterface::getContexts
HttpStatusCodeDisplayVariant::getParameterNames	public	function	Gets the names of all parameters for this path.
HttpStatusCodeDisplayVariant::setContexts	public	function	Sets the contexts. Overrides ContextAwareVariantInterface::setContexts
HttpStatusCodeDisplayVariant::submitConfigurationForm	public	function	Form submission handler. Overrides VariantBase::submitConfigurationForm
HttpStatusCodeDisplayVariant::variableToString	protected	function	Convert variable to string.
HttpStatusCodeDisplayVariant::__construct	public	function	Constructs a new HttpStatusCodeDisplayVariant. Overrides VariantBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
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
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
VariantBase::access	public	function	Determines if this display variant is accessible. Overrides VariantInterface::access
VariantBase::adminLabel	public	function	Returns the admin-facing display variant label. Overrides VariantInterface::adminLabel
VariantBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
VariantBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
VariantBase::getWeight	public	function	Returns the weight of the display variant. Overrides VariantInterface::getWeight
VariantBase::id	public	function	Returns the unique ID for the display variant. Overrides VariantInterface::id
VariantBase::label	public	function	Returns the user-facing display variant label. Overrides VariantInterface::label
VariantBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
VariantBase::setWeight	public	function	Sets the weight of the display variant. Overrides VariantInterface::setWeight
VariantBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm

You are here

class HttpStatusCodeDisplayVariant in Page Manager 8.4

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation