class GridStackVariant in GridStack 8.2

Defines the GridStack variant configuration entity.

Plugin annotation


@ConfigEntityType(
  id = "gridstack_variant",
  label = @Translation("GridStack variant"),
  config_prefix = "variant",
  list_path = "admin/structure/gridstack/variant",
  entity_keys = {
    "id" = "name",
    "label" = "label",
    "status" = "status",
    "weight" = "weight",
    "source" = "source",
  },
  config_export = {
    "id",
    "name",
    "label",
    "description",
    "status",
    "weight",
    "source",
    "options",
  }
)

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\gridstack\Entity\GridStack implements GridStackInterface
    class \Drupal\gridstack\Entity\GridStackVariant implements GridStackVariantInterface

Expanded class hierarchy of GridStackVariant

6 files declare their use of GridStackVariant

Builder.php in src/Plugin/gridstack/stylizer/Builder.php
Form.php in src/Plugin/gridstack/stylizer/Form.php
GridStackVariantForm.php in modules/gridstack_ui/src/Form/GridStackVariantForm.php
GridStackVariantFormController.php in modules/gridstack_ui/src/Controller/GridStackVariantFormController.php
GridStackVariantSelectionForm.php in modules/gridstack_ui/src/Form/GridStackVariantSelectionForm.php

... See full list

File

src/Entity/GridStackVariant.php, line 34

Namespace

Drupal\gridstack\Entity

View source

class GridStackVariant extends GridStack implements GridStackVariantInterface {

  /**
   * The variant source.
   *
   * @var string
   */
  protected $source;

  /**
   * {@inheritdoc}
   */
  public static function load($id = '') {
    return $id == 'default' ? GridStack::load('default') : parent::load($id);
  }

  /**
   * Returns the variant source aka original GridStack layout.
   */
  public function source() {
    return $this->source;
  }

  /**
   * Sets the variant source aka original GridStack layout.
   */
  public function setSource($source) {
    $this->source = $source;
    return $this;
  }

  /**
   * Returns the source GridStack optionset.
   */
  public function getOptionset($default = 'default', $custom = FALSE) {
    $source = $this->source ? $this->source : $default;
    return GridStack::loadWithFallback($custom ? $default : $source);
  }

  /**
   * {@inheritdoc}
   */
  public function getOption($group, $default = NULL) {

    // @todo refine few more which should point to source as needed.
    if ($gridstack = $this
      ->getOptionset()) {
      if ($group == 'use_framework') {
        return $gridstack
          ->getOption($group, $default);
      }
    }
    return parent::getOption($group, $default);
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $default = $this
      ->getOptionset('default', TRUE);
    return $default ? $default
      ->getOptions('settings') : [];
  }

  /**
   * {@inheritdoc}
   */
  public function createDuplicateVariant($id, $label, array $options = []) {
    $duplicate = $this
      ->createDuplicate();
    $duplicate
      ->set('id', $id);
    $duplicate
      ->set('name', $id);
    $duplicate
      ->set('label', $label);
    $duplicate
      ->set('options', $options);
    return $duplicate;
  }

  /**
   * {@inheritdoc}
   */
  public function toUrl($rel = 'edit-form', array $options = []) {
    $uri = NULL;
    $parameters = [];
    if ($rel === 'add-form' || $rel === 'duplicate-form') {
      $parameters['gridstack'] = $this
        ->getOptionset()
        ->id();
      if ($rel === 'add-form') {
        $uri = new Url("entity.gridstack_variant.add_form", $parameters);
      }
      else {
        $uri = new Url("entity.gridstack_variant.duplicate_form", $parameters);
      }
    }
    if ($rel === 'edit-form' || $rel === 'delete-form') {
      $parameters['gridstack'] = $this
        ->getOptionset()
        ->id();
      $parameters['gridstack_variant'] = $this
        ->id();
      if ($rel === 'edit-form') {
        $uri = new Url("entity.gridstack_variant.edit_form", $parameters);
      }
      else {
        $uri = new Url("entity.gridstack_variant.delete_form", $parameters);
      }
    }
    if ($uri) {
      $options += [
        'language' => NULL,
        'entity_type' => 'gridstack_variant',
        'entity' => $this,
      ];
      $uri
        ->setOptions($options);
      return $uri;
    }
    return parent::toUrl($rel, $options);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling	private	property	Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode	protected	property	The language code of the entity's default language.
ConfigEntityBase::$originalId	protected	property	The original ID of the configuration entity.
ConfigEntityBase::$status	protected	property	The enabled/disabled status of the configuration entity.	4
ConfigEntityBase::$third_party_settings	protected	property	Third party entity settings.
ConfigEntityBase::$trustedData	protected	property	Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid	protected	property	The UUID for this entity.
ConfigEntityBase::$_core	protected	property	Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies	13
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityBase::createDuplicate	1
ConfigEntityBase::disable	public	function	Disables the configuration entity. Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable	public	function	Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate	1
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig	protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData	public	function	Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete	protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable	public	function	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	7
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete	8
ConfigEntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave	13
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides EntityBase::save	1
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling	public	function
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.	6
ConfigEntityBase::status	public	function	Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status	4
ConfigEntityBase::toArray	public	function	Gets an array of all property values. Overrides EntityBase::toArray	2
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url	public	function	Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct	10
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	4
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId	protected	property	The entity type.
EntityBase::$typedData	protected	property	A typed data object wrapping this entity.
EntityBase::access	public	function	Checks data value access. Overrides AccessibleInterface::access	1
EntityBase::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle	1
EntityBase::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated	protected	function	Gets the entity manager.
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::label	public	function	Gets the label of the entity. Overrides EntityInterface::label	6
EntityBase::language	public	function	Gets the language of the entity. Overrides EntityInterface::language	1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::linkTemplates	protected	function	Gets an array link templates.	1
EntityBase::loadMultiple	public static	function	Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate	4
EntityBase::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	16
EntityBase::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave	14
EntityBase::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	5
EntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities	1
EntityBase::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	2
EntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid	1
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
GridStack::$activeBreakpoints	private static	property	The supported $breakpoints.
GridStack::$breakpoints	protected	property	The converted $breakpoints.
GridStack::$data	protected	property	The $data suitable for attributes.
GridStack::$fileSystem	private	property	The file system service.
GridStack::breakpointsToArray	public	function	Converts the entire breakpoint items from stored JSON into array.
GridStack::breakpointToArray	protected	function	Converts breakpoint items from stored JSON into array.
GridStack::delete	public	function	Deletes an entity permanently. Overrides EntityBase::delete
GridStack::getBreakpointItem	public	function	Returns options.breakpoints.sm.[width, column, grids, nested].
GridStack::getBreakpointItems	public	function	Returns options.breakpoints.sm.[width, column, grids, nested].
GridStack::getBreakpoints	public	function	Returns options.breakpoints.[xs\|sm\|md\|lg\|xl], or all, else empty. Overrides GridStackInterface::getBreakpoints
GridStack::getColumns	public	function	Returns the available breakpoint columns.
GridStack::getConstantBreakpoints	public static	function	Returns the supported breakpoints.
GridStack::getData	public	function	Returns GridStack data as string for container attributes.
GridStack::getFileSystem	private	function	Gets the file system service.
GridStack::getGridPropertyByDelta	public	function	Returns property by its key and delta.
GridStack::getGridsByDelta	public	function
GridStack::getIconUri	public	function	Returns the icon URI.
GridStack::getIconUrl	public	function	Returns the icon URL.
GridStack::getJsonSummaryBreakpoints	public	function	Returns JSON for options.breakpoints[xs\|sm\|md\|lg\|xl] keyed by indices.
GridStack::getJsonSummaryNestedBreakpoints	public	function	Returns JSON for options.breakpoints[xs\|sm\|md\|lg\|xl] keyed by indices.
GridStack::getLastBreakpoint	public	function	Returns options.breakpoints.[lg\|xl].[column\|width\|grids\|nested]. Overrides GridStackInterface::getLastBreakpoint
GridStack::getLastBreakpointKey	public	function	Returns the last breakpoint key: Bootstrap3/Foundation lg, the rest xl.
GridStack::getLastColumn	public	function	Returns the last breakpoint column, or fallback to global setting.
GridStack::getNestedGridsByDelta	public	function	Returns the current nested grids with preserved indices even if empty. Overrides GridStackInterface::getNestedGridsByDelta
GridStack::getNode	public	function	Returns a node as required by admin storage, or frontend attributes.
GridStack::getSetting	public	function	Returns the value of a gridstack setting. Overrides GridStackInterface::getSetting
GridStack::getSettings	public	function	Returns the values of gridstack settings. Overrides GridStackInterface::getSettings
GridStack::isFramework	public	function	Returns TRUE if Use CSS framework is enabled, else FALSE.
GridStack::massageGrids	protected	function	Returns grids without regions if required.
GridStack::prepareRegions	public	function	Returns regions based on available grids. Overrides GridStackInterface::prepareRegions
GridStack::setSetting	public	function	Sets the value of a gridstack setting. Overrides GridStackInterface::setSetting
GridStack::setSettings	public	function	Sets the values of gridstack settings. Overrides GridStackInterface::setSettings
GridStackBase::$description	protected	property	The administrative description.
GridStackBase::$json	protected	property	The plugin instance json to reduce frontend logic.
GridStackBase::$label	protected	property	The human-readable name for the optionset.
GridStackBase::$name	protected	property	The legacy CTools ID for the configurable optionset.
GridStackBase::$options	protected	property	The plugin instance options.
GridStackBase::$weight	protected	property	The weight to re-arrange the order of gridstack optionsets.
GridStackBase::buildIconFileUri	public	function	Returns the file icon URI to be stored in public directory.
GridStackBase::description	public	function	Return description.
GridStackBase::getIconFileUri	public	function	Returns the file icon URI stored in public directory.
GridStackBase::getJson	public	function	Returns the GridStack json suitable for HTML data-attribute. Overrides GridStackBaseInterface::getJson
GridStackBase::getLabelFromId	public	function	Randomize a label from ID.
GridStackBase::getOptions	public	function	Returns the GridStack options by group, or property. Overrides GridStackBaseInterface::getOptions
GridStackBase::getRandomizedId	public	function	Returns a randomized ID.
GridStackBase::id	public	function	Overrides Drupal\Core\Entity\Entity::id(). Overrides EntityBase::id
GridStackBase::loadWithFallback	public static	function	Load the optionset with a fallback.
GridStackBase::randomize	public	function	Returns a random name.
GridStackBase::setJson	public	function
GridStackBase::setOption	public	function	Sets the value of a gridstack option. Overrides GridStackBaseInterface::setOption
GridStackBase::setOptions	public	function
GridStackVariant::$source	protected	property	The variant source.
GridStackVariant::createDuplicateVariant	public	function
GridStackVariant::defaultSettings	public static	function	Overrides GridStackBase::defaultSettings
GridStackVariant::getOption	public	function	Returns the value of a gridstack option group. Overrides GridStackBase::getOption
GridStackVariant::getOptionset	public	function	Returns the source GridStack optionset.
GridStackVariant::load	public static	function	Loads an entity. Overrides EntityBase::load
GridStackVariant::setSource	public	function	Sets the variant source aka original GridStack layout.
GridStackVariant::source	public	function	Returns the variant source aka original GridStack layout.
GridStackVariant::toUrl	public	function	Gets the URL object for the entity. Overrides ConfigEntityBase::toUrl
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
SynchronizableEntityTrait::$isSyncing	protected	property	Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing	public	function
SynchronizableEntityTrait::setSyncing	public	function

You are here

class GridStackVariant in GridStack 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation