class UserSectionStorage in Workbench Access 8

Defines a class for storing and retrieving sections assigned to a user.

Hierarchy

class \Drupal\workbench_access\UserSectionStorage implements UserSectionStorageInterface

Expanded class hierarchy of UserSectionStorage

1 file declares its use of UserSectionStorage

UserSectionStorageUnitTest.php in tests/src/Unit/UserSectionStorageUnitTest.php

1 string reference to 'UserSectionStorage'

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

1 service uses UserSectionStorage

workbench_access.user_section_storage in ./workbench_access.services.yml: Drupal\workbench_access\UserSectionStorage

File

src/UserSectionStorage.php, line 13

Namespace

Drupal\workbench_access

View source

class UserSectionStorage implements UserSectionStorageInterface {

  /**
   * Static cache to prevent recalculation of sections for a user in a request.
   *
   * @var array
   */
  protected $userSectionCache;

  /**
   * Current user service.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * Role section storage service.
   *
   * @var \Drupal\workbench_access\RoleSectionStorageInterface
   */
  protected $roleSectionStorage;

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

  /**
   * Constructs a new UserSectionStorage object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   Entity type manager.
   * @param \Drupal\Core\Session\AccountInterface $currentUser
   *   Current user.
   * @param \Drupal\workbench_access\RoleSectionStorageInterface $role_section_storage
   *   Role section storage.
   */
  public function __construct(EntityTypeManagerInterface $entityTypeManager, AccountInterface $currentUser, RoleSectionStorageInterface $role_section_storage) {
    $this->currentUser = $currentUser;
    $this->entityTypeManager = $entityTypeManager;
    $this->roleSectionStorage = $role_section_storage;
  }

  /**
   * Gets section storage.
   *
   * @return \Drupal\Core\Entity\EntityStorageInterface
   *   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 getUserSections(AccessSchemeInterface $scheme, AccountInterface $account = NULL, $add_roles = TRUE) {

    // Get the information from the account.
    if (!$account) {
      $account = $this->currentUser;
    }
    if (!isset($this->userSectionCache[$scheme
      ->id()][$account
      ->id()])) {
      $user_sections = $this
        ->loadUserSections($scheme, $account);

      // Merge in role data.
      if ($add_roles) {
        $user_sections = array_merge($user_sections, $this->roleSectionStorage
          ->getRoleSections($scheme, $account));
      }
      $this->userSectionCache[$scheme
        ->id()][$account
        ->id()] = $user_sections;
    }
    return $this->userSectionCache[$scheme
      ->id()][$account
      ->id()];
  }

  /**
   * {@inheritdoc}
   */
  protected function loadUserSections(AccessSchemeInterface $scheme, AccountInterface $account) {
    $query = $this
      ->sectionStorage()
      ->getAggregateQuery()
      ->condition('access_scheme', $scheme
      ->id())
      ->condition('user_id', $account
      ->id())
      ->groupBy('section_id')
      ->execute();
    $list = array_column($query, 'section_id');
    return $list;
  }

  /**
   * {@inheritdoc}
   */
  public function addUser(AccessSchemeInterface $scheme, AccountInterface $account, array $sections = []) {
    foreach ($sections as $id) {
      if ($section_association = $this
        ->sectionStorage()
        ->loadSection($scheme
        ->id(), $id)) {
        if ($new_values = $section_association
          ->getCurrentUserIds()) {
          $new_values[] = $account
            ->id();
          $section_association
            ->set('user_id', array_unique($new_values));
        }
        else {
          $section_association
            ->set('user_id', [
            $account
              ->id(),
          ]);
        }
        $section_association
          ->setNewRevision();
      }
      else {
        $values = [
          'access_scheme' => $scheme
            ->id(),
          'section_id' => $id,
          'user_id' => [
            $account
              ->id(),
          ],
        ];
        $new_values[] = $account
          ->id();
        $section_association = $this
          ->sectionStorage()
          ->create($values);
      }
      $section_association
        ->save();
      $this
        ->resetCache($scheme, $account
        ->id());
    }

    // Return the user object.
    return $this
      ->userStorage()
      ->load($account
      ->id());
  }

  /**
   * {@inheritdoc}
   */
  public function removeUser(AccessSchemeInterface $scheme, AccountInterface $account, array $sections = []) {
    foreach ($sections as $id) {
      $new_values = [];
      if ($section_association = $this
        ->sectionStorage()
        ->loadSection($scheme
        ->id(), $id)) {
        if ($values = $section_association
          ->getCurrentUserIds()) {
          foreach ($values as $delta => $value) {
            if ($value != $account
              ->id()) {
              $new_values[] = $value;
            }
          }
          $section_association
            ->set('user_id', array_unique($new_values));
        }
        $section_association
          ->save();
      }
    }
    $this
      ->resetCache($scheme, $account
      ->id());

    // Return the user object.
    return $this
      ->userStorage()
      ->load($account
      ->id());
  }

  /**
   * {@inheritdoc}
   */
  public function getEditors(AccessSchemeInterface $scheme, $id) {
    $query = $this
      ->sectionStorage()
      ->getAggregateQuery()
      ->condition('access_scheme', $scheme
      ->id())
      ->condition('section_id', $id)
      ->groupBy('user_id.target_id')
      ->groupBy('user_id.entity.name');
    $data = $query
      ->execute();
    $list = array_column($data, 'name', 'user_id_target_id');

    // $list may return an array with a NULL element, which is not 'empty.'.
    if (current($list)) {
      return $list;
    }
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getPotentialEditors($id) {

    // Get all role IDs that have the configured permissions.
    $roles = user_role_names(FALSE, 'use workbench access');

    // user_role_names() returns an array with the role IDs as keys, so take
    // the array keys and merge them with previously found role IDs.
    $rids = array_keys($roles);
    if (empty($rids)) {
      return [];
    }
    $query = $this
      ->userStorage()
      ->getQuery();
    $query
      ->condition('status', 1)
      ->sort('name');
    if (!in_array(AccountInterface::AUTHENTICATED_ROLE, $rids, TRUE)) {
      $query
        ->condition('roles', $rids, 'IN');
    }
    $users = $query
      ->execute();
    return $users;
  }

  /**
   * {@inheritdoc}
   */
  public function getPotentialEditorsRoles($id) {
    return $this->roleSectionStorage
      ->getPotentialRolesFiltered($id);
  }

  /**
   * Reset the static cache from an external change.
   */
  public function resetCache(AccessSchemeInterface $scheme, $user_id = NULL) {
    if ($user_id && isset($this->userSectionCache[$scheme
      ->id()][$user_id])) {
      unset($this->userSectionCache[$scheme
        ->id()][$user_id]);
    }
    elseif (isset($this->userSectionCache[$scheme
      ->id()])) {
      unset($this->userSectionCache[$scheme
        ->id()]);
    }

    // Invalidate entity access tags that we use.
    // @TODO: we should inject the cache service.
    Cache::invalidateTags([
      'config:workbench_access.access_scheme.' . $scheme
        ->id(),
    ]);
  }

  /**
   * Gets user storage handler.
   *
   * The entity build process takes place too early in the call stack so we
   * end up with a stale reference to the user storage handler if we do this in
   * the constructor.
   *
   * @return \Drupal\Core\Entity\EntityStorageInterface
   *   User storage.
   */
  protected function userStorage() {
    return $this->entityTypeManager
      ->getStorage('user');
  }

}

Members

Name	Modifiers	Type	Description
UserSectionStorage::$currentUser	protected	property	Current user service.
UserSectionStorage::$entityTypeManager	protected	property	Entity type manager.
UserSectionStorage::$roleSectionStorage	protected	property	Role section storage service.
UserSectionStorage::$userSectionCache	protected	property	Static cache to prevent recalculation of sections for a user in a request.
UserSectionStorage::addUser	public	function	Adds a set of sections to a user. Overrides UserSectionStorageInterface::addUser
UserSectionStorage::getEditors	public	function	Gets a list of editors assigned to a section. Overrides UserSectionStorageInterface::getEditors
UserSectionStorage::getPotentialEditors	public	function	Gets a list of editors who may be assigned to a section. Overrides UserSectionStorageInterface::getPotentialEditors
UserSectionStorage::getPotentialEditorsRoles	public	function	Gets a list of editors roles who may be assigned to a section. Overrides UserSectionStorageInterface::getPotentialEditorsRoles
UserSectionStorage::getUserSections	public	function	Gets the editorial sections assigned to a user. Overrides UserSectionStorageInterface::getUserSections
UserSectionStorage::loadUserSections	protected	function
UserSectionStorage::removeUser	public	function	Removes a set of sections to a user. Overrides UserSectionStorageInterface::removeUser
UserSectionStorage::resetCache	public	function	Reset the static cache from an external change.
UserSectionStorage::sectionStorage	protected	function	Gets section storage.
UserSectionStorage::userStorage	protected	function	Gets user storage handler.
UserSectionStorage::__construct	public	function	Constructs a new UserSectionStorage object.

You are here

class UserSectionStorage in Workbench Access 8

Hierarchy

File

Namespace

Members

API Navigation