class BreakpointGroup in Breakpoints 8
Defines the BreakpointGroup entity.
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\breakpoint\BreakpointGroup
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of BreakpointGroup
5 files declare their use of BreakpointGroup
- breakpoint.module in ./
breakpoint.module - Manage breakpoints and breakpoint groups for responsive designs.
- BreakpointGroupAPITest.php in lib/
Drupal/ breakpoint/ Tests/ BreakpointGroupAPITest.php - Definition of Drupal\breakpoint\Tests\BreakpointGroupAPITest.
- BreakpointGroupCrudTest.php in lib/
Drupal/ breakpoint/ Tests/ BreakpointGroupCrudTest.php - Definition of Drupal\breakpoint\Tests\BreakpointGroupCrudTest.
- BreakpointGroupTestBase.php in lib/
Drupal/ breakpoint/ Tests/ BreakpointGroupTestBase.php - Definition of Drupal\breakpoint\Tests\BreakpointGroupTestBase.
- BreakpointThemeTest.php in lib/
Drupal/ breakpoint/ Tests/ BreakpointThemeTest.php - Definition of Drupal\breakpoint\Tests\BreakpointsThemeTest.
File
- lib/
Drupal/ breakpoint/ BreakpointGroup.php, line 17 - Definition of Drupal\breakpoint\BreakpointGroup.
Namespace
Drupal\breakpointView source
class BreakpointGroup extends ConfigEntityBase {
/**
* The breakpoint group ID.
*
* @var string
*/
public $id;
/**
* The breakpoint group UUID.
*
* @var string
*/
public $uuid;
/**
* The breakpoint group label.
*
* @var string
*/
public $label;
/**
* The breakpoint group breakpoints.
*
* @var array
* Array containing all breakpoints of this group.
*
* @see Drupal\breakpoints\Breakpoint
*/
public $breakpoints = array();
/**
* The breakpoint group source: theme or module name.
*
* @var string
*/
public $source = '';
/**
* The breakpoint group source type.
*
* @var string
* Allowed values:
* Breakpoint::SOURCE_TYPE_THEME
* Breakpoint::SOURCE_TYPE_MODULE
* Breakpoint::SOURCE_TYPE_CUSTOM
*
* @see Drupal\breakpoint\Breakpoint
*/
public $sourceType = Breakpoint::SOURCE_TYPE_CUSTOM;
/**
* The breakpoint group overridden status.
*
* @var boolean
*/
public $overridden = FALSE;
/**
* Overrides Drupal\config\ConfigEntityBase::__construct().
*/
public function __construct(array $values = array(), $entity_type = 'breakpoint_group') {
parent::__construct($values, $entity_type);
$this
->loadAllBreakpoints();
}
/**
* Overrides Drupal\Core\Entity::save().
*/
public function save() {
// Check if everything is valid.
if (!$this
->isValid()) {
throw new Exception('Invalid data detected.');
}
// Only save the keys, but return the full objects.
$this->breakpoints = array_keys($this->breakpoints);
parent::save();
$this
->loadAllBreakpoints();
}
/**
* Check if the breakpoint group is valid.
*
* @throws Drupal\breakpoint\InvalidBreakpointSourceTypeException
* @throws Drupal\breakpoint\InvalidBreakpointSourceException
*
* @return true
*/
public function isValid() {
// Check for illegal values in breakpoint group source type.
if (!in_array($this->sourceType, array(
Breakpoint::SOURCE_TYPE_CUSTOM,
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 source.
if (preg_match('/[^a-z_]+/', $this->source)) {
throw new InvalidBreakpointSourceException(format_string("Invalid value '@source' for breakpoint source property. Breakpoint source property can only contain lowercase letters and underscores.", array(
'@source' => $this->source,
)));
}
return TRUE;
}
/**
* Override a breakpoint group.
*
* @return Drupal\breakpoint\BreakpointGroup
*/
public function override() {
// Custom breakpoint group can't be overridden.
if ($this->overridden || $this->sourceType === Breakpoint::SOURCE_TYPE_CUSTOM) {
return FALSE;
}
// Mark all breakpoints as overridden.
foreach ($this->breakpoints as $key => $breakpoint) {
if ($breakpoint->sourceType === $this->sourceType && $breakpoint->source == $this
->id()) {
$breakpoint
->override();
}
}
// Mark breakpoint group as overridden.
$this->overridden = TRUE;
$this
->save();
return $this;
}
/**
* Revert a breakpoint group after it has been overridden.
*
* @return Drupal\breakpoint\BreakpointGroup
*/
public function revert() {
if (!$this->overridden || $this->sourceType === Breakpoint::SOURCE_TYPE_CUSTOM) {
return FALSE;
}
// Reload all breakpoints from theme or module.
switch ($this->sourceType) {
case Breakpoint::SOURCE_TYPE_THEME:
$reloaded_group = breakpoint_group_reload_from_theme($this
->id());
if ($reloaded_group) {
$this->breakpoints = $reloaded_group->breakpoints;
$this->overridden = FALSE;
$this
->save();
}
break;
case Breakpoint::SOURCE_TYPE_MODULE:
$reloaded_group = breakpoint_group_reload_from_module($this->source, $this
->id());
if ($reloaded_group) {
$this->breakpoints = $reloaded_group->breakpoints;
$this->overridden = FALSE;
$this
->save();
}
else {
throw new \Exception("something went wrong :s");
}
break;
}
return $this;
}
/**
* Duplicate a breakpoint group.
*
* The new breakpoint group inherits the breakpoints.
*
* @return Drupal\breakpoint\BreakpointGroup
*/
public function duplicate() {
return entity_create('breakpoint_group', array(
'breakpoints' => $this->breakpoints,
));
}
/**
* Is the breakpoint group editable.
*/
public function isEditable() {
// Custom breakpoint groups are always editable.
if ($this->sourceType == Breakpoint::SOURCE_TYPE_CUSTOM) {
return TRUE;
}
// Overridden breakpoints groups are editable.
if ($this->overridden) {
return TRUE;
}
return FALSE;
}
/**
* Add a breakpoint using a name and a media query.
*
* @param string $name
* The name of the breakpoint.
* @param string $media_query
* Media query.
*/
public function addBreakpointFromMediaQuery($name, $media_query) {
// Use the existing breakpoint if it exists.
$breakpoint = entity_load('breakpoint', $this->sourceType . '.' . $this->id . '.' . $name);
if (!$breakpoint) {
// Build a new breakpoint.
$breakpoint = entity_create('breakpoint', array(
'name' => $name,
'label' => drupal_ucfirst($name),
'mediaQuery' => $media_query,
'source' => $this->id,
'sourceType' => $this->sourceType,
'weight' => count($this->breakpoints),
));
$breakpoint
->save();
}
else {
// Reset name, label, weight, overridden and media query.
$breakpoint->name = $name;
$breakpoint->label = drupal_ucfirst($name);
$breakpoint->mediaQuery = $media_query;
$breakpoint->originalMediaQuery = '';
$breakpoint->overridden = FALSE;
$breakpoint->weight = count($this->breakpoints);
$breakpoint
->save();
}
$this->breakpoints[$breakpoint
->id()] = $breakpoint;
}
/**
* Load breakpoints from a theme/module and build a default group.
*
* @param string $id
* Identifier of the breakpoint group.
* @param string $label
* Human readable name of the breakpoint group.
* @param string $sourceType
* Either Breakpoint::SOURCE_TYPE_THEME or Breakpoint::SOURCE_TYPE_MODULE.
* @param array $media_queries
* Array of media queries keyed by id.
*
* @return \Drupal\breakpoint\BreakpointGroup|false
* Return the new breakpoint group containing all breakpoints.
*/
public static function ImportMediaQueries($id, $label, $source_type, $media_queries) {
$breakpoint_group = entity_load('breakpoint_group', $source_type . '.' . $id);
if (!$breakpoint_group) {
// Build a new breakpoint group.
$breakpoint_group = entity_create('breakpoint_group', array(
'id' => $id,
'label' => $label,
'source' => $id,
'sourceType' => $source_type,
));
}
else {
// Reset label.
$breakpoint_group->label = $label;
}
foreach ($media_queries as $name => $media_query) {
$breakpoint_group
->addBreakpointFromMediaQuery($name, $media_query);
}
return $breakpoint_group;
}
/**
* Import breakpoint groups from theme or module.
*
* @param string $source
* Source of the breakpoint group: theme_key or module name.
* @param string $sourceType
* Either Breakpoint::SOURCE_TYPE_THEME or Breakpoint::SOURCE_TYPE_MODULE.
* @param string $id
* Identifier of the breakpoint group.
* @param string $label
* Human readable name of the breakpoint group.
* @param array $breakpoints
* Array of breakpoints, using either the short name or the full name.
*
* @return \Drupal\breakpoint\BreakpointGroup|false
* Return the new breakpoint group containing all breakpoints.
*/
public static function ImportBreakpointGroup($source, $source_type, $id, $label, $breakpoints) {
// Use the existing breakpoint group if it exists.
$breakpoint_group = entity_load('breakpoint_group', $source_type . '.' . $id);
if (!$breakpoint_group) {
$breakpoint_group = entity_create('breakpoint_group', array(
'id' => $id,
'label' => !empty($label) ? $label : $id,
'source' => $source,
'sourceType' => $source_type,
));
}
else {
// Reset label.
$breakpoint_group->label = !empty($label) ? $label : $id;
}
// Add breakpoints to the group.
foreach ($breakpoints as $breakpoint_name) {
// Check if breakpoint exists, assume short name.
$breakpoint = entity_load('breakpoint', $source_type . '.' . $source . '.' . $breakpoint_name);
// If the breakpoint doesn't exist, try using the full name.
if (!$breakpoint) {
$breakpoint = entity_load('breakpoint', $breakpoint_name);
}
if ($breakpoint) {
// Add breakpoint to group.
$breakpoint_group->breakpoints[$breakpoint
->id()] = $breakpoint;
}
}
return $breakpoint_group;
}
/**
* Load 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;
}
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BreakpointGroup:: |
public | property | The breakpoint group breakpoints. | |
BreakpointGroup:: |
public | property | The breakpoint group ID. | |
BreakpointGroup:: |
public | property | The breakpoint group label. | |
BreakpointGroup:: |
public | property | The breakpoint group overridden status. | |
BreakpointGroup:: |
public | property | The breakpoint group source: theme or module name. | |
BreakpointGroup:: |
public | property | The breakpoint group source type. | |
BreakpointGroup:: |
public | property |
The breakpoint group UUID. Overrides ConfigEntityBase:: |
|
BreakpointGroup:: |
public | function | Add a breakpoint using a name and a media query. | |
BreakpointGroup:: |
public | function | Duplicate a breakpoint group. | |
BreakpointGroup:: |
public static | function | Import breakpoint groups from theme or module. | |
BreakpointGroup:: |
public static | function | Load breakpoints from a theme/module and build a default group. | |
BreakpointGroup:: |
public | function | Is the breakpoint group editable. | |
BreakpointGroup:: |
public | function | Check if the breakpoint group is valid. | |
BreakpointGroup:: |
protected | function | Load all breakpoints, remove non-existing ones. | |
BreakpointGroup:: |
public | function | Override a breakpoint group. | |
BreakpointGroup:: |
public | function | Revert a breakpoint group after it has been overridden. | |
BreakpointGroup:: |
public | function |
Overrides Drupal\Core\Entity::save(). Overrides ConfigEntityBase:: |
|
BreakpointGroup:: |
public | function |
Overrides Drupal\config\ConfigEntityBase::__construct(). Overrides ConfigEntityBase:: |
|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | Information maintained by Drupal core about configuration. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface:: |
13 |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
7 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides EntityBase:: |
13 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface:: |
16 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface:: |
14 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function |