You are here

Home » API reference » Dynamic Layouts 8 » DynamicLayoutSettings.php

class DynamicLayoutSettings in Dynamic Layouts 8

Defines the DynamicLayoutSettings entity.

The DynamicLayout entity stores information about a dynamic layout.

Plugin annotation


@ConfigEntityType(
  id = "dynamic_layout_settings",
  label = @Translation("Dynamic layout settings"),
  module = "dynamic_layout",
  config_prefix = "dynamic_layout_settings",
  admin_permission = "admin dynamic layouts",
  handlers = {
    "form" = {
      "default" = "Drupal\dynamic_layouts\Form\SettingsForm",
    },
  },
  links = {
    "edit-form" = "/admin/config/dynamic-layouts/settings/{dynamic_layout_settings}",
  },
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  config_export = {
    "id",
    "label",
    "settings",
  }
)

Hierarchy

Expanded class hierarchy of DynamicLayoutSettings

File

src/Entity/DynamicLayoutSettings.php, line 39

Namespace

Drupal\dynamic_layouts\Entity
View source 
class DynamicLayoutSettings extends ConfigEntityBase implements DynamicLayoutSettingsInterface {

  /**
   * The layout machine name.
   *
   * @var string
   */
  public $id;

  /**
   * The human readable name of this layout.
   *
   * @var string
   */
  public $label;

  /**
   * The regions of this layout.
   *
   * @var string
   */
  public $settings;

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

  /**
   * {@inheritdoc}
   */
  public function getFrontendLibrary() {
    $settings = unserialize($this->settings);
    return isset($settings[Constants::FRONTEND_LIBRARY]) ? $settings[Constants::FRONTEND_LIBRARY] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function setFrontendLibrary($frontend_library) {
    $settings = unserialize($this->settings);
    $settings[Constants::FRONTEND_LIBRARY] = $frontend_library;
    $this->settings = serialize($settings);
  }

  /**
   * {@inheritdoc}
   */
  public function getColumnPrefix() {
    $settings = unserialize($this->settings);
    $column_prefix = NULL;

    // Check for grid column prefix from settings.
    if (isset($settings[Constants::COLUMN_PREFIX])) {
      $column_prefix = $settings[Constants::COLUMN_PREFIX];
    }

    // Default column prefix for bootstrap.
    if ($this
      ->getFrontendLibrary() == Constants::BOOTSTRAP) {
      $column_prefix = 'col';
    }
    return $column_prefix;
  }

  /**
   * {@inheritdoc}
   */
  public function setColumnPrefix($column_prefix) {
    $settings = unserialize($this->settings);
    $settings[Constants::COLUMN_PREFIX] = $column_prefix;
    $this->settings = serialize($settings);
  }

  /**
   * {@inheritdoc}
   */
  public function getGridColumnCount() {
    $settings = unserialize($this->settings);
    $column_count = NULL;

    // Check for grid column count from settings.
    if (isset($settings[Constants::GRID_COLUMN_COUNT])) {
      $column_count = $settings[Constants::GRID_COLUMN_COUNT];
    }

    // Default column count for bootstrap.
    if ($this
      ->getFrontendLibrary() == Constants::BOOTSTRAP) {
      $column_count = 12;
    }
    return $column_count;
  }

  /**
   * {@inheritdoc}
   */
  public function setGridColumnCount($grid_column_count) {
    $settings = unserialize($this->settings);
    $settings[Constants::GRID_COLUMN_COUNT] = $grid_column_count;
    $this->settings = serialize($settings);
  }

  /**
   * {@inheritdoc}
   */
  public function getFrontendColumnClasses() {
    $frontend_library = $this
      ->getFrontendLibrary();

    // Get the column classes based on the chosen frontend library.
    switch ($frontend_library) {
      case 'custom':
        $column_classes = $this
          ->getCustomColumnClasses();
        break;
      case Constants::BOOTSTRAP:
      default:
        $column_classes = $this
          ->getBootstrapColumnClasses();
        break;
    }
    return $column_classes;
  }

  /**
   * {@inheritdoc}
   */
  public function purgeColumnWidthNumbers($last_column_number, $new_column_prefix = '') {
    if (!($layout_config_entities = \Drupal::entityTypeManager()
      ->getStorage('dynamic_layout')
      ->loadMultiple())) {
      return NULL;
    }

    /* @var \Drupal\dynamic_layouts\DynamicLayoutInterface $layout_config_entity */
    foreach ($layout_config_entities as $layout_config_entity) {

      // Loop over the rows and their columns.
      $rows = $layout_config_entity
        ->getRows();
      if ($rows) {
        foreach ($rows as $row_key => $row) {
          $columns = $row[Constants::COLUMNS];
          foreach ($columns as $column_key => $column) {
            $rows[$row_key][Constants::COLUMNS][$column_key]['column_width_number'] = $last_column_number;
            if ($new_column_prefix) {
              $rows[$row_key][Constants::COLUMNS][$column_key]['column_width_prefix'] = $new_column_prefix;
            }
            if (isset($rows[$row_key][Constants::COLUMNS][$column_key]['custom_column_width_number'])) {
              unset($rows[$row_key][Constants::COLUMNS][$column_key]['custom_column_width_number']);
            }
          }
        }
      }
      $layout_config_entity->regions = serialize($rows);
      $layout_config_entity
        ->save();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getLastColumnNumber($frontend_library, $new_column_prefix, $new_grid_column_count) {
    $last_column_class = '';

    // Get the column classes based on the chosen frontend library.
    switch ($frontend_library) {
      case 'custom':
        $column_classes = $this
          ->getCustomColumnClasses($new_grid_column_count);
        break;
      case Constants::BOOTSTRAP:
      default:
        $column_classes = $this
          ->getBootstrapColumnClasses();
        break;
    }
    if ($column_classes) {
      $last_column_class = end($column_classes);
    }
    return $last_column_class;
  }

  /**
   * {@inheritdoc}
   */
  private function getBootstrapColumnClasses() {
    $bootstrap_column_widths = [];
    for ($i = 1; $i <= 12; $i++) {
      $bootstrap_column_widths[$i] = $i;
    }
    return $bootstrap_column_widths;
  }

  /**
   * {@inheritdoc}
   */
  private function getCustomColumnClasses($new_grid_column_count = '') {
    $grid_column_count = $this
      ->getGridColumnCount();
    if ($new_grid_column_count) {
      $grid_column_count = $new_grid_column_count;
    }

    // Convert to integer.
    $grid_column_count = intval($grid_column_count);
    $column_classes = [];
    for ($i = 1; $i <= $grid_column_count; $i++) {
      $column_class = $i;
      $column_classes[$column_class] = $column_class;
    }
    return $column_classes;
  }

}

Members

Namesort descending 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::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::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
DynamicLayoutSettings::$id public property The layout machine name.
DynamicLayoutSettings::$label public property The human readable name of this layout.
DynamicLayoutSettings::$settings public property The regions of this layout.
DynamicLayoutSettings::getBootstrapColumnClasses private function
DynamicLayoutSettings::getColumnPrefix public function Get the column prefix. Overrides DynamicLayoutSettingsInterface::getColumnPrefix
DynamicLayoutSettings::getCustomColumnClasses private function
DynamicLayoutSettings::getFrontendColumnClasses public function Get the frontend column classes. Overrides DynamicLayoutSettingsInterface::getFrontendColumnClasses
DynamicLayoutSettings::getFrontendLibrary public function Set the frontend library. Overrides DynamicLayoutSettingsInterface::getFrontendLibrary
DynamicLayoutSettings::getGridColumnCount public function Get the grid column count. Overrides DynamicLayoutSettingsInterface::getGridColumnCount
DynamicLayoutSettings::getLastColumnNumber public function Get the first column number for a specific frontend library. Overrides DynamicLayoutSettingsInterface::getLastColumnNumber
DynamicLayoutSettings::getSettings public function Get the Dynamic layout general settings. Overrides DynamicLayoutSettingsInterface::getSettings
DynamicLayoutSettings::purgeColumnWidthNumbers public function Purge all column width numbers from all rows. Overrides DynamicLayoutSettingsInterface::purgeColumnWidthNumbers
DynamicLayoutSettings::setColumnPrefix public function Set the column prefix. Overrides DynamicLayoutSettingsInterface::setColumnPrefix
DynamicLayoutSettings::setFrontendLibrary public function Set the frontend library. Overrides DynamicLayoutSettingsInterface::setFrontendLibrary
DynamicLayoutSettings::setGridColumnCount public function Set the grid column count. Overrides DynamicLayoutSettingsInterface::setGridColumnCount
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::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::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 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.
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