class CurrentThemeCondition

Same name in other branches
  1. 9 core/modules/system/src/Plugin/Condition/CurrentThemeCondition.php \Drupal\system\Plugin\Condition\CurrentThemeCondition
  2. 8.9.x core/modules/system/src/Plugin/Condition/CurrentThemeCondition.php \Drupal\system\Plugin\Condition\CurrentThemeCondition
  3. 10 core/modules/system/src/Plugin/Condition/CurrentThemeCondition.php \Drupal\system\Plugin\Condition\CurrentThemeCondition

Provides a 'Current Theme' condition.

Hierarchy

Expanded class hierarchy of CurrentThemeCondition

File

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

Namespace

Drupal\system\Plugin\Condition
View source
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 [
            'theme' => '',
        ] + parent::defaultConfiguration();
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
        $form['theme'] = [
            '#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', [
                '@theme' => $this->configuration['theme'],
            ]);
        }
        return $this->t('The current theme is @theme', [
            '@theme' => $this->configuration['theme'],
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() {
        $contexts = parent::getCacheContexts();
        $contexts[] = 'theme';
        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::isNegated public function Determines whether condition result will be negated. Overrides ConditionInterface::isNegated 1
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
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
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 ContextAwarePluginTrait::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
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.
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.