BreakpointManagerInterface.php 999 Bytes
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
<?php

/**
 * @file
 * Contains \Drupal\breakpoint\BreakpointManagerInterface.
 */

namespace Drupal\breakpoint;

/**
 * Defines an interface for breakpoint managers.
 */
interface BreakpointManagerInterface {

  /**
   * Gets breakpoints for the specified group.
   *
   * @param string $group
   *   The breakpoint group to retrieve.
   *
   * @return \Drupal\breakpoint\BreakpointInterface[]
   *   Array of breakpoint plugins keyed by machine name.
   */
  public function getBreakpointsByGroup($group);

  /**
   * Gets all the existing breakpoint groups.
   *
   * @return array
   *   Array of breakpoint group labels. Keyed by group name.
   */
  public function getGroups();

  /**
   * Gets all the providers for the specified breakpoint group.
   *
   * @param string $group
   *   The breakpoint group to retrieve.
   *
   * @return array
   *   An array keyed by provider name with values of provider type (module or
   *   theme).
   */
  public function getGroupProviders($group);

}