You are here

class SessionCondition in Access Filter 8

Filter condition using session value.

Plugin annotation


@AccessFilterCondition(
  id = "session",
  description = @Translation("Session value."),
  examples = {
    "- { type: session, key: foo, value: bar }",
    "- { type: session, key: foo, value: '/[a-z]+/', regex: 1 }"
  }
)

Hierarchy

Expanded class hierarchy of SessionCondition

File

src/Plugin/AccessFilter/Condition/SessionCondition.php, line 19

Namespace

Drupal\access_filter\Plugin\AccessFilter\Condition
View source
class SessionCondition extends ArrayConditionBase {

  /**
   * {@inheritdoc}
   */
  public function isMatched(Request $request) {
    $session = $request
      ->getSession();
    if ($session) {
      return $this
        ->isMatchedWithArray($session
        ->all());
    }
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ArrayConditionBase::isMatchedWithArray protected function Checks matching using specific array.
ArrayConditionBase::summary public function Gets summary text for the condition. Overrides ConditionInterface::summary
ArrayConditionBase::validateConfiguration public function Validates configuration data. Overrides ConditionInterface::validateConfiguration
ConditionBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 2
ConditionBase::isNegated public function Determines whether condition result will be negated. Overrides ConditionInterface::isNegated
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
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
SessionCondition::isMatched public function Checks the current access is matched to the condition. Overrides ConditionInterface::isMatched
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.