class ResponseStatus

Same name and namespace in other branches
  1. 11.x core/modules/system/src/Plugin/Condition/ResponseStatus.php \Drupal\system\Plugin\Condition\ResponseStatus

Provides a 'Response status' condition.

Hierarchy

Expanded class hierarchy of ResponseStatus

File

core/modules/system/src/Plugin/Condition/ResponseStatus.php, line 21

Namespace

Drupal\system\Plugin\Condition
View source
class ResponseStatus extends ConditionPluginBase implements ContainerFactoryPluginInterface {
  
  /**
   * The request stack.
   */
  protected RequestStack $requestStack;
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) : static {
    $instance = new static($configuration, $plugin_id, $plugin_definition);
    $instance->setRequestStack($container->get('request_stack'));
    return $instance;
  }
  public function setRequestStack(RequestStack $requestStack) : void {
    $this->requestStack = $requestStack;
  }
  
  /**
   * {@inheritdoc}
   */
  public function isNegated() : bool {
    return FALSE;
  }
  
  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() : array {
    return [
      'status_codes' => [],
    ] + parent::defaultConfiguration();
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) : array {
    $status_codes = [
      Response::HTTP_OK => $this->t('Success (@status_code)', [
        '@status_code' => Response::HTTP_OK,
      ]),
      Response::HTTP_FORBIDDEN => $this->t('Access denied (@status_code)', [
        '@status_code' => Response::HTTP_FORBIDDEN,
      ]),
      Response::HTTP_NOT_FOUND => $this->t('Page not found (@status_code)', [
        '@status_code' => Response::HTTP_NOT_FOUND,
      ]),
    ];
    $form['status_codes'] = [
      '#type' => 'checkboxes',
      '#title' => $this->t('Response status'),
      '#options' => $status_codes,
      '#default_value' => $this->configuration['status_codes'],
      '#description' => $this->t('Shows the block on pages with any matching response status. If nothing is checked, the block is shown on all pages. Other response statuses are not used.'),
    ];
    return parent::buildConfigurationForm($form, $form_state);
  }
  
  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) : void {
    $this->configuration['status_codes'] = array_keys(array_filter($form_state->getValue('status_codes')));
    parent::submitConfigurationForm($form, $form_state);
  }
  
  /**
   * {@inheritdoc}
   */
  public function summary() : PluralTranslatableMarkup {
    $allowed_codes = $this->configuration['status_codes'];
    $status_codes = [
      Response::HTTP_OK,
      Response::HTTP_FORBIDDEN,
      Response::HTTP_NOT_FOUND,
    ];
    $result = empty($allowed_codes) ? $status_codes : $allowed_codes;
    $count = count($result);
    $codes = implode(', ', $result);
    if (!empty($this->configuration['negate'])) {
      return $this->formatPlural($count, 'Request response code is not: @codes', 'Request response code is not one of the following: @codes', [
        '@codes' => $codes,
      ]);
    }
    return $this->formatPlural($count, 'Request response code is: @codes', 'Request response code is one of the following: @codes', [
      '@codes' => $codes,
    ]);
  }
  
  /**
   * {@inheritdoc}
   */
  public function evaluate() : bool {
    $allowed_codes = $this->configuration['status_codes'];
    if (empty($allowed_codes)) {
      return TRUE;
    }
    $exception = $this->requestStack
      ->getCurrentRequest()->attributes
      ->get('exception');
    if ($exception) {
      return $exception instanceof HttpExceptionInterface && in_array($exception->getStatusCode(), $allowed_codes, TRUE);
    }
    return in_array(Response::HTTP_OK, $allowed_codes, TRUE);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() : array {
    $contexts = parent::getCacheContexts();
    $contexts[] = 'url.path';
    return $contexts;
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title 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::execute public function Executes the plugin. Overrides ExecutableInterface::execute
ConditionPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
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 1
ConditionPluginBase::__construct public function 4
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.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::getCacheMaxAge public function 6
ContextAwarePluginTrait::getCacheTags public function 3
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function 1
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
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.
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
ResponseStatus::$requestStack protected property The request stack.
ResponseStatus::buildConfigurationForm public function Form constructor. Overrides ConditionPluginBase::buildConfigurationForm
ResponseStatus::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ResponseStatus::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConditionPluginBase::defaultConfiguration
ResponseStatus::evaluate public function Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate
ResponseStatus::getCacheContexts public function Overrides ContextAwarePluginTrait::getCacheContexts
ResponseStatus::isNegated public function Determines whether condition result will be negated. Overrides ConditionPluginBase::isNegated
ResponseStatus::setRequestStack public function
ResponseStatus::submitConfigurationForm public function Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm
ResponseStatus::summary public function Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.