class TaxonomyPermissions

Same name in other branches
  1. 9 core/modules/taxonomy/src/TaxonomyPermissions.php \Drupal\taxonomy\TaxonomyPermissions
  2. 8.9.x core/modules/taxonomy/src/TaxonomyPermissions.php \Drupal\taxonomy\TaxonomyPermissions
  3. 10 core/modules/taxonomy/src/TaxonomyPermissions.php \Drupal\taxonomy\TaxonomyPermissions

Provides dynamic permissions of the taxonomy module.

Hierarchy

Expanded class hierarchy of TaxonomyPermissions

See also

taxonomy.permissions.yml

File

core/modules/taxonomy/src/TaxonomyPermissions.php, line 17

Namespace

Drupal\taxonomy
View source 
class TaxonomyPermissions implements ContainerInjectionInterface {
    use BundlePermissionHandlerTrait;
    use StringTranslationTrait;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * Constructs a TaxonomyPermissions instance.
     *
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     */
    public function __construct(EntityTypeManagerInterface $entity_type_manager) {
        $this->entityTypeManager = $entity_type_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('entity_type.manager'));
    }
    
    /**
     * Get taxonomy permissions.
     *
     * @return array
     *   Permissions array.
     */
    public function permissions() {
        return $this->generatePermissions(Vocabulary::loadMultiple(), [
            $this,
            'buildPermissions',
        ]);
    }
    
    /**
     * Builds a standard list of taxonomy term permissions for a given vocabulary.
     *
     * @param \Drupal\taxonomy\VocabularyInterface $vocabulary
     *   The vocabulary.
     *
     * @return array
     *   An array of permission names and descriptions.
     */
    protected function buildPermissions(VocabularyInterface $vocabulary) {
        $id = $vocabulary->id();
        $args = [
            '%vocabulary' => $vocabulary->label(),
        ];
        return [
            "create terms in {$id}" => [
                'title' => $this->t('%vocabulary: Create terms', $args),
            ],
            "delete terms in {$id}" => [
                'title' => $this->t('%vocabulary: Delete terms', $args),
            ],
            "edit terms in {$id}" => [
                'title' => $this->t('%vocabulary: Edit terms', $args),
            ],
            "view term revisions in {$id}" => [
                'title' => $this->t('%vocabulary: View term revisions', $args),
            ],
            "revert term revisions in {$id}" => [
                'title' => $this->t('%vocabulary: Revert term revisions', $args),
                'description' => $this->t('To revert a revision you also need permission to edit the taxonomy term.'),
            ],
            "delete term revisions in {$id}" => [
                'title' => $this->t('%vocabulary: Delete term revisions', $args),
                'description' => $this->t('To delete a revision you also need permission to delete the taxonomy term.'),
            ],
        ];
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
BundlePermissionHandlerTrait::generatePermissions protected function Builds a permissions array for the supplied bundles.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.
TaxonomyPermissions::$entityTypeManager protected property The entity type manager.
TaxonomyPermissions::buildPermissions protected function Builds a standard list of taxonomy term permissions for a given vocabulary.
TaxonomyPermissions::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
TaxonomyPermissions::permissions public function Get taxonomy permissions.
TaxonomyPermissions::__construct public function Constructs a TaxonomyPermissions instance.

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