class AdminRoutes in Administration Language Negotiation 8

Class for the Blacklisted paths condition plugin.

Plugin annotation


@AdministrationLanguageNegotiationCondition(
  id = "admin_routes",
  weight = -50,
  name = @Translation("Admin Routes"),
  description = @Translation("Returns particular language on admin routes.")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Executable\ExecutablePluginBase implements ExecutableInterface
    class \Drupal\Core\Condition\ConditionPluginBase implements ConditionInterface uses ContextAwarePluginAssignmentTrait
    class \Drupal\administration_language_negotiation\AdministrationLanguageNegotiationConditionBase implements AdministrationLanguageNegotiationConditionInterface, ContainerFactoryPluginInterface
    class \Drupal\administration_language_negotiation\Plugin\AdministrationLanguageNegotiationCondition\AdminRoutes implements AdministrationLanguageNegotiationConditionInterface

Expanded class hierarchy of AdminRoutes

File

src/Plugin/AdministrationLanguageNegotiationCondition/AdminRoutes.php, line 28

Namespace

Drupal\administration_language_negotiation\Plugin\AdministrationLanguageNegotiationCondition

View source

class AdminRoutes extends AdministrationLanguageNegotiationConditionBase implements AdministrationLanguageNegotiationConditionInterface {

  /**
   * The admin context.
   *
   * @var \Drupal\Core\Routing\AdminContext
   */
  protected $adminContext;

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

  /**
   * The router manager.
   *
   * @var \Drupal\Core\Routing\Router
   */
  protected $router;

  /**
   * AdminRoutes constructor.
   *
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param \Drupal\Core\Routing\Router $router
   *   The router.
   * @param \Drupal\Core\Routing\AdminContext $admin_context
   *   The admin context.
   * @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(RequestStack $request_stack, Router $router, AdminContext $admin_context, array $configuration, $plugin_id, array $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->requestStack = $request_stack;
    $this->router = $router;
    $this->adminContext = $admin_context;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form[$this
      ->getPluginId()] = [
      '#title' => $this
        ->t('Enable'),
      '#type' => 'checkbox',
      '#default_value' => $this->configuration[$this
        ->getPluginId()],
      '#description' => $this
        ->t('Detects if the current path is admin route.'),
    ];
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function evaluate() {
    $active = $this->configuration[$this
      ->getPluginId()];
    return $active && $this
      ->isAdminRoute() ? $this
      ->block() : $this
      ->pass();
  }

  /**
   * Checks if the current request is admin route.
   *
   * @return bool
   *   TRUE if the current request is admin route.
   */
  public function isAdminRoute() {

    // If called from an event subscriber, the request may not have
    // the route object yet (it is still being built).
    try {
      $match = $this->router
        ->matchRequest($this->requestStack
        ->getCurrentRequest());
    } catch (ResourceNotFoundException $e) {
      return FALSE;
    } catch (AccessDeniedHttpException $e) {
      return FALSE;
    }
    if ($match && isset($match[RouteObjectInterface::ROUTE_OBJECT])) {
      return $this->adminContext
        ->isAdminRoute($match[RouteObjectInterface::ROUTE_OBJECT]);
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AdministrationLanguageNegotiationConditionBase::$weight	protected	property	The condition's weight, order of execution.
AdministrationLanguageNegotiationConditionBase::block	public	function	Wrapper function that returns FALSE. Overrides AdministrationLanguageNegotiationConditionInterface::block
AdministrationLanguageNegotiationConditionBase::getDescription	public	function	Returns the description of the plugin. Overrides AdministrationLanguageNegotiationConditionInterface::getDescription
AdministrationLanguageNegotiationConditionBase::getName	public	function	Returns the name of the plugin. Overrides AdministrationLanguageNegotiationConditionInterface::getName
AdministrationLanguageNegotiationConditionBase::getWeight	public	function	Returns the weight of the plugin. Overrides AdministrationLanguageNegotiationConditionInterface::getWeight
AdministrationLanguageNegotiationConditionBase::pass	public	function	Wrapper function that returns FALSE. Overrides AdministrationLanguageNegotiationConditionInterface::pass
AdministrationLanguageNegotiationConditionBase::postConfigSave	public	function	Post config save method. Overrides AdministrationLanguageNegotiationConditionInterface::postConfigSave
AdministrationLanguageNegotiationConditionBase::setWeight	public	function	Set the weight of the plugin. Overrides AdministrationLanguageNegotiationConditionInterface::setWeight
AdministrationLanguageNegotiationConditionBase::submitConfigurationForm	public	function	Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm
AdministrationLanguageNegotiationConditionBase::summary	public	function	Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary
AdminRoutes::$adminContext	protected	property	The admin context.
AdminRoutes::$requestStack	protected	property	The request stack.
AdminRoutes::$router	protected	property	The router manager.
AdminRoutes::buildConfigurationForm	public	function	Form constructor. Overrides ConditionPluginBase::buildConfigurationForm
AdminRoutes::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
AdminRoutes::evaluate	public	function	Evaluates the condition and returns TRUE or FALSE accordingly. Overrides AdministrationLanguageNegotiationConditionBase::evaluate
AdminRoutes::isAdminRoute	public	function	Checks if the current request is admin route.
AdminRoutes::__construct	public	function	AdminRoutes constructor. Overrides ConditionPluginBase::__construct
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.
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

You are here

class AdminRoutes in Administration Language Negotiation 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation