class PermissionsGenerator in Entity Construction Kit (ECK) 8

Defines dynamic permissions.

Hierarchy

• class \Drupal\eck\PermissionsGenerator uses StringTranslationTrait

1 file declares its use of PermissionsGenerator

PermissionsGeneratorTest.php in tests/src/Unit/PermissionsGeneratorTest.php

File

src/PermissionsGenerator.php, line 13

Namespace

Drupal\eck

class PermissionsGenerator {
  use StringTranslationTrait;

  /**
   * Returns an array of entity type permissions.
   *
   * @return array
   *   The permissions.
   */
  public function entityPermissions() {
    $perms = [];

    // Generate entity permissions for all entity types.
    foreach (EckEntityType::loadMultiple() as $eck_type) {
      $perms = array_merge($perms, $this
        ->buildPermissions($eck_type));
    }
    return $perms;
  }

  /**
   * Builds a standard list of entity permissions for a given type.
   *
   * @param \Drupal\eck\Entity\EckEntityType $eck_type
   *   The entity type.
   *
   * @return array
   *   An array of permissions.
   */
  private function buildPermissions(EckEntityType $eck_type) {
    return array_merge($this
      ->getCreatePermission($eck_type), $this
      ->getEditPermissions($eck_type), $this
      ->getListingPermission($eck_type));
  }

  /**
   * Retrieves the listing permission for a given entity type.
   *
   * @param \Drupal\eck\Entity\EckEntityType $entity_type
   *   The entity type.
   *
   * @return array
   *   The listing permission.
   */
  private function getListingPermission(EckEntityType $entity_type) {
    return [
      "access {$entity_type->id()} entity listing" => [
        'title' => $this
          ->t('Access %type_name listing page', [
          '%type_name' => $entity_type
            ->label(),
        ]),
      ],
    ];
  }

  /**
   * Retrieves the create permission for a given entity type.
   *
   * @param \Drupal\eck\Entity\EckEntityType $entity_type
   *   The entity type.
   *
   * @return array
   *   The create permission.
   */
  private function getCreatePermission(EckEntityType $entity_type) {
    return [
      "create {$entity_type->id()} entities" => [
        'title' => $this
          ->t('Create new %type_name entities', [
          '%type_name' => $entity_type
            ->label(),
        ]),
      ],
    ];
  }

  /**
   * Retrieves the edit permissions for a given entity type.
   *
   * @param \Drupal\eck\Entity\EckEntityType $entity_type
   *   The entity type.
   *
   * @return array
   *   The edit permission.
   */
  private function getEditPermissions(EckEntityType $entity_type) {
    $permissions = [];
    foreach ([
      'edit',
      'delete',
      'view',
    ] as $op) {
      $permissions = array_merge($permissions, $this
        ->getEditPermission($entity_type, $op, 'any'));
      if ($entity_type
        ->hasAuthorField()) {
        $permissions = array_merge($permissions, $this
          ->getEditPermission($entity_type, $op, 'own'));
      }
    }
    return $permissions;
  }

  /**
   * Retrieves the edit permission for a given entity type.
   *
   * @param \Drupal\eck\Entity\EckEntityType $entity_type
   *   The entity type.
   * @param string $op
   *   The operation.
   * @param string $ownership
   *   The ownership.
   *
   * @return array
   *   The edit permission.
   */
  private function getEditPermission(EckEntityType $entity_type, $op, $ownership) {
    $ucfirst_op = ucfirst($op);
    return [
      "{$op} {$ownership} {$entity_type->id()} entities" => [
        'title' => $this
          ->t("{$ucfirst_op} {$ownership} %type_name entities", [
          '%type_name' => $entity_type
            ->label(),
        ]),
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PermissionsGenerator::buildPermissions	private	function	Builds a standard list of entity permissions for a given type.
PermissionsGenerator::entityPermissions	public	function	Returns an array of entity type permissions.
PermissionsGenerator::getCreatePermission	private	function	Retrieves the create permission for a given entity type.
PermissionsGenerator::getEditPermission	private	function	Retrieves the edit permission for a given entity type.
PermissionsGenerator::getEditPermissions	private	function	Retrieves the edit permissions for a given entity type.
PermissionsGenerator::getListingPermission	private	function	Retrieves the listing permission for a given entity type.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.