You are here

class ContentLanguageSettings in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/language/src/Entity/ContentLanguageSettings.php \Drupal\language\Entity\ContentLanguageSettings
  2. 9 core/modules/language/src/Entity/ContentLanguageSettings.php \Drupal\language\Entity\ContentLanguageSettings

Defines the ContentLanguageSettings entity.

Plugin annotation


@ConfigEntityType(
  id = "language_content_settings",
  label = @Translation("Content Language Settings"),
  label_collection = @Translation("Content Language Settings"),
  label_singular = @Translation("content language setting"),
  label_plural = @Translation("content languages settings"),
  label_count = @PluralTranslation(
    singular = "@count content language setting",
    plural = "@count content languages settings",
  ),
  admin_permission = "administer languages",
  config_prefix = "content_settings",
  entity_keys = {
    "id" = "id"
  },
  config_export = {
    "id",
    "target_entity_type_id",
    "target_bundle",
    "default_langcode",
    "language_alterable",
  },
  list_cache_tags = { "rendered" }
)

Hierarchy

Expanded class hierarchy of ContentLanguageSettings

33 files declare their use of ContentLanguageSettings
BlockContentTypeForm.php in core/modules/block_content/src/BlockContentTypeForm.php
CommentTypeForm.php in core/modules/comment/src/CommentTypeForm.php
ConfigurableLanguageManagerTest.php in core/modules/language/tests/src/Functional/ConfigurableLanguageManagerTest.php
ContentLanguageSettingsForm.php in core/modules/language/src/Form/ContentLanguageSettingsForm.php
ContentLanguageSettingsResourceTestBase.php in core/modules/language/tests/src/Functional/Rest/ContentLanguageSettingsResourceTestBase.php

... See full list

File

core/modules/language/src/Entity/ContentLanguageSettings.php, line 39

Namespace

Drupal\language\Entity
View source
class ContentLanguageSettings extends ConfigEntityBase implements ContentLanguageSettingsInterface {

  /**
   * The id. Combination of $target_entity_type_id.$target_bundle.
   *
   * @var string
   */
  protected $id;

  /**
   * The entity type ID (machine name).
   *
   * @var string
   */
  protected $target_entity_type_id;

  /**
   * The bundle (machine name).
   *
   * @var string
   */
  protected $target_bundle;

  /**
   * The default language code.
   *
   * @var string
   */
  protected $default_langcode = LanguageInterface::LANGCODE_SITE_DEFAULT;

  /**
   * Indicates if the language is alterable or not.
   *
   * @var bool
   */
  protected $language_alterable = FALSE;

  /**
   * Constructs a ContentLanguageSettings object.
   *
   * In most cases, Field entities are created via
   * FieldConfig::create($values), where $values is the same
   * parameter as in this constructor.
   *
   * @param array $values
   *   An array of the referring entity bundle with:
   *   - target_entity_type_id: The entity type.
   *   - target_bundle: The bundle.
   *   Other array elements will be used to set the corresponding properties on
   *   the class; see the class property documentation for details.
   * @param string $entity_type
   *   (optional) The entity type ID that is being created. Defaults to
   *   "language_content_settings".
   */
  public function __construct(array $values, $entity_type = 'language_content_settings') {
    if (empty($values['target_entity_type_id'])) {
      throw new ContentLanguageSettingsException('Attempt to create content language settings without a target_entity_type_id.');
    }
    if (empty($values['target_bundle'])) {
      throw new ContentLanguageSettingsException('Attempt to create content language settings without a target_bundle.');
    }
    parent::__construct($values, $entity_type);
  }

  /**
   * {@inheritdoc}
   */
  public function id() {
    return $this->target_entity_type_id . '.' . $this->target_bundle;
  }

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

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

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

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    $this->id = $this
      ->id();
    parent::preSave($storage);
  }

  /**
   * {@inheritdoc}
   */
  public function isDefaultConfiguration() {
    return !$this->language_alterable && $this->default_langcode == LanguageInterface::LANGCODE_SITE_DEFAULT;
  }

  /**
   * Loads a content language config entity based on the entity type and bundle.
   *
   * @param string $entity_type_id
   *   ID of the entity type.
   * @param string $bundle
   *   Bundle name.
   *
   * @return $this
   *   The content language config entity if one exists. Otherwise, returns
   *   default values.
   */
  public static function loadByEntityTypeBundle($entity_type_id, $bundle) {
    if ($entity_type_id == NULL || $bundle == NULL) {
      return NULL;
    }
    $config = \Drupal::entityTypeManager()
      ->getStorage('language_content_settings')
      ->load($entity_type_id . '.' . $bundle);
    if ($config == NULL) {
      $config = ContentLanguageSettings::create([
        'target_entity_type_id' => $entity_type_id,
        'target_bundle' => $bundle,
      ]);
    }
    return $config;
  }

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

    // Create dependency on the bundle.
    $entity_type = \Drupal::entityTypeManager()
      ->getDefinition($this->target_entity_type_id);
    $bundle_config_dependency = $entity_type
      ->getBundleConfigDependency($this->target_bundle);
    $this
      ->addDependency($bundle_config_dependency['type'], $bundle_config_dependency['name']);
    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
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::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 6
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::__sleep public function Overrides EntityBase::__sleep 3
ContentLanguageSettings::$default_langcode protected property The default language code.
ContentLanguageSettings::$id protected property The id. Combination of $target_entity_type_id.$target_bundle.
ContentLanguageSettings::$language_alterable protected property Indicates if the language is alterable or not.
ContentLanguageSettings::$target_bundle protected property The bundle (machine name).
ContentLanguageSettings::$target_entity_type_id protected property The entity type ID (machine name).
ContentLanguageSettings::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
ContentLanguageSettings::getDefaultLangcode public function Gets the default language code. Overrides ContentLanguageSettingsInterface::getDefaultLangcode
ContentLanguageSettings::getTargetBundle public function Gets the bundle this config applies to. Overrides ContentLanguageSettingsInterface::getTargetBundle
ContentLanguageSettings::getTargetEntityTypeId public function Gets the entity type ID this config applies to. Overrides ContentLanguageSettingsInterface::getTargetEntityTypeId
ContentLanguageSettings::id public function Gets the identifier. Overrides EntityBase::id
ContentLanguageSettings::isDefaultConfiguration public function Checks if this config object contains the default values in every property. Overrides ContentLanguageSettingsInterface::isDefaultConfiguration
ContentLanguageSettings::isLanguageAlterable public function Checks if the language is alterable or not. Overrides ContentLanguageSettingsInterface::isLanguageAlterable
ContentLanguageSettings::loadByEntityTypeBundle public static function Loads a content language config entity based on the entity type and bundle.
ContentLanguageSettings::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
ContentLanguageSettings::setDefaultLangcode public function Sets the default language code. Overrides ContentLanguageSettingsInterface::setDefaultLangcode
ContentLanguageSettings::setLanguageAlterable public function Sets if the language must be alterable or not. Overrides ContentLanguageSettingsInterface::setLanguageAlterable
ContentLanguageSettings::setTargetBundle public function Sets the bundle this config applies to. Overrides ContentLanguageSettingsInterface::setTargetBundle
ContentLanguageSettings::__construct public function Constructs a ContentLanguageSettings object. Overrides ConfigEntityBase::__construct
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 1
EntityBase::bundle public function 1
EntityBase::create public static function 1
EntityBase::delete public function 2
EntityBase::enforceIsNew public function
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function
EntityBase::getCacheMaxAge public function
EntityBase::getCacheTags public function
EntityBase::getConfigDependencyKey public function
EntityBase::getEntityType public function
EntityBase::getEntityTypeId public function
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function
EntityBase::label public function 5
EntityBase::language public function 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates.
EntityBase::load public static function
EntityBase::loadMultiple public static function
EntityBase::postCreate public function 4
EntityBase::postDelete public static function 12
EntityBase::postLoad public static function 3
EntityBase::postSave public function 13
EntityBase::preCreate public static function 5
EntityBase::referencedEntities public function 1
EntityBase::toLink public function
EntityBase::uriRelationships public function
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 1
EntityBase::uuid public function 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
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