FilterPermissions.php

Same filename in other branches
  1. 8.9.x core/modules/filter/src/FilterPermissions.php
  2. 10 core/modules/filter/src/FilterPermissions.php
  3. 11.x core/modules/filter/src/FilterPermissions.php

Namespace

Drupal\filter

File

core/modules/filter/src/FilterPermissions.php

View source
<?php

namespace Drupal\filter;

use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides dynamic permissions of the filter module.
 */
class FilterPermissions implements ContainerInjectionInterface {
    use StringTranslationTrait;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * Constructs a new FilterPermissions 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'));
    }
    
    /**
     * Returns an array of filter permissions.
     *
     * @return array
     */
    public function permissions() {
        $permissions = [];
        // Generate permissions for each text format. Warn the administrator that any
        // of them are potentially unsafe.
        
        /** @var \Drupal\filter\FilterFormatInterface[] $formats */
        $formats = $this->entityTypeManager
            ->getStorage('filter_format')
            ->loadByProperties([
            'status' => TRUE,
        ]);
        uasort($formats, 'Drupal\\Core\\Config\\Entity\\ConfigEntityBase::sort');
        foreach ($formats as $format) {
            if ($permission = $format->getPermissionName()) {
                $permissions[$permission] = [
                    'title' => $this->t('Use the <a href=":url">@label</a> text format', [
                        ':url' => $format->toUrl()
                            ->toString(),
                        '@label' => $format->label(),
                    ]),
                    'description' => [
                        '#prefix' => '<em>',
                        '#markup' => $this->t('Warning: This permission may have security implications depending on how the text format is configured.'),
                        '#suffix' => '</em>',
                    ],
                    // This permission is generated on behalf of $format text format,
                    // therefore add this text format as a config dependency.
'dependencies' => [
                        $format->getConfigDependencyKey() => [
                            $format->getConfigDependencyName(),
                        ],
                    ],
                ];
            }
        }
        return $permissions;
    }

}

Classes

Title Deprecated Summary
FilterPermissions Provides dynamic permissions of the filter module.

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