Commit 3b1cb04b authored by Dries's avatar Dries

Issue #2288783 by tim.plunkett: Add a current theme condition.

parent 5cd540a5
......@@ -108,6 +108,8 @@ protected function baseConfigurationDefaults() {
$visibility = array_map(function ($definition) {
return array('id' => $definition['id']);
}, $this->conditionPluginManager()->getDefinitions());
unset($visibility['current_theme']);
return array(
'id' => $this->getPluginId(),
'label' => '',
......
<?php
/**
* @file
* Contains \Drupal\system\Plugin\Condition\CurrentThemeCondition.
*/
namespace Drupal\system\Plugin\Condition;
use Drupal\Core\Condition\ConditionPluginBase;
use Drupal\Core\Extension\ThemeHandlerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Theme\ThemeNegotiatorInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Provides a 'Current Theme' condition.
*
* @Condition(
* id = "current_theme",
* label = @Translation("Current Theme"),
* )
*/
class CurrentThemeCondition extends ConditionPluginBase implements ContainerFactoryPluginInterface {
/**
* The theme negotiator.
*
* @var \Drupal\Core\Theme\ThemeNegotiatorInterface
*/
protected $themeNegotiator;
/**
* The theme handler.
*
* @var \Drupal\Core\Extension\ThemeHandlerInterface
*/
protected $themeHandler;
/**
* The current route match.
*
* @var \Drupal\Core\Routing\RouteMatchInterface
*/
protected $routeMatch;
/**
* 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\ThemeNegotiatorInterface $theme_negotiator
* The theme negotiator.
* @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
* The theme handler.
* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
* The current route match.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, ThemeNegotiatorInterface $theme_negotiator, ThemeHandlerInterface $theme_handler, RouteMatchInterface $route_match) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->themeNegotiator = $theme_negotiator;
$this->themeHandler = $theme_handler;
$this->routeMatch = $route_match;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static(
$configuration,
$plugin_id,
$plugin_definition,
$container->get('theme.negotiator'),
$container->get('theme_handler'),
$container->get('current_route_match')
);
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return array('theme' => '') + parent::defaultConfiguration();
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, array &$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, array &$form_state) {
$this->configuration['theme'] = $form_state['values']['theme'];
parent::submitConfigurationForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function evaluate() {
if (!$this->configuration['theme']) {
return TRUE;
}
return $this->themeNegotiator->determineActiveTheme($this->routeMatch) == $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']));
}
}
<?php
/**
* @file
* Contains \Drupal\system\Tests\Condition\CurrentThemeConditionTest.
*/
namespace Drupal\system\Tests\Condition;
use Drupal\Component\Utility\String;
use Drupal\simpletest\KernelTestBase;
/**
* Tests the CurrentThemeCondition plugin.
*/
class CurrentThemeConditionTest extends KernelTestBase {
/**
* {@inheritdoc}
*/
public static $modules = array('system', 'theme_test');
/**
* {@inheritdoc}
*/
public static function getInfo() {
return array(
'name' => 'Current Theme Condition Plugin',
'description' => 'Tests the CurrentThemeCondition plugin',
'group' => 'Condition API',
);
}
/**
* Tests the current theme condition.
*/
public function testCurrentTheme() {
\Drupal::service('theme_handler')->enable(array('test_theme'));
$manager = \Drupal::service('plugin.manager.condition');
/** @var $condition \Drupal\Core\Condition\ConditionInterface */
$condition = $manager->createInstance('current_theme');
$condition->setConfiguration(array('theme' => 'test_theme'));
/** @var $condition_negated \Drupal\Core\Condition\ConditionInterface */
$condition_negated = $manager->createInstance('current_theme');
$condition_negated->setConfiguration(array('theme' => 'test_theme', 'negate' => TRUE));
$this->assertEqual($condition->summary(), String::format('The current theme is @theme', array('@theme' => 'test_theme')));
$this->assertEqual($condition_negated->summary(), String::format('The current theme is not @theme', array('@theme' => 'test_theme')));
// The expected theme has not been set up yet.
$this->assertFalse($condition->execute());
$this->assertTrue($condition_negated->execute());
// Set the expected theme to be used.
\Drupal::config('system.theme')->set('default', 'test_theme')->save();
$this->assertTrue($condition->execute());
$this->assertFalse($condition_negated->execute());
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment