class CurrentThemeCondition in Zircon Profile 8

Provides a 'Current Theme' condition.

Plugin annotation

@Condition(
  id = "current_theme",
  label = @Translation("Current Theme"),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
    • class \Drupal\Core\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
      • class \Drupal\Core\Executable\ExecutablePluginBase implements ExecutableInterface
        • class \Drupal\Core\Condition\ConditionPluginBase implements ConditionInterface uses ContextAwarePluginAssignmentTrait
          • class \Drupal\system\Plugin\Condition\CurrentThemeCondition implements ContainerFactoryPluginInterface

File

core/modules/system/src/Plugin/Condition/CurrentThemeCondition.php, line 25

Contains \Drupal\system\Plugin\Condition\CurrentThemeCondition.

Namespace

Drupal\system\Plugin\Condition

class CurrentThemeCondition extends ConditionPluginBase implements ContainerFactoryPluginInterface {

  /**
   * The theme manager.
   *
   * @var \Drupal\Core\Theme\ThemeManagerInterface
   */
  protected $themeManager;

  /**
   * The theme handler.
   *
   * @var \Drupal\Core\Extension\ThemeHandlerInterface
   */
  protected $themeHandler;

  /**
   * Constructs a CurrentThemeCondition condition plugin.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Theme\ThemeManagerInterface $theme_manager
   *   The theme manager.
   * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
   *   The theme handler.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ThemeManagerInterface $theme_manager, ThemeHandlerInterface $theme_handler) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->themeManager = $theme_manager;
    $this->themeHandler = $theme_handler;
  }

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

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return array(
      'theme' => '',
    ) + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['theme'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Theme'),
      '#default_value' => $this->configuration['theme'],
      '#options' => array_map(function ($theme_info) {
        return $theme_info->info['name'];
      }, $this->themeHandler
        ->listInfo()),
    );
    return parent::buildConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['theme'] = $form_state
      ->getValue('theme');
    parent::submitConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function evaluate() {
    if (!$this->configuration['theme']) {
      return TRUE;
    }
    return $this->themeManager
      ->getActiveTheme()
      ->getName() == $this->configuration['theme'];
  }

  /**
   * {@inheritdoc}
   */
  public function summary() {
    if ($this
      ->isNegated()) {
      return $this
        ->t('The current theme is not @theme', array(
        '@theme' => $this->configuration['theme'],
      ));
    }
    return $this
      ->t('The current theme is @theme', array(
      '@theme' => $this->configuration['theme'],
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    $contexts = parent::getCacheContexts();
    $contexts[] = 'theme';
    return $contexts;
  }

}

Members

Name	Modifiers	Type	Description	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 ConfigurablePluginInterface::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 ConfigurablePluginInterface::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::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheMaxAge	public	function		7
ContextAwarePluginBase::getCacheTags	public	function		4
ContextAwarePluginBase::getContext	public	function	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
CurrentThemeCondition::$themeHandler	protected	property	The theme handler.
CurrentThemeCondition::$themeManager	protected	property	The theme manager.
CurrentThemeCondition::buildConfigurationForm	public	function	Form constructor. Overrides ConditionPluginBase::buildConfigurationForm
CurrentThemeCondition::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
CurrentThemeCondition::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConditionPluginBase::defaultConfiguration
CurrentThemeCondition::evaluate	public	function	Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate
CurrentThemeCondition::getCacheContexts	public	function	Overrides ContextAwarePluginBase::getCacheContexts
CurrentThemeCondition::submitConfigurationForm	public	function	Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm
CurrentThemeCondition::summary	public	function	Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary
CurrentThemeCondition::__construct	public	function	Constructs a CurrentThemeCondition condition plugin. Overrides ConditionPluginBase::__construct
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.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
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
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
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.	1
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	1