class ResponseStatus
Provides a 'Response status' condition.
Attributes
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Executable\ExecutablePluginBase implements \Drupal\Core\Executable\ExecutableInterface, \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Condition\ConditionPluginBase implements \Drupal\Core\Condition\ConditionInterface uses \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait extends \Drupal\Core\Executable\ExecutablePluginBase
- class \Drupal\system\Plugin\Condition\ResponseStatus implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Condition\ConditionPluginBase
 
 
 - class \Drupal\Core\Condition\ConditionPluginBase implements \Drupal\Core\Condition\ConditionInterface uses \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait extends \Drupal\Core\Executable\ExecutablePluginBase
 
 - class \Drupal\Core\Executable\ExecutablePluginBase implements \Drupal\Core\Executable\ExecutableInterface, \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait extends \Drupal\Core\Plugin\PluginBase
 
 - class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
 
Expanded class hierarchy of ResponseStatus
File
- 
              core/
modules/ system/ src/ Plugin/ Condition/ ResponseStatus.php, line 21  
Namespace
Drupal\system\Plugin\ConditionView 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 | Constructs a \Drupal\Component\Plugin\PluginBase object. | Overrides PluginBase::__construct | 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 | |||
| 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 | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 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. | ||
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | |
| 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::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
| PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
| 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 | |
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
| 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 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.