Documentation & API reference
class BreakpointGroup
Defines the BreakpointGroup entity.
Plugin annotation
@EntityType(
id = "breakpoint_group",
label = @Translation("Breakpoint group"),
module = "breakpoint",
controllers = {
"storage" = "Drupal\Core\Config\Entity\ConfigStorageController"
},
config_prefix = "breakpoint.breakpoint_group",
entity_keys = {
"id" = "id",
"label" = "label",
"uuid" = "uuid"
}
)
Hierarchy
- class \Drupal\Core\Entity\Entity implements \IteratorAggregate, EntityInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface
- class \Drupal\breakpoint\Plugin\Core\Entity\BreakpointGroup implements BreakpointGroupInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface
Expanded class hierarchy of BreakpointGroup
5 files declare their use of BreakpointGroup
- breakpoint.module in drupal/
core/ modules/ breakpoint/ breakpoint.module - Manage breakpoints and breakpoint groups for responsive designs.
- BreakpointGroupAPITest.php in drupal/
core/ modules/ breakpoint/ lib/ Drupal/ breakpoint/ Tests/ BreakpointGroupAPITest.php - Definition of Drupal\breakpoint\Tests\BreakpointGroupAPITest.
- BreakpointGroupCRUDTest.php in drupal/
core/ modules/ breakpoint/ lib/ Drupal/ breakpoint/ Tests/ BreakpointGroupCRUDTest.php - Definition of Drupal\breakpoint\Tests\BreakpointGroupCRUDTest.
- BreakpointGroupTestBase.php in drupal/
core/ modules/ breakpoint/ lib/ Drupal/ breakpoint/ Tests/ BreakpointGroupTestBase.php - Definition of Drupal\breakpoint\Tests\BreakpointGroupTestBase.
- BreakpointThemeTest.php in drupal/
core/ modules/ breakpoint/ lib/ Drupal/ breakpoint/ Tests/ BreakpointThemeTest.php - Definition of Drupal\breakpoint\Tests\BreakpointsThemeTest.
File
- drupal/
core/ modules/ breakpoint/ lib/ Drupal/ breakpoint/ Plugin/ Core/ Entity/ BreakpointGroup.php, line 35 - Definition of Drupal\breakpoint\Plugin\Core\Entity\BreakpointGroup.
Namespace
Drupal\breakpoint\Plugin\Core\EntityView source
class BreakpointGroup extends ConfigEntityBase implements BreakpointGroupInterface {
/**
* The breakpoint group ID.
*
* @var string
*/
public $id;
/**
* The breakpoint group UUID.
*
* @var string
*/
public $uuid;
/**
* The breakpoint group machine name.
*
* @var string
*/
public $name;
/**
* The breakpoint group label.
*
* @var string
*/
public $label;
/**
* The breakpoint group breakpoints.
*
* @var array
* Array containing all breakpoints of this group.
*
* @see Drupal\breakpoint\Plugin\Core\Entity\Breakpoint
*/
public $breakpoints = array();
/**
* The breakpoint group source: theme or module name. Use 'user' for
* user-created groups.
*
* @var string
*/
public $source = 'user';
/**
* The breakpoint group source type.
*
* @var string
* Allowed values:
* Breakpoint::SOURCE_TYPE_THEME
* Breakpoint::SOURCE_TYPE_MODULE
* Breakpoint::SOURCE_TYPE_USER_DEFINED
*
* @see Drupal\breakpoint\Plugin\Core\Entity\Breakpoint
*/
public $sourceType = Breakpoint::SOURCE_TYPE_USER_DEFINED;
/**
* Overrides Drupal\config\ConfigEntityBase::__construct().
*/
public function __construct(array $values, $entity_type) {
parent::__construct($values, $entity_type);
$this
->loadAllBreakpoints();
}
/**
* Overrides Drupal\Core\Entity\Entity::save().
*/
public function save() {
// Check if everything is valid.
if (!$this
->isValid()) {
throw new InvalidBreakpointException('Invalid data detected.');
}
if (empty($this->id)) {
$this->id = $this->sourceType . '.' . $this->source . '.' . $this->name;
}
// Only save the keys, but return the full objects.
$this->breakpoints = array_keys($this->breakpoints);
parent::save();
$this
->loadAllBreakpoints();
}
/**
* {@inheritdoc}
*/
public function isValid() {
// Check for illegal values in breakpoint group source type.
if (!in_array($this->sourceType, array(
Breakpoint::SOURCE_TYPE_USER_DEFINED,
Breakpoint::SOURCE_TYPE_MODULE,
Breakpoint::SOURCE_TYPE_THEME,
))) {
throw new InvalidBreakpointSourceTypeException(format_string('Invalid source type @source_type', array(
'@source_type' => $this->sourceType,
)));
}
// Check for illegal characters in breakpoint group source.
if (preg_match('/[^a-z_]+/', $this->source) || empty($this->source)) {
throw new InvalidBreakpointSourceException(format_string("Invalid value '@source' for breakpoint group source property. Breakpoint group source property can only contain lowercase letters and underscores.", array(
'@source' => $this->source,
)));
}
// Check for illegal characters in breakpoint group name.
if (preg_match('/[^a-z0-9_]+/', $this->name || empty($this->name))) {
throw new InvalidBreakpointNameException(format_string("Invalid value '@name' for breakpoint group name property. Breakpoint group name property can only contain lowercase letters, numbers and underscores.", array(
'@name' => $this->name,
)));
}
return TRUE;
}
/**
* {@inheritdoc}
*/
public function addBreakpointFromMediaQuery($name, $media_query) {
// Use the existing breakpoint if it exists.
$breakpoint = entity_load('breakpoint', $this->sourceType . '.' . $this->name . '.' . $name);
if (!$breakpoint) {
// Build a new breakpoint.
$breakpoint = entity_create('breakpoint', array(
'name' => $name,
'label' => $name,
'mediaQuery' => $media_query,
'source' => $this->name,
'sourceType' => $this->sourceType,
'weight' => count($this->breakpoints),
));
$breakpoint
->save();
}
$this->breakpoints[$breakpoint
->id()] = $breakpoint;
}
/**
* {@inheritdoc}
*/
public function addBreakpoints($breakpoints) {
foreach ($breakpoints as $breakpoint_name) {
// Check if breakpoint exists, assume $breakpoint_name is a machine name.
$breakpoint = entity_load('breakpoint', $this->sourceType . '.' . $this->source . '.' . $breakpoint_name);
// If the breakpoint doesn't exist, assume $breakpoint_name is an id.
if (!$breakpoint) {
$breakpoint = entity_load('breakpoint', $breakpoint_name);
}
// If the breakpoint doesn't exists, do not add it.
if ($breakpoint) {
// Add breakpoint to group.
$this->breakpoints[$breakpoint
->id()] = $breakpoint;
}
}
}
/**
* Loads all breakpoints, remove non-existing ones.
*
* @return array
* Array containing breakpoints keyed by their id.
*/
protected function loadAllBreakpoints() {
$breakpoints = $this->breakpoints;
$this->breakpoints = array();
foreach ($breakpoints as $breakpoint_id) {
$breakpoint = breakpoint_load($breakpoint_id);
if ($breakpoint) {
$this->breakpoints[$breakpoint_id] = $breakpoint;
}
}
}
}