You are here

Home » API reference » Acquia Content Hub 8 » ContentHubEntityTypeConfig.php

class ContentHubEntityTypeConfig in Acquia Content Hub 8

Defines a ContentHubEntityTypeConfig configuration entity class.

Plugin annotation


@ConfigEntityType(
  id = "acquia_contenthub_entity_config",
  label = @Translation("Acquia Content Hub Entity Type configuration"),
  config_prefix = "entity",
  admin_permission = "Administer Acquia Content Hub",
  label_callback = "getLabelFromPlugin",
  entity_keys = {
    "id" = "id"
  },
  config_export = {
    "id",
    "bundles",
  }
)

Hierarchy

Expanded class hierarchy of ContentHubEntityTypeConfig

2 files declare their use of ContentHubEntityTypeConfig
acquia_contenthub.post_update.php in ./acquia_contenthub.post_update.php
Post update functions for Acquia Content Hub.
EntityManagerTest.php in tests/src/Unit/EntityManagerTest.php

File

src/Entity/ContentHubEntityTypeConfig.php, line 30

Namespace

Drupal\acquia_contenthub\Entity
View source 
class ContentHubEntityTypeConfig extends ConfigEntityBase implements ContentHubEntityTypeConfigInterface {

  /**
   * The Content Hub Entity Type Configuration.
   *
   * @var string
   */
  protected $id;

  /**
   * The Bundle Configuration.
   *
   * @var array
   *   An array keyed by bundle.
   */
  protected $bundles;

  /**
   * Gets the list of bundles and their configuration.
   *
   * @return array
   *   An array keyed by bundle.
   */
  public function getBundles() {
    return $this->bundles;
  }

  /**
   * Check if this bundle is enabled.
   *
   * @param string $bundle
   *   The entity bundle.
   *
   * @return bool
   *   TRUE if enabled, FALSE otherwise.
   */
  public function isEnableIndex($bundle) {
    return !empty($this->bundles[$bundle]['enable_index']);
  }

  /**
   * Check if view modes are enabled.
   *
   * @param string $bundle
   *   The entity bundle.
   *
   * @return bool
   *   TRUE if enabled, FALSE otherwise.
   */
  public function isEnabledViewModes($bundle) {
    return !empty($this->bundles[$bundle]['enable_viewmodes']);
  }

  /**
   * Obtains the list of rendering view modes.
   *
   * Note this does not check whether the view modes are enabled so a previous
   * check on that has to be done.
   *
   * @param string $bundle
   *   The entity bundle.
   *
   * @return array
   *   An array of rendering view modes.
   */
  public function getRenderingViewModes($bundle) {
    return isset($this->bundles[$bundle]['rendering']) ? $this->bundles[$bundle]['rendering'] : [];
  }

  /**
   * Sets the bundles.
   *
   * @param array $bundles
   *   An array of bundles configuration.
   */
  public function setBundles(array $bundles) {
    $this->bundles = $bundles;
  }

  /**
   * Obtains the Preview Image Field for this particular bundle.
   *
   * @param string $bundle
   *   The entity bundle.
   *
   * @return string|null
   *   The preview image field if exists, NULL otherwise.
   */
  public function getPreviewImageField($bundle) {
    return isset($this->bundles[$bundle]['preview_image_field']) ? $this->bundles[$bundle]['preview_image_field'] : NULL;
  }

  /**
   * Obtains the Preview Image Style for this particular bundle.
   *
   * @param string $bundle
   *   The entity bundle.
   *
   * @return string|null
   *   The preview image style if exists, NULL otherwise.
   */
  public function getPreviewImageStyle($bundle) {
    return isset($this->bundles[$bundle]['preview_image_style']) ? $this->bundles[$bundle]['preview_image_style'] : NULL;
  }

  /**
   * Sets the preview image field for a specific bundle.
   *
   * @param string $bundle
   *   The entity bundle.
   * @param string $image_field
   *   The preview image field.
   */
  public function setPreviewImageField($bundle, $image_field) {
    if ($this
      ->isEnableIndex($bundle)) {
      $this->bundles[$bundle]['preview_image_field'] = $image_field;
    }
  }

  /**
   * Sets the preview image style for a specific bundle.
   *
   * @param string $bundle
   *   The entity bundle.
   * @param string $image_style
   *   The preview image style.
   */
  public function setPreviewImageStyle($bundle, $image_style) {
    if ($this
      ->isEnableIndex($bundle)) {
      $this->bundles[$bundle]['preview_image_style'] = $image_style;
    }
  }

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

    // Add dependencies on module.
    $entity_type = $this
      ->entityTypeManager()
      ->getDefinition($this
      ->id());
    $this
      ->addDependency('module', $entity_type
      ->getProvider());

    // Add config dependencies.
    $bundles = array_keys($this
      ->getBundles());
    foreach ($bundles as $bundle) {
      if ($this
        ->isEnableIndex($bundle)) {

        // Add dependency on this particular bundle.
        $this
          ->calculateDependenciesForBundle($entity_type, $bundle);

        // Add dependencies on all enabled view modes.
        if ($this
          ->isEnabledViewModes($bundle)) {
          $this
            ->calculateDependenciesForViewModes($entity_type, $bundle);
        }

        // Add dependencies on preview image fields and styles.
        $entity_field_manager = $this
          ->entityFieldManager();
        $this
          ->calculateDependenciesForPreviewImage($entity_field_manager, $bundle);
      }
    }
    return $this;
  }

  /**
   * Calculates dependencies for bundle.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The Entity Type object.
   * @param string $bundle
   *   The entity bundle.
   */
  protected function calculateDependenciesForBundle(EntityTypeInterface $entity_type, $bundle) {
    $config_bundle = $entity_type
      ->getBundleConfigDependency($bundle);
    $this
      ->addDependency($config_bundle['type'], $config_bundle['name']);
  }

  /**
   * Calculate dependencies for view modes.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The Entity Type object.
   * @param string $bundle
   *   The entity bundle.
   */
  protected function calculateDependenciesForViewModes(EntityTypeInterface $entity_type, $bundle) {
    if ($this
      ->isEnabledViewModes($bundle)) {
      $view_modes = $this
        ->getRenderingViewModes($bundle);
      foreach ($view_modes as $view_mode) {

        // Enable dependency on these view modes.

        /** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display */
        $viewmode = "{$entity_type->id()}.{$bundle}.{$view_mode}";
        if ($display = EntityViewDisplay::load($viewmode)) {
          $this
            ->addDependencies($display
            ->getDependencies());
        }
      }
    }
  }

  /**
   * Calculates dependencies for Preview Image.
   *
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The Entity Field Manager service.
   * @param string $bundle
   *   The entity bundle.
   */
  protected function calculateDependenciesForPreviewImage(EntityFieldManagerInterface $entity_field_manager, $bundle) {
    $preview_image_field = $this
      ->getPreviewImageField($bundle);
    $preview_image_style = $this
      ->getPreviewImageStyle($bundle);

    // Calculate dependencies for preview image field.
    if (!empty($preview_image_field)) {

      /** @var \Drupal\Core\Field\FieldDefinitionInterface[] $fields */
      $fields = $entity_field_manager
        ->getFieldDefinitions($this
        ->id(), $bundle);
      $field_config = isset($fields[$preview_image_field]) ? $fields[$preview_image_field]
        ->getConfig($bundle) : FALSE;
      if ($field_config) {
        $this
          ->addDependencies($field_config
          ->getDependencies());
      }

      // Calculate dependencies for preview image style.
      if (!empty($preview_image_style)) {
        $image_style = ImageStyle::load($preview_image_style);
        if (isset($image_style)) {
          $this
            ->addDependency($image_style
            ->getConfigDependencyKey(), $image_style
            ->getConfigDependencyName());
          $this
            ->addDependencies($image_style
            ->getDependencies());
        }
      }
    }
  }

  /**
   * Gets the entity type manager service.
   *
   * @return \Drupal\Core\Entity\EntityTypeManagerInterface
   *   Returns the EntityTypeManager service.
   */
  protected function entityTypeManager() {
    return \Drupal::entityTypeManager();
  }

  /**
   * Gets the entity field manager service.
   *
   * @return \Drupal\Core\Entity\EntityFieldManagerInterface
   *   Returns the EntityFieldManager service.
   */
  protected function entityFieldManager() {
    return \Drupal::getContainer()
      ->get('entity_field.manager');
  }

}

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::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
ContentHubEntityTypeConfig::$bundles protected property The Bundle Configuration.
ContentHubEntityTypeConfig::$id protected property The Content Hub Entity Type Configuration.
ContentHubEntityTypeConfig::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
ContentHubEntityTypeConfig::calculateDependenciesForBundle protected function Calculates dependencies for bundle.
ContentHubEntityTypeConfig::calculateDependenciesForPreviewImage protected function Calculates dependencies for Preview Image.
ContentHubEntityTypeConfig::calculateDependenciesForViewModes protected function Calculate dependencies for view modes.
ContentHubEntityTypeConfig::entityFieldManager protected function Gets the entity field manager service.
ContentHubEntityTypeConfig::entityTypeManager protected function Gets the entity type manager service. Overrides EntityBase::entityTypeManager
ContentHubEntityTypeConfig::getBundles public function Gets the list of bundles and their configuration. Overrides ContentHubEntityTypeConfigInterface::getBundles
ContentHubEntityTypeConfig::getPreviewImageField public function Obtains the Preview Image Field for this particular bundle. Overrides ContentHubEntityTypeConfigInterface::getPreviewImageField
ContentHubEntityTypeConfig::getPreviewImageStyle public function Obtains the Preview Image Style for this particular bundle. Overrides ContentHubEntityTypeConfigInterface::getPreviewImageStyle
ContentHubEntityTypeConfig::getRenderingViewModes public function Obtains the list of rendering view modes. Overrides ContentHubEntityTypeConfigInterface::getRenderingViewModes
ContentHubEntityTypeConfig::isEnabledViewModes public function Check if view modes are enabled. Overrides ContentHubEntityTypeConfigInterface::isEnabledViewModes
ContentHubEntityTypeConfig::isEnableIndex public function Check if this bundle is enabled. Overrides ContentHubEntityTypeConfigInterface::isEnableIndex
ContentHubEntityTypeConfig::setBundles public function Sets the bundles. Overrides ContentHubEntityTypeConfigInterface::setBundles
ContentHubEntityTypeConfig::setPreviewImageField public function Sets the preview image field for a specific bundle. Overrides ContentHubEntityTypeConfigInterface::setPreviewImageField
ContentHubEntityTypeConfig::setPreviewImageStyle public function Sets the preview image style for a specific bundle. Overrides ContentHubEntityTypeConfigInterface::setPreviewImageStyle
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::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