class LayoutOption in Bootstrap Layout Builder 2.x

Same name and namespace in other branches

1.x src/Entity/LayoutOption.php \Drupal\bootstrap_layout_builder\Entity\LayoutOption

Defines the layout option entity class.

Plugin annotation


@ConfigEntityType(
  id = "blb_layout_option",
  label = @Translation("Bootstrap Layout Builder Layout option"),
  label_collection = @Translation("Bootstrap Layout Builder Layout Options"),
  label_plural = @Translation("Bootstrap Layout Builder Layout Option"),
  handlers = {
    "route_provider" = {
      "html" = "Drupal\Core\Entity\Routing\AdminHtmlRouteProvider"
    },
    "form" = {
      "default" = "Drupal\bootstrap_layout_builder\Form\LayoutOptionForm",
      "add" = "Drupal\bootstrap_layout_builder\Form\LayoutOptionForm",
      "edit" = "Drupal\bootstrap_layout_builder\Form\LayoutOptionForm",
      "delete" = "Drupal\bootstrap_layout_builder\Form\LayoutOptionDeleteForm"
    },
  },
  config_prefix = "layout_option",
  admin_permission = "administer site configuration",
  entity_keys = {
    "id" = "id",
    "uuid" = "uuid",
    "layout_id" = "layout_id",
    "label" = "label",
    "structure" = "structure",
    "default_breakpoints" = "default_breakpoints",
    "breakpoints" = "breakpoints",
    "weight" = "weight",
  },
  config_export = {
    "id" = "id",
    "uuid" = "uuid",
    "layout_id" = "layout_id",
    "label" = "label",
    "structure" = "structure",
    "default_breakpoints" = "default_breakpoints",
    "breakpoints" = "breakpoints",
    "weight" = "weight",
  },
  links = {
    "delete-form" = "/admin/config/bootstrap-layout-builder/layouts/options/{blb_layout_option}/delete",
    "edit-form" = "/admin/config/bootstrap-layout-builder/layouts/options/{blb_layout_option}/edit",
    "add-form" = "/admin/config/bootstrap-layout-builder/layouts/{blb_layout}/options/add"
  },
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\bootstrap_layout_builder\Entity\LayoutOption implements LayoutOptionInterface

Expanded class hierarchy of LayoutOption

File

src/Entity/LayoutOption.php, line 57

Namespace

Drupal\bootstrap_layout_builder\Entity

View source

class LayoutOption extends ConfigEntityBase implements LayoutOptionInterface {

  /**
   * The machine name for the configuration entity.
   *
   * @var string
   */
  protected $id;

  /**
   * The human-readable name of the configuration entity.
   *
   * @var string
   */
  protected $label;

  /**
   * The layout id.
   *
   * @var string
   */
  protected $layout_id;

  /**
   * The structure of option columns.
   *
   * @var string
   */
  protected $structure;

  /**
   * The enabled breakpoints for this option.
   *
   * @var array
   */
  protected $breakpoints;

  /**
   * The enabled default breakpoints for this option.
   *
   * @var array
   */
  protected $default_breakpoints;

  /**
   * Order of options on the config page & Layout Builder add/update forms.
   *
   * @var int
   */
  protected $weight = 0;

  /**
   * {@inheritdoc}
   */
  public function getLayoutId() {
    return $this->layout_id;
  }

  /**
   * {@inheritdoc}
   */
  public function setLayoutId($layout_id) {
    $this->layout_id = $layout_id;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getStructure() {
    return $this->structure;
  }

  /**
   * {@inheritdoc}
   */
  public function setStructure($structure) {
    $this->structure = $structure;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getStructureId() {
    return 'blb_col_' . str_replace(' ', '_', $this->structure);
  }

  /**
   * {@inheritdoc}
   */
  public function getWeight() {
    return $this->weight;
  }

  /**
   * {@inheritdoc}
   */
  public function setWeight($weight) {
    $this->weight = $weight;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getBreakpointsIds() {
    $ids = [];
    if ($this->breakpoints) {
      foreach ($this->breakpoints as $key => $value) {
        if ($value) {
          $ids[] = $key;
        }
      }
    }
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  public function getBreakpointsLabels() {
    $labels = [];
    foreach ($this->breakpoints as $breakpoint_id) {
      $breakpoint = $this
        ->entityTypeManager()
        ->getStorage('blb_breakpoint')
        ->load($breakpoint_id);
      if ($breakpoint) {
        $labels[] = $breakpoint
          ->label();
      }
    }
    return $labels;
  }

  /**
   * {@inheritdoc}
   */
  public function getLayout() {
    $layout = $this
      ->entityTypeManager()
      ->getStorage('blb_layout')
      ->load($this->layout_id);
    return $layout;
  }

  /**
   * {@inheritdoc}
   */
  public function getLayoutById($layout_id) {
    $layout = $this
      ->entityTypeManager()
      ->getStorage('blb_layout')
      ->load($layout_id);
    return $layout;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultBreakpointsIds() {
    $ids = [];
    if ($this->default_breakpoints) {
      foreach ($this->default_breakpoints as $key => $value) {
        if ($value) {
          $ids[] = $key;
        }
      }
    }
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultBreakpointsLabels() {
    $labels = [];
    if ($this->default_breakpoints) {
      foreach ($this->default_breakpoints as $breakpoint_id) {
        $breakpoint = $this
          ->entityTypeManager()
          ->getStorage('blb_breakpoint')
          ->load($breakpoint_id);
        if ($breakpoint) {
          $labels[] = $breakpoint
            ->label();
        }
      }
    }
    return $labels;
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);
    foreach ($this
      ->getLayout()
      ->getLayoutOptions() as $layoutOption) {
      if ($layoutOption
        ->getOriginalId() !== $this
        ->getOriginalId()) {
        if (array_intersect($this
          ->getDefaultBreakpointsIds(), $layoutOption
          ->getDefaultBreakpointsIds())) {
          $breakpoints = $this
            ->entityTypeManager()
            ->getStorage('blb_breakpoint')
            ->loadMultiple(array_diff($layoutOption
            ->getDefaultBreakpointsIds(), $this
            ->getDefaultBreakpointsIds()));
          $layoutOption->default_breakpoints = array_map(function ($breakpoint) {
            return $breakpoint
              ->id();
          }, $breakpoints);
          $layoutOption
            ->save();
        }
      }
    }
  }

}

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
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	14
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::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	8
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::toUrl	public	function	Gets the URL object for the entity. Overrides EntityBase::toUrl
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::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct	10
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	4
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	2
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::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
EntityBase::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
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::id	public	function	Gets the identifier. Overrides EntityInterface::id	11
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::load	public static	function	Loads an entity. Overrides EntityInterface::load
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	18
EntityBase::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	7
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.
LayoutOption::$breakpoints	protected	property	The enabled breakpoints for this option.
LayoutOption::$default_breakpoints	protected	property	The enabled default breakpoints for this option.
LayoutOption::$id	protected	property	The machine name for the configuration entity.
LayoutOption::$label	protected	property	The human-readable name of the configuration entity.
LayoutOption::$layout_id	protected	property	The layout id.
LayoutOption::$structure	protected	property	The structure of option columns.
LayoutOption::$weight	protected	property	Order of options on the config page & Layout Builder add/update forms.
LayoutOption::getBreakpointsIds	public	function	Returns array of enabled breakpoints ids. Overrides LayoutOptionInterface::getBreakpointsIds
LayoutOption::getBreakpointsLabels	public	function	Returns array of enabled breakpoints lablels. Overrides LayoutOptionInterface::getBreakpointsLabels
LayoutOption::getDefaultBreakpointsIds	public	function	Returns array of enabled default breakpoints ids. Overrides LayoutOptionInterface::getDefaultBreakpointsIds
LayoutOption::getDefaultBreakpointsLabels	public	function	Returns array of enabled default breakpoints labels. Overrides LayoutOptionInterface::getDefaultBreakpointsLabels
LayoutOption::getLayout	public	function	Returns parent layout entity. Overrides LayoutOptionInterface::getLayout
LayoutOption::getLayoutById	public	function	Get layout entity by Id. Overrides LayoutOptionInterface::getLayoutById
LayoutOption::getLayoutId	public	function	Returns the layout_id. Overrides LayoutOptionInterface::getLayoutId
LayoutOption::getStructure	public	function	Returns the structure. Overrides LayoutOptionInterface::getStructure
LayoutOption::getStructureId	public	function	Returns the structure id for select list options. Overrides LayoutOptionInterface::getStructureId
LayoutOption::getWeight	public	function	Returns the weight among layout options with the same depth. Overrides LayoutOptionInterface::getWeight
LayoutOption::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave
LayoutOption::setLayoutId	public	function	Sets the layout_id. Overrides LayoutOptionInterface::setLayoutId
LayoutOption::setStructure	public	function	Sets the structure. Overrides LayoutOptionInterface::setStructure
LayoutOption::setWeight	public	function	Sets the weight among layout options with the same depth. Overrides LayoutOptionInterface::setWeight
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 LayoutOption in Bootstrap Layout Builder 2.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation