class RoleSectionStorage in Workbench Access 8

Defines a role-section storage that uses the State API.

Hierarchy

• class \Drupal\workbench_access\RoleSectionStorage implements RoleSectionStorageInterface uses DependencySerializationTrait

1 string reference to 'RoleSectionStorage'

workbench_access.services.yml in ./workbench_access.services.yml

workbench_access.services.yml

1 service uses RoleSectionStorage

workbench_access.role_section_storage in ./workbench_access.services.yml

Drupal\workbench_access\RoleSectionStorage

File

src/RoleSectionStorage.php, line 14

Namespace

Drupal\workbench_access

class RoleSectionStorage implements RoleSectionStorageInterface {
  use DependencySerializationTrait;

  /**
   * State.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * Role storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $roleStorage;

  /**
   * Constructs a new RoleSectionStorage object.
   *
   * @param \Drupal\Core\State\StateInterface $state
   *   State service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   Entity type manager.
   */
  public function __construct(StateInterface $state, EntityTypeManagerInterface $entityTypeManager) {
    $this->state = $state;
    $this->entityTypeManager = $entityTypeManager;
    $this->roleStorage = $entityTypeManager
      ->getStorage('user_role');
  }

  /**
   * Gets section storage.
   *
   * @return \Drupal\workbench_access\SectionAssociationStorageInterface
   *   Section storage.
   */
  protected function sectionStorage() {

    // The entity build process takes place too early in the call stack and we
    // have test fails if we add this to the __construct().
    return $this->entityTypeManager
      ->getStorage('section_association');
  }

  /**
   * {@inheritdoc}
   */
  public function addRole(AccessSchemeInterface $scheme, $role_id, array $sections = []) {
    foreach ($sections as $id) {
      if ($section_association = $this
        ->sectionStorage()
        ->loadSection($scheme
        ->id(), $id)) {
        if ($new_values = $section_association
          ->getCurrentRoleIds()) {
          $new_values[] = $role_id;
          $section_association
            ->set('role_id', array_unique($new_values));
        }
        else {
          $section_association
            ->set('role_id', [
            $role_id,
          ]);
        }
        $section_association
          ->setNewRevision();
      }
      else {
        $values = [
          'access_scheme' => $scheme
            ->id(),
          'section_id' => $id,
          'role_id' => [
            $role_id,
          ],
        ];
        $section_association = $this
          ->sectionStorage()
          ->create($values);
      }
      $section_association
        ->save();
      \Drupal::service('workbench_access.user_section_storage')
        ->resetCache($scheme);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function removeRole(AccessSchemeInterface $scheme, $role_id, array $sections = []) {
    foreach ($sections as $id) {
      $new_values = [];
      if ($section_association = $this
        ->sectionStorage()
        ->loadSection($scheme
        ->id(), $id)) {
        if ($values = $section_association
          ->getCurrentRoleIds()) {
          foreach ($values as $delta => $value) {
            if ($value != $role_id) {
              $new_values[] = $value;
            }
          }
          $section_association
            ->set('role_id', array_unique($new_values));
        }
        $section_association
          ->save();
      }
      \Drupal::service('workbench_access.user_section_storage')
        ->resetCache($scheme);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getRoleSections(AccessSchemeInterface $scheme, AccountInterface $account = NULL) {
    $sections = [];
    if ($account) {
      $results = $this
        ->sectionStorage()
        ->loadByProperties([
        'role_id' => $account
          ->getRoles(),
        'access_scheme' => $scheme
          ->id(),
      ]);
      foreach ($results as $result) {
        $sections[] = $result
          ->get('section_id')->value;
      }
    }
    return $sections;
  }

  /**
   * {@inheritdoc}
   */
  public function getPotentialRoles($id) {
    $list = [];
    $roles = $this->roleStorage
      ->loadMultiple();
    foreach ($roles as $rid => $role) {
      $list[$rid] = $role
        ->label();
    }
    return $list;
  }

  /**
   * {@inheritdoc}
   */
  public function getPotentialRolesFiltered($id) {
    $list = [];
    $roles = $this->roleStorage
      ->loadMultiple();
    foreach ($roles as $rid => $role) {
      if ($role
        ->hasPermission('use workbench access')) {
        $list[$rid] = $role
          ->label();
      }
    }
    return $list;
  }

  /**
   * {@inheritdoc}
   */
  public function getRoles(AccessSchemeInterface $scheme, $id) {
    $roles = [];
    $query = $this
      ->sectionStorage()
      ->getAggregateQuery()
      ->condition('access_scheme', $scheme
      ->id())
      ->condition('section_id', $id)
      ->groupBy('role_id.target_id')
      ->execute();
    $rids = array_column($query, 'role_id_target_id');
    if (!empty(current($rids))) {
      $roles = $this->roleStorage
        ->loadMultiple($rids);
    }

    // @TODO: filter by permission?
    return array_keys($roles);
  }

  /**
   * Saves the role sections for a given role ID.
   *
   * @param \Drupal\workbench_access\Entity\AccessSchemeInterface $scheme
   *   Access scheme.
   * @param string $role_id
   *   The role ID.
   * @param array $settings
   *   Sections for the role.
   *
   * @TODO: refactor.
   */
  public function saveRoleSections(AccessSchemeInterface $scheme, $role_id, array $settings = []) {
  }

  /**
   * Delete the saved sections for this role.
   *
   * @param \Drupal\workbench_access\Entity\AccessSchemeInterface $scheme
   *   Access scheme.
   * @param string $role_id
   *   The role ID.
   */
  public function deleteRoleSections(AccessSchemeInterface $scheme, $role_id) {
    $section_ids = [];
    if ($sections = $this
      ->sectionStorage()
      ->loadByProperties([
      'role_id' => $role_id,
    ])) {
      foreach ($sections as $section) {
        $section_ids[] = $section
          ->get('section_id')->value;
      }
      $this
        ->removeRole($scheme, $role_id, $section_ids);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
RoleSectionStorage::$roleStorage	protected	property	Role storage.
RoleSectionStorage::$state	protected	property	State.
RoleSectionStorage::addRole	public	function	Adds a set of sections to a role. Overrides RoleSectionStorageInterface::addRole
RoleSectionStorage::deleteRoleSections	public	function	Delete the saved sections for this role.
RoleSectionStorage::getPotentialRoles	public	function	Gets a list of potential roles. Overrides RoleSectionStorageInterface::getPotentialRoles
RoleSectionStorage::getPotentialRolesFiltered	public	function	Gets a list of potential roles for assigning users. Overrides RoleSectionStorageInterface::getPotentialRolesFiltered
RoleSectionStorage::getRoles	public	function	Gets a list of roles assigned to a section. Overrides RoleSectionStorageInterface::getRoles
RoleSectionStorage::getRoleSections	public	function	Gets the sections assigned to a user by way of their roles. Overrides RoleSectionStorageInterface::getRoleSections
RoleSectionStorage::removeRole	public	function	Removes a set of sections from a role. Overrides RoleSectionStorageInterface::removeRole
RoleSectionStorage::saveRoleSections	public	function	Saves the role sections for a given role ID.
RoleSectionStorage::sectionStorage	protected	function	Gets section storage.
RoleSectionStorage::__construct	public	function	Constructs a new RoleSectionStorage object.