annotate core/modules/breakpoint/src/BreakpointManagerInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\breakpoint;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Defines an interface for breakpoint managers.
Chris@0 7 */
Chris@0 8 interface BreakpointManagerInterface {
Chris@0 9
Chris@0 10 /**
Chris@0 11 * Gets breakpoints for the specified group.
Chris@0 12 *
Chris@0 13 * @param string $group
Chris@0 14 * The breakpoint group to retrieve.
Chris@0 15 *
Chris@0 16 * @return \Drupal\breakpoint\BreakpointInterface[]
Chris@0 17 * Array of breakpoint plugins keyed by machine name.
Chris@0 18 */
Chris@0 19 public function getBreakpointsByGroup($group);
Chris@0 20
Chris@0 21 /**
Chris@0 22 * Gets all the existing breakpoint groups.
Chris@0 23 *
Chris@0 24 * @return array
Chris@0 25 * Array of breakpoint group labels. Keyed by group name.
Chris@0 26 */
Chris@0 27 public function getGroups();
Chris@0 28
Chris@0 29 /**
Chris@0 30 * Gets all the providers for the specified breakpoint group.
Chris@0 31 *
Chris@0 32 * @param string $group
Chris@0 33 * The breakpoint group to retrieve.
Chris@0 34 *
Chris@0 35 * @return array
Chris@0 36 * An array keyed by provider name with values of provider type (module or
Chris@0 37 * theme).
Chris@0 38 */
Chris@0 39 public function getGroupProviders($group);
Chris@0 40
Chris@0 41 }