class ContentTranslationManager

Same name in other branches
  1. 9 core/modules/content_translation/src/ContentTranslationManager.php \Drupal\content_translation\ContentTranslationManager
  2. 10 core/modules/content_translation/src/ContentTranslationManager.php \Drupal\content_translation\ContentTranslationManager
  3. 11.x core/modules/content_translation/src/ContentTranslationManager.php \Drupal\content_translation\ContentTranslationManager

Provides common functionality for content translation.

Hierarchy

Expanded class hierarchy of ContentTranslationManager

5 files declare their use of ContentTranslationManager
ContentTranslationController.php in core/modules/content_translation/src/Controller/ContentTranslationController.php
ContentTranslationDeleteAccess.php in core/modules/content_translation/src/Access/ContentTranslationDeleteAccess.php
ContentTranslationRouteSubscriber.php in core/modules/content_translation/src/Routing/ContentTranslationRouteSubscriber.php
content_translation.admin.inc in core/modules/content_translation/content_translation.admin.inc
The content translation administration forms.
content_translation.module in core/modules/content_translation/content_translation.module
Allows entities to be translated into different languages.
1 string reference to 'ContentTranslationManager'
content_translation.services.yml in core/modules/content_translation/content_translation.services.yml
core/modules/content_translation/content_translation.services.yml
1 service uses ContentTranslationManager
content_translation.manager in core/modules/content_translation/content_translation.services.yml
Drupal\content_translation\ContentTranslationManager

File

core/modules/content_translation/src/ContentTranslationManager.php, line 14

Namespace

Drupal\content_translation
View source
class ContentTranslationManager implements ContentTranslationManagerInterface, BundleTranslationSettingsInterface {
    use DeprecatedServicePropertyTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $deprecatedProperties = [
        'entityManager' => 'entity.manager',
        'updatesManager' => 'content_translation.updates_manager',
    ];
    
    /**
     * The entity type bundle info provider.
     *
     * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
     */
    protected $entityTypeBundleInfo;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * Constructs a ContentTranslationManageAccessCheck object.
     *
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
     *   The entity type bundle info provider.
     */
    public function __construct(EntityTypeManagerInterface $entity_type_manager, $entity_type_bundle_info) {
        $this->entityTypeManager = $entity_type_manager;
        if (!$entity_type_bundle_info instanceof EntityTypeBundleInfoInterface) {
            @trigger_error('The entity_type.bundle.info service should be passed to ContentTranslationManager::__construct() instead of the content_translation.updates_manager service since 8.7.0. This will be required in Drupal 9.0.0. See https://www.drupal.org/node/2549139 and https://www.drupal.org/node/2973222.', E_USER_DEPRECATED);
            $entity_type_bundle_info = \Drupal::service('entity_type.bundle.info');
        }
        $this->entityTypeBundleInfo = $entity_type_bundle_info;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTranslationHandler($entity_type_id) {
        return $this->entityTypeManager
            ->getHandler($entity_type_id, 'translation');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTranslationMetadata(EntityInterface $translation) {
        // We need a new instance of the metadata handler wrapping each translation.
        $entity_type = $translation->getEntityType();
        $class = $entity_type->get('content_translation_metadata');
        return new $class($translation, $this->getTranslationHandler($entity_type->id()));
    }
    
    /**
     * {@inheritdoc}
     */
    public function isSupported($entity_type_id) {
        $entity_type = $this->entityTypeManager
            ->getDefinition($entity_type_id);
        return $entity_type->isTranslatable() && ($entity_type->hasLinkTemplate('drupal:content-translation-overview') || $entity_type->get('content_translation_ui_skip'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSupportedEntityTypes() {
        $supported_types = [];
        foreach ($this->entityTypeManager
            ->getDefinitions() as $entity_type_id => $entity_type) {
            if ($this->isSupported($entity_type_id)) {
                $supported_types[$entity_type_id] = $entity_type;
            }
        }
        return $supported_types;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setEnabled($entity_type_id, $bundle, $value) {
        $config = $this->loadContentLanguageSettings($entity_type_id, $bundle);
        $config->setThirdPartySetting('content_translation', 'enabled', $value)
            ->save();
    }
    
    /**
     * {@inheritdoc}
     */
    public function isEnabled($entity_type_id, $bundle = NULL) {
        $enabled = FALSE;
        if ($this->isSupported($entity_type_id)) {
            $bundles = !empty($bundle) ? [
                $bundle,
            ] : array_keys($this->entityTypeBundleInfo
                ->getBundleInfo($entity_type_id));
            foreach ($bundles as $bundle) {
                $config = $this->loadContentLanguageSettings($entity_type_id, $bundle);
                if ($config->getThirdPartySetting('content_translation', 'enabled', FALSE)) {
                    $enabled = TRUE;
                    break;
                }
            }
        }
        return $enabled;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setBundleTranslationSettings($entity_type_id, $bundle, array $settings) {
        $config = $this->loadContentLanguageSettings($entity_type_id, $bundle);
        $config->setThirdPartySetting('content_translation', 'bundle_settings', $settings)
            ->save();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getBundleTranslationSettings($entity_type_id, $bundle) {
        $config = $this->loadContentLanguageSettings($entity_type_id, $bundle);
        return $config->getThirdPartySetting('content_translation', 'bundle_settings', []);
    }
    
    /**
     * 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 \Drupal\language\Entity\ContentLanguageSettings
     *   The content language config entity if one exists. Otherwise, returns
     *   default values.
     */
    protected function loadContentLanguageSettings($entity_type_id, $bundle) {
        if ($entity_type_id == NULL || $bundle == NULL) {
            return NULL;
        }
        $config = $this->entityTypeManager
            ->getStorage('language_content_settings')
            ->load($entity_type_id . '.' . $bundle);
        if ($config == NULL) {
            $config = $this->entityTypeManager
                ->getStorage('language_content_settings')
                ->create([
                'target_entity_type_id' => $entity_type_id,
                'target_bundle' => $bundle,
            ]);
        }
        return $config;
    }
    
    /**
     * Checks whether support for pending revisions should be enabled.
     *
     * @param string $entity_type_id
     *   The ID of the entity type to be checked.
     * @param string $bundle_id
     *   (optional) The ID of the bundle to be checked. Defaults to none.
     *
     * @return bool
     *   TRUE if pending revisions should be enabled, FALSE otherwise.
     *
     * @internal
     *   There is ongoing discussion about how pending revisions should behave.
     *   The logic enabling pending revision support is likely to change once a
     *   decision is made.
     *
     * @see https://www.drupal.org/node/2940575
     */
    public static function isPendingRevisionSupportEnabled($entity_type_id, $bundle_id = NULL) {
        if (!\Drupal::moduleHandler()->moduleExists('content_moderation')) {
            return FALSE;
        }
        foreach (Workflow::loadMultipleByType('content_moderation') as $workflow) {
            
            /** @var \Drupal\content_moderation\Plugin\WorkflowType\ContentModeration $plugin */
            $plugin = $workflow->getTypePlugin();
            $entity_type_ids = array_flip($plugin->getEntityTypes());
            if (isset($entity_type_ids[$entity_type_id])) {
                if (!isset($bundle_id)) {
                    return TRUE;
                }
                else {
                    $bundle_ids = array_flip($plugin->getBundlesForEntityType($entity_type_id));
                    if (isset($bundle_ids[$bundle_id])) {
                        return TRUE;
                    }
                }
            }
        }
        return FALSE;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ContentTranslationManager::$deprecatedProperties protected property
ContentTranslationManager::$entityTypeBundleInfo protected property The entity type bundle info provider.
ContentTranslationManager::$entityTypeManager protected property The entity type manager.
ContentTranslationManager::getBundleTranslationSettings public function Returns translation settings for the specified bundle. Overrides BundleTranslationSettingsInterface::getBundleTranslationSettings
ContentTranslationManager::getSupportedEntityTypes public function Gets the entity types that support content translation. Overrides ContentTranslationManagerInterface::getSupportedEntityTypes
ContentTranslationManager::getTranslationHandler public function Returns an instance of the Content translation handler. Overrides ContentTranslationManagerInterface::getTranslationHandler
ContentTranslationManager::getTranslationMetadata public function Returns an instance of the Content translation metadata. Overrides ContentTranslationManagerInterface::getTranslationMetadata
ContentTranslationManager::isEnabled public function Determines whether the given entity type is translatable. Overrides ContentTranslationManagerInterface::isEnabled
ContentTranslationManager::isPendingRevisionSupportEnabled public static function Checks whether support for pending revisions should be enabled.
ContentTranslationManager::isSupported public function Checks whether an entity type supports translation. Overrides ContentTranslationManagerInterface::isSupported
ContentTranslationManager::loadContentLanguageSettings protected function Loads a content language config entity based on the entity type and bundle.
ContentTranslationManager::setBundleTranslationSettings public function Sets translation settings for the specified bundle. Overrides BundleTranslationSettingsInterface::setBundleTranslationSettings
ContentTranslationManager::setEnabled public function Sets the value for translatability of the given entity type bundle. Overrides ContentTranslationManagerInterface::setEnabled
ContentTranslationManager::__construct public function Constructs a ContentTranslationManageAccessCheck object.
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.