Same name and namespace in other branches
- 8.9.x core/modules/breakpoint/src/BreakpointManager.php \Drupal\breakpoint\BreakpointManager
- 9 core/modules/breakpoint/src/BreakpointManager.php \Drupal\breakpoint\BreakpointManager
Defines a breakpoint plugin manager to deal with breakpoints.
Extension can define breakpoints in an EXTENSION_NAME.breakpoints.yml file contained in the extension's base directory. Each breakpoint has the following structure:
MACHINE_NAME:
label: STRING
mediaQuery: STRING
weight: INTEGER
multipliers:
- STRING
For example:
olivero.lg:
label: Large
mediaQuery: 'all and (min-width: 1000px)'
weight: 2
multipliers:
- 1x
Optionally a breakpoint can provide a group key. By default an extensions breakpoints will be placed in a group labelled with the extension name.
Hierarchy
- class \Drupal\breakpoint\BreakpointManager extends \Drupal\Core\Plugin\DefaultPluginManager implements \Drupal\breakpoint\BreakpointManagerInterface uses StringTranslationTrait
Expanded class hierarchy of BreakpointManager
See also
\Drupal\breakpoint\BreakpointInterface
1 string reference to 'BreakpointManager'
- breakpoint.services.yml in core/
modules/ breakpoint/ breakpoint.services.yml - core/modules/breakpoint/breakpoint.services.yml
1 service uses BreakpointManager
- breakpoint.manager in core/
modules/ breakpoint/ breakpoint.services.yml - Drupal\breakpoint\BreakpointManager
File
- core/
modules/ breakpoint/ src/ BreakpointManager.php, line 47
Namespace
Drupal\breakpointView source
class BreakpointManager extends DefaultPluginManager implements BreakpointManagerInterface {
use StringTranslationTrait;
/**
* {@inheritdoc}
*/
protected $defaults = [
// Human readable label for breakpoint.
'label' => '',
// The media query for the breakpoint.
'mediaQuery' => '',
// Weight used for ordering breakpoints.
'weight' => 0,
// Breakpoint multipliers.
'multipliers' => [],
// The breakpoint group.
'group' => '',
// Default class for breakpoint implementations.
'class' => 'Drupal\\breakpoint\\Breakpoint',
// The plugin id. Set by the plugin system based on the top-level YAML key.
'id' => '',
];
/**
* The theme handler.
*
* @var \Drupal\Core\Extension\ThemeHandlerInterface
*/
protected $themeHandler;
/**
* Static cache of breakpoints keyed by group.
*
* @var array
*/
protected $breakpointsByGroup;
/**
* The plugin instances.
*
* @var array
*/
protected $instances = [];
/**
* Constructs a new BreakpointManager instance.
*
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
* The theme handler.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* The cache backend.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* The string translation service.
* @param \Drupal\Core\Extension\ModuleExtensionList|null $module_extension_list
* The module extension list.
*/
public function __construct(ModuleHandlerInterface $module_handler, ThemeHandlerInterface $theme_handler, CacheBackendInterface $cache_backend, TranslationInterface $string_translation, ?ModuleExtensionList $module_extension_list = NULL) {
$this->factory = new ContainerFactory($this);
$this->moduleHandler = $module_handler;
$this->themeHandler = $theme_handler;
if ($module_extension_list === NULL) {
@trigger_error('Calling ' . __METHOD__ . '() without the $module_extension_list argument is deprecated in drupal:10.3.0 and will be required in drupal:12.0.0. See https://www.drupal.org/node/3310017', E_USER_DEPRECATED);
$module_extension_list = \Drupal::service('extension.list.module');
}
$this->moduleExtensionList = $module_extension_list;
$this
->setStringTranslation($string_translation);
$this
->alterInfo('breakpoints');
$this
->setCacheBackend($cache_backend, 'breakpoints', [
'breakpoints',
]);
}
/**
* {@inheritdoc}
*/
protected function getDiscovery() {
if (!isset($this->discovery)) {
$this->discovery = new YamlDiscovery('breakpoints', $this->moduleHandler
->getModuleDirectories() + $this->themeHandler
->getThemeDirectories());
$this->discovery = new ContainerDerivativeDiscoveryDecorator($this->discovery);
}
return $this->discovery;
}
/**
* {@inheritdoc}
*/
public function processDefinition(&$definition, $plugin_id) {
parent::processDefinition($definition, $plugin_id);
// Allow custom groups and therefore more than one group per extension.
if (empty($definition['group'])) {
$definition['group'] = $definition['provider'];
}
// Ensure a 1x multiplier exists.
if (!in_array('1x', $definition['multipliers'])) {
$definition['multipliers'][] = '1x';
}
// Ensure that multipliers are sorted numerically so 1x, 1.5x and 2x
// come out in that order instead of 1.5x, 1x, 2x.
sort($definition['multipliers'], SORT_NUMERIC);
}
/**
* {@inheritdoc}
*/
protected function providerExists($provider) {
return $this->moduleHandler
->moduleExists($provider) || $this->themeHandler
->themeExists($provider);
}
/**
* {@inheritdoc}
*/
public function getBreakpointsByGroup($group) {
if (!isset($this->breakpointsByGroup[$group])) {
if ($cache = $this->cacheBackend
->get($this->cacheKey . ':' . $group)) {
$this->breakpointsByGroup[$group] = $cache->data;
}
else {
$breakpoints = [];
foreach ($this
->getDefinitions() as $plugin_id => $plugin_definition) {
if ($plugin_definition['group'] == $group) {
$breakpoints[$plugin_id] = $plugin_definition;
}
}
uasort($breakpoints, [
'Drupal\\Component\\Utility\\SortArray',
'sortByWeightElement',
]);
$this->cacheBackend
->set($this->cacheKey . ':' . $group, $breakpoints, Cache::PERMANENT, [
'breakpoints',
]);
$this->breakpointsByGroup[$group] = $breakpoints;
}
}
$instances = [];
foreach ($this->breakpointsByGroup[$group] as $plugin_id => $definition) {
if (!isset($this->instances[$plugin_id])) {
$this->instances[$plugin_id] = $this
->createInstance($plugin_id);
}
$instances[$plugin_id] = $this->instances[$plugin_id];
}
return $instances;
}
/**
* {@inheritdoc}
*/
public function getGroups() {
// Use a double colon so as to not clash with the cache for each group.
if ($cache = $this->cacheBackend
->get($this->cacheKey . '::groups')) {
$groups = $cache->data;
}
else {
$groups = [];
foreach ($this
->getDefinitions() as $plugin_definition) {
if (!isset($groups[$plugin_definition['group']])) {
$groups[$plugin_definition['group']] = $plugin_definition['group'];
}
}
$this->cacheBackend
->set($this->cacheKey . '::groups', $groups, Cache::PERMANENT, [
'breakpoints',
]);
}
// Get the labels. This is not cacheable due to translation.
$group_labels = [];
foreach ($groups as $group) {
$group_labels[$group] = $this
->getGroupLabel($group);
}
asort($group_labels);
return $group_labels;
}
/**
* {@inheritdoc}
*/
public function getGroupProviders($group) {
$providers = [];
$breakpoints = $this
->getBreakpointsByGroup($group);
foreach ($breakpoints as $breakpoint) {
$provider = $breakpoint
->getProvider();
$extension = FALSE;
if ($this->moduleHandler
->moduleExists($provider)) {
$extension = $this->moduleHandler
->getModule($provider);
}
elseif ($this->themeHandler
->themeExists($provider)) {
$extension = $this->themeHandler
->getTheme($provider);
}
if ($extension) {
$providers[$extension
->getName()] = $extension
->getType();
}
}
return $providers;
}
/**
* {@inheritdoc}
*/
public function clearCachedDefinitions() {
parent::clearCachedDefinitions();
$this->breakpointsByGroup = NULL;
$this->instances = [];
}
/**
* Gets the label for a breakpoint group.
*
* @param string $group
* The breakpoint group.
*
* @return string
* The label.
*/
protected function getGroupLabel($group) {
// Extension names are not translatable.
if ($this->moduleHandler
->moduleExists($group)) {
$label = $this->moduleExtensionList
->getName($group);
}
elseif ($this->themeHandler
->themeExists($group)) {
$label = $this->themeHandler
->getName($group);
}
else {
// Custom group label that should be translatable.
$label = $this
->t($group, [], [
'context' => 'breakpoint',
]);
}
return $label;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BreakpointManager:: |
protected | property | Static cache of breakpoints keyed by group. | |
BreakpointManager:: |
protected | property | ||
BreakpointManager:: |
protected | property | The plugin instances. | |
BreakpointManager:: |
protected | property | The theme handler. | |
BreakpointManager:: |
public | function | ||
BreakpointManager:: |
public | function | ||
BreakpointManager:: |
protected | function | ||
BreakpointManager:: |
protected | function | Gets the label for a breakpoint group. | |
BreakpointManager:: |
public | function | ||
BreakpointManager:: |
public | function | ||
BreakpointManager:: |
public | function | ||
BreakpointManager:: |
protected | function | ||
BreakpointManager:: |
public | function | Constructs a new BreakpointManager instance. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 1 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |