You are here

Home » API reference » Config Snapshot 8 » ConfigSnapshot.php

class ConfigSnapshot in Config Snapshot 8

Defines the Config snapshot entity.

Plugin annotation


@ConfigEntityType(
  id = "config_snapshot",
  label = @Translation("Config snapshot"),
  label_singular = @Translation("Config snapshot item"),
  label_plural = @Translation("Config snapshot items"),
  label_count = @PluralTranslation(
    singular = "@count config snapshot item",
    plural = "@count config snapshot items",
  ),
  config_prefix = "snapshot",
  admin_permission = "administer site configuration",
  entity_keys = {
    "id" = "id"
  },
  config_export = {
    "id",
    "snapshotSet",
    "extensionType",
    "extensionName",
    "items"
  }
)

Hierarchy

Expanded class hierarchy of ConfigSnapshot

4 files declare their use of ConfigSnapshot
ConfigSnapshotConfigEntityUnitTest.php in tests/src/Unit/ConfigSnapshotConfigEntityUnitTest.php
ConfigSnapshotStorage.php in src/ConfigSnapshotStorage.php
ConfigSnapshotStorageTest.php in tests/src/Kernel/ConfigSnapshotStorageTest.php
ConfigSnapshotStorageTrait.php in src/ConfigSnapshotStorageTrait.php

File

src/Entity/ConfigSnapshot.php, line 33

Namespace

Drupal\config_snapshot\Entity
View source 
class ConfigSnapshot extends ConfigEntityBase implements ConfigSnapshotInterface {

  /**
   * The snapshot ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The snapshot set.
   *
   * A set is a group of snapshots used for a particular purpose. A set should
   * be namespaced for the module introducing it.
   *
   * @var string
   */
  protected $snapshotSet;

  /**
   * The snapshot type.
   *
   * @var string
   */
  protected $extensionType;

  /**
   * The snapshot name.
   *
   * @var string
   */
  protected $extensionName;

  /**
   * The snapshot items.
   *
   * @var array[]
   */
  protected $items = [];

  /**
   * {@inheritdoc}
   */
  public function id() {
    return "{$this->snapshotSet}.{$this->extensionType}.{$this->extensionName}";
  }

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public function setItems(array $items) {
    $this->items = $items;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getItem($collection, $name) {
    if (($key = $this
      ->getItemKey($collection, $name)) !== FALSE) {
      return $this->items[$key];
    }
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function setItem($collection, $name, array $data) {
    $item = [
      'collection' => $collection,
      'name' => $name,
      'data' => $data,
    ];
    if (($key = $this
      ->getItemKey($collection, $name)) !== FALSE) {
      $this->items[$key] = $item;
    }
    else {
      $this->items[] = $item;
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function clearItem($collection, $name) {
    if (($key = $this
      ->getItemKey($collection, $name)) !== FALSE) {
      unset($this->items[$key]);
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function save() {
    $collections = array_column($this->items, 'collection');
    $names = array_column($this->items, 'name');

    // Sort the items by collection then by name.
    array_multisort($collections, SORT_ASC, $names, SORT_ASC, $this->items);
    parent::save();
  }

  /**
   * Returns the key of a given item.
   *
   * @return int|false
   *   The key of the item or FALSE if not found.
   */
  protected function getItemKey($collection, $name) {
    $items = array_filter($this->items, function ($item) use ($collection, $name) {
      return $item['collection'] === $collection && $item['name'] === $name;
    });
    if ($items) {
      return key($items);
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();

    // Create a dependency on the extension.
    $this
      ->addDependency($this->extensionType, $this->extensionName);
    return $this;
  }

}

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::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::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
ConfigSnapshot::$extensionName protected property The snapshot name.
ConfigSnapshot::$extensionType protected property The snapshot type.
ConfigSnapshot::$id protected property The snapshot ID.
ConfigSnapshot::$items protected property The snapshot items.
ConfigSnapshot::$snapshotSet protected property The snapshot set.
ConfigSnapshot::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
ConfigSnapshot::clearItem public function Clears an item from the snapshot for a given collection. Overrides ConfigSnapshotInterface::clearItem
ConfigSnapshot::getExtensionName public function Returns the extension name for this snapshot. Overrides ConfigSnapshotInterface::getExtensionName
ConfigSnapshot::getExtensionType public function Returns the extension type for this snapshot. Overrides ConfigSnapshotInterface::getExtensionType
ConfigSnapshot::getItem public function Returns an item from the snapshot for a given collection. Overrides ConfigSnapshotInterface::getItem
ConfigSnapshot::getItemKey protected function Returns the key of a given item.
ConfigSnapshot::getItems public function Returns the items in this snapshot. Overrides ConfigSnapshotInterface::getItems
ConfigSnapshot::getSnapshotSet public function Returns the snapshot set. Overrides ConfigSnapshotInterface::getSnapshotSet
ConfigSnapshot::id public function Gets the identifier. Overrides EntityBase::id
ConfigSnapshot::save public function Saves an entity permanently. Overrides ConfigEntityBase::save
ConfigSnapshot::setItem public function Returns an item from the snapshot for a given collection. Overrides ConfigSnapshotInterface::setItem
ConfigSnapshot::setItems public function Sets the items for this snapshot. Overrides ConfigSnapshotInterface::setItems
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::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::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