abstract class GridStackBase in GridStack 8.2
Same name in this branch
- 8.2 src/Entity/GridStackBase.php \Drupal\gridstack\Entity\GridStackBase
- 8.2 src/Plugin/gridstack/engine/GridStackBase.php \Drupal\gridstack\Plugin\gridstack\engine\GridStackBase
Defines the base class for GridStack configuration 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\gridstack\Entity\GridStackBase implements GridStackBaseInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of GridStackBase
See also
\Drupal\gridstack\Entity\GridStack
\Drupal\outlayer\Entity\Outlayer
File
- src/
Entity/ GridStackBase.php, line 15
Namespace
Drupal\gridstack\EntityView source
abstract class GridStackBase extends ConfigEntityBase implements GridStackBaseInterface {
/**
* The legacy CTools ID for the configurable optionset.
*
* @var string
*/
protected $name;
/**
* The human-readable name for the optionset.
*
* @var string
*/
protected $label;
/**
* The administrative description.
*
* @var string
*/
protected $description = '';
/**
* The weight to re-arrange the order of gridstack optionsets.
*
* @var int
*/
protected $weight = 0;
/**
* The plugin instance json to reduce frontend logic.
*
* @var string
*/
protected $json = '';
/**
* The plugin instance options.
*
* @var array
*/
protected $options = [];
/**
* Overrides Drupal\Core\Entity\Entity::id().
*/
public function id() {
return $this->name;
}
/**
* Return description.
*/
public function description() {
return $this->description;
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return self::load('default')
->getOptions('settings');
}
/**
* {@inheritdoc}
*/
public function getOptions($group = NULL, $property = NULL) {
$default = self::load('default');
$default_options = $default ? $default->options : [];
$options = $this->options ? NestedArray::mergeDeep($default_options, $this->options) : $default_options;
if ($group) {
if (is_array($group)) {
return NestedArray::getValue($options, $group);
}
elseif (isset($property) && isset($options[$group])) {
return isset($options[$group][$property]) ? $options[$group][$property] : NULL;
}
return isset($options[$group]) ? $options[$group] : $options;
}
return $options;
}
/**
* {@inheritdoc}
*/
public function setOptions(array $options = [], $merged = TRUE) {
$this->options = $merged ? NestedArray::mergeDeep($this->options, $options) : $options;
return $this;
}
/**
* {@inheritdoc}
*/
public function getOption($group, $default = NULL) {
// Makes sure to not call ::getOptions($group), else everything is dumped.
return isset($this
->getOptions()[$group]) ? $this
->getOptions()[$group] : $default;
}
/**
* {@inheritdoc}
*/
public function setOption($group, $value) {
$value = $group == 'settings' && isset($this->options[$group]) ? array_merge($this->options[$group], $value) : $value;
$this->options[$group] = $value;
return $this;
}
/**
* {@inheritdoc}
*/
public function getJson($group = '') {
$default = self::load('default');
if ($group) {
$defaults = isset($default->json[$group]) ? $default->json[$group] : '';
return isset($this->json[$group]) ? $this->json[$group] : $defaults;
}
return $this->json;
}
/**
* {@inheritdoc}
*/
public function setJson($group, $value) {
$this->json[$group] = $value;
return $this;
}
/**
* Load the optionset with a fallback.
*/
public static function loadWithFallback($id) {
$optionset = self::load($id);
// Ensures deleted optionset while being used doesn't screw up.
return empty($optionset) ? self::load('default') : $optionset;
}
/**
* Returns the file icon URI to be stored in public directory.
*/
public function buildIconFileUri($dir = 'gridstack', $extension = 'png') {
return \file_build_uri($dir . '/' . $this
->id() . '.' . $extension);
}
/**
* Returns the file icon URI stored in public directory.
*/
public function getIconFileUri($dir = 'gridstack', $extension = 'png') {
$uri = $this
->buildIconFileUri($dir, $extension);
return is_file($uri) ? $uri : FALSE;
}
/**
* Returns a random name.
*/
public function randomize($rand = 4) {
$random = new Random();
return mb_strtolower($random
->name($rand));
}
/**
* Randomize a label from ID.
*/
public function getLabelFromId($label) {
$names = strpos($label, '__') === FALSE ? explode("_", $label) : explode("__", $label);
return implode(" ", $names);
}
/**
* Returns a randomized ID.
*/
public function getRandomizedId($rand = 4) {
$id = $this
->id();
$names = strpos($id, '__') === FALSE ? explode("_", $id) : explode("__", $id);
if (count($names) > 1) {
array_pop($names);
}
return implode("__", $names) . '__' . $this
->randomize($rand);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
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 | The UUID for this entity. | |
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 |
Saves an entity permanently. Overrides EntityBase:: |
1 |
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 |
Constructs an Entity object. Overrides EntityBase:: |
10 |
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 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. | |
GridStackBase:: |
protected | property | The administrative description. | |
GridStackBase:: |
protected | property | The plugin instance json to reduce frontend logic. | |
GridStackBase:: |
protected | property | The human-readable name for the optionset. | |
GridStackBase:: |
protected | property | The legacy CTools ID for the configurable optionset. | |
GridStackBase:: |
protected | property | The plugin instance options. | |
GridStackBase:: |
protected | property | The weight to re-arrange the order of gridstack optionsets. | |
GridStackBase:: |
public | function | Returns the file icon URI to be stored in public directory. | |
GridStackBase:: |
public static | function | 1 | |
GridStackBase:: |
public | function | Return description. | |
GridStackBase:: |
public | function | Returns the file icon URI stored in public directory. | |
GridStackBase:: |
public | function |
Returns the GridStack json suitable for HTML data-attribute. Overrides GridStackBaseInterface:: |
|
GridStackBase:: |
public | function | Randomize a label from ID. | |
GridStackBase:: |
public | function |
Returns the value of a gridstack option group. Overrides GridStackBaseInterface:: |
1 |
GridStackBase:: |
public | function |
Returns the GridStack options by group, or property. Overrides GridStackBaseInterface:: |
|
GridStackBase:: |
public | function | Returns a randomized ID. | |
GridStackBase:: |
public | function |
Overrides Drupal\Core\Entity\Entity::id(). Overrides EntityBase:: |
|
GridStackBase:: |
public static | function | Load the optionset with a fallback. | |
GridStackBase:: |
public | function | Returns a random name. | |
GridStackBase:: |
public | function | ||
GridStackBase:: |
public | function |
Sets the value of a gridstack option. Overrides GridStackBaseInterface:: |
|
GridStackBase:: |
public | function | ||
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 |