class ContentTranslationPermissions in Drupal 9

Provides dynamic permissions for the content_translation module.

Hierarchy

• class \Drupal\content_translation\ContentTranslationPermissions implements ContainerInjectionInterface uses StringTranslationTrait

File

core/modules/content_translation/src/ContentTranslationPermissions.php, line 15

Namespace

Drupal\content_translation

class ContentTranslationPermissions implements ContainerInjectionInterface {
  use StringTranslationTrait;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity bundle info.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * The content translation manager.
   *
   * @var \Drupal\content_translation\ContentTranslationManagerInterface
   */
  protected $contentTranslationManager;

  /**
   * Constructs a ContentTranslationPermissions instance.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\content_translation\ContentTranslationManagerInterface $content_translation_manager
   *   The content translation manager.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
   *   The entity type bundle info.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, ContentTranslationManagerInterface $content_translation_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info) {
    $this->entityTypeManager = $entity_type_manager;
    $this->contentTranslationManager = $content_translation_manager;
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('content_translation.manager'), $container
      ->get('entity_type.bundle.info'));
  }

  /**
   * Returns an array of content translation permissions.
   *
   * @return array
   */
  public function contentPermissions() {
    $permissions = [];

    // Create a translate permission for each enabled entity type and (optionally)
    // bundle.
    foreach ($this->entityTypeManager
      ->getDefinitions() as $entity_type_id => $entity_type) {
      if ($permission_granularity = $entity_type
        ->getPermissionGranularity()) {
        switch ($permission_granularity) {
          case 'bundle':
            foreach ($this->entityTypeBundleInfo
              ->getBundleInfo($entity_type_id) as $bundle => $bundle_info) {
              if ($this->contentTranslationManager
                ->isEnabled($entity_type_id, $bundle)) {
                $permissions["translate {$bundle} {$entity_type_id}"] = $this
                  ->buildBundlePermission($entity_type, $bundle, $bundle_info);
              }
            }
            break;
          case 'entity_type':
            if ($this->contentTranslationManager
              ->isEnabled($entity_type_id)) {
              $permissions["translate {$entity_type_id}"] = [
                'title' => $this
                  ->t('Translate @entity_label', [
                  '@entity_label' => $entity_type
                    ->getSingularLabel(),
                ]),
                'dependencies' => [
                  'module' => [
                    $entity_type
                      ->getProvider(),
                  ],
                ],
              ];
            }
            break;
        }
      }
    }
    return $permissions;
  }

  /**
   * Builds a content translation permission array for a bundle.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   * @param string $bundle
   *   The bundle to build the translation permission for.
   * @param array $bundle_info
   *   The bundle info.
   *
   * @return array
   *   The permission details, keyed by 'title' and 'dependencies'.
   */
  private function buildBundlePermission(EntityTypeInterface $entity_type, string $bundle, array $bundle_info) {
    $permission = [
      'title' => $this
        ->t('Translate %bundle_label @entity_label', [
        '@entity_label' => $entity_type
          ->getSingularLabel(),
        '%bundle_label' => $bundle_info['label'] ?? $bundle,
      ]),
    ];

    // If the entity type uses bundle entities, add a dependency on the bundle.
    $bundle_entity_type = $entity_type
      ->getBundleEntityType();
    if ($bundle_entity_type && ($bundle_entity = $this->entityTypeManager
      ->getStorage($bundle_entity_type)
      ->load($bundle))) {
      $permission['dependencies'][$bundle_entity
        ->getConfigDependencyKey()][] = $bundle_entity
        ->getConfigDependencyName();
    }
    else {
      $permission['dependencies']['module'][] = $entity_type
        ->getProvider();
    }
    return $permission;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContentTranslationPermissions::$contentTranslationManager	protected	property	The content translation manager.
ContentTranslationPermissions::$entityTypeBundleInfo	protected	property	The entity bundle info.
ContentTranslationPermissions::$entityTypeManager	protected	property	The entity type manager.
ContentTranslationPermissions::buildBundlePermission	private	function	Builds a content translation permission array for a bundle.
ContentTranslationPermissions::contentPermissions	public	function	Returns an array of content translation permissions.
ContentTranslationPermissions::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
ContentTranslationPermissions::__construct	public	function	Constructs a ContentTranslationPermissions instance.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.