You are here

class LanguageSelectionPageCondition in Language Selection Page 8.2

Defines a language selection page condition annotation object.

Plugin Namespace: Plugin\LanguageSelectionPageCondition.

Hierarchy

Expanded class hierarchy of LanguageSelectionPageCondition

See also

Plugin API

11 classes are annotated with LanguageSelectionPageCondition
LanguageSelectionPageConditionBlacklistedPaths in src/Plugin/LanguageSelectionPageCondition/LanguageSelectionPageConditionBlacklistedPaths.php
Class for the Blacklisted paths condition plugin.
LanguageSelectionPageConditionIgnoreNeutral in src/Plugin/LanguageSelectionPageCondition/LanguageSelectionPageConditionIgnoreNeutral.php
Class for the Ignore Language Neutral plugin.
LanguageSelectionPageConditionIndexPhp in src/Plugin/LanguageSelectionPageCondition/LanguageSelectionPageConditionIndexPhp.php
Class for the Index.php condition plugin.
LanguageSelectionPageConditionLanguagePrefixes in src/Plugin/LanguageSelectionPageCondition/LanguageSelectionPageConditionLanguagePrefixes.php
Class for the Language Prefixes plugin.
LanguageSelectionPageConditionMethodIsValid in src/Plugin/LanguageSelectionPageCondition/LanguageSelectionPageConditionMethodIsValid.php
Class for LanguageSelectionPageConditionMethodIsValid.

... See full list

File

src/Annotation/LanguageSelectionPageCondition.php, line 18

Namespace

Drupal\language_selection_page\Annotation
View source
class LanguageSelectionPageCondition extends Condition {

  /**
   * The description of the language selection page condition plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * The language selection page condition plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the language selection page condition plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $name;

  /**
   * Whether to apply the plugin to the Language selection page block.
   *
   * - TRUE if this condition plugin should be run to determine whether to
   *   redirect to a language page, as well as whether to display the block.
   * - FALSE if this condition should be run to determine whether to redirect
   *   to a language page, but not whether to display the block.
   *
   * @var bool
   *
   * @see \Drupal\language_selection_page\Plugin\Block\LanguageSelectionPageBlock::blockAccess()
   */
  public $runInBlock;

  /**
   * The default weight of the language selection page condition plugin.
   *
   * @var int
   */
  public $weight;

}

Members

Namesort descending Modifiers Type Description Overrides
Condition::$category public property The category under which the condition should listed in the UI.
Condition::$context Deprecated public property An array of context definitions describing the context used by the plugin.
Condition::$context_definitions public property An array of context definitions describing the context used by the plugin.
Condition::$label public property The human-readable name of the condition.
Condition::$module public property The name of the module providing the type.
LanguageSelectionPageCondition::$description public property The description of the language selection page condition plugin.
LanguageSelectionPageCondition::$id public property The language selection page condition plugin ID. Overrides Condition::$id
LanguageSelectionPageCondition::$name public property The human-readable name of the language selection page condition plugin.
LanguageSelectionPageCondition::$runInBlock public property Whether to apply the plugin to the Language selection page block.
LanguageSelectionPageCondition::$weight public property The default weight of the language selection page condition plugin.
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 5
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 2