You are here

Home » API reference » Webform 8.5 » WebformAccessGroupListBuilder.php

class WebformAccessGroupListBuilder in Webform 8.5

Same name and namespace in other branches
  1. 6.x modules/webform_access/src/WebformAccessGroupListBuilder.php \Drupal\webform_access\WebformAccessGroupListBuilder

Defines a class to build a listing of webform access group entities.

Hierarchy

Expanded class hierarchy of WebformAccessGroupListBuilder

See also

\Drupal\webform\Entity\WebformOption

File

modules/webform_access/src/WebformAccessGroupListBuilder.php, line 22

Namespace

Drupal\webform_access
View source 
class WebformAccessGroupListBuilder extends ConfigEntityListBuilder {

  /**
   * {@inheritdoc}
   */
  protected $limit = FALSE;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

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

  /**
   * Constructs a new WebformListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage class.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, AccountInterface $current_user, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($entity_type, $storage);
    $this->currentUser = $current_user;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('current_user'), $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = [];

    // Filter form.
    $build['filter_form'] = $this
      ->buildFilterForm();

    // Display info.
    $build['info'] = $this
      ->buildInfo();

    // Table.
    $build += parent::render();
    $build['table']['#sticky'] = TRUE;
    $build['table']['#attributes']['class'][] = 'webform-access-group-table';

    // Attachments.
    $build['#attached']['library'][] = 'webform/webform.admin';
    $build['#attached']['library'][] = 'webform/webform.admin.dialog';
    return $build;
  }

  /**
   * Build the filter form.
   *
   * @return array
   *   A render array representing the filter form.
   */
  protected function buildFilterForm() {
    return [
      '#type' => 'search',
      '#title' => $this
        ->t('Filter'),
      '#title_display' => 'invisible',
      '#size' => 30,
      '#placeholder' => $this
        ->t('Filter by keyword.'),
      '#attributes' => [
        'class' => [
          'webform-form-filter-text',
        ],
        'data-element' => '.webform-access-group-table',
        'data-summary' => '.webform-access-group-summary',
        'data-item-singlular' => $this
          ->t('access group'),
        'data-item-plural' => $this
          ->t('access groups'),
        'title' => $this
          ->t('Enter a keyword to filter by.'),
        'autofocus' => 'autofocus',
      ],
    ];
  }

  /**
   * Build information summary.
   *
   * @return array
   *   A render array representing the information summary.
   */
  protected function buildInfo() {
    $total = $this
      ->getStorage()
      ->getQuery()
      ->count()
      ->execute();
    if (!$total) {
      return [];
    }
    return [
      '#markup' => $this
        ->formatPlural($total, '@total access group', '@total access groups', [
        '@total' => $total,
      ]),
      '#prefix' => '<div class="webform-access-group-summary">',
      '#suffix' => '</div>',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header = [];
    $header['label'] = $this
      ->t('Label/Description');
    $header['type'] = [
      'data' => $this
        ->t('Type'),
      'class' => [
        RESPONSIVE_PRIORITY_MEDIUM,
      ],
    ];
    $header['users'] = [
      'data' => $this
        ->t('Users'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    $header['entities'] = [
      'data' => $this
        ->t('Nodes'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    $header['permissions'] = [
      'data' => $this
        ->t('Permissions'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    $header['admins'] = [
      'data' => $this
        ->t('Admins'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    $header['emails'] = [
      'data' => $this
        ->t('Emails'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {

    /** @var \Drupal\webform_access\WebformAccessGroupInterface $entity */

    // Label/Description.
    $row['label'] = [
      'data' => [
        'label' => $entity
          ->toLink($entity
          ->label(), 'edit-form')
          ->toRenderable() + [
          '#suffix' => '<br/>',
        ],
        'description' => WebformHtmlEditor::checkMarkup($entity
          ->get('description')),
      ],
    ];

    // Type.
    $row['type'] = $entity
      ->getTypeLabel();

    // Users.
    $row['users'] = [
      'data' => static::buildUserAccounts($entity
        ->getUserIds()),
    ];

    // Entities.
    $row['entities'] = [
      'data' => static::buildEntities($entity
        ->getEntityIds()),
    ];

    // Permissions.
    $row['permissions'] = [
      'data' => static::buildPermissions($entity
        ->get('permissions')),
    ];

    // Admins.
    $row['admins'] = [
      'data' => static::buildUserAccounts($entity
        ->getAdminIds()),
    ];

    // Emails.
    $row['emails'] = [
      'data' => static::buildEmails($entity
        ->getEmails()),
    ];
    $row = $row + parent::buildRow($entity);
    return [
      'data' => $row,
      'class' => [
        'webform-form-filter-text-source',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity, $type = 'edit') {
    $operations = parent::getDefaultOperations($entity);
    if ($entity
      ->access('duplicate')) {
      $operations['duplicate'] = [
        'title' => $this
          ->t('Duplicate'),
        'weight' => 23,
        'url' => Url::fromRoute('entity.webform_access_group.duplicate_form', [
          'webform_access_group' => $entity
            ->id(),
        ]),
      ];
    }
    if (isset($operations['delete'])) {
      $operations['delete']['attributes'] = WebformDialogHelper::getModalDialogAttributes(WebformDialogHelper::DIALOG_NARROW);
    }

    // Changed 'Edit' button label to 'Manage' which better reflects the
    // operation.
    if (!$this->currentUser
      ->hasPermission('administer webform')) {
      $operations['edit']['title'] = $this
        ->t('Manage');
    }
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOperations(EntityInterface $entity) {
    return parent::buildOperations($entity) + [
      '#prefix' => '<div class="webform-dropbutton">',
      '#suffix' => '</div>',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function load() {
    $entity_ids = $this
      ->getEntityIds();

    /* @var $entities \Drupal\webform\WebformInterface[] */
    $entities = $this->storage
      ->loadMultiple($entity_ids);

    // If the user is not a webform admin, check access to each access group.
    if (!$this->currentUser
      ->hasPermission('administer webform')) {
      foreach ($entities as $entity_id => $entity) {
        if (!$entity
          ->access('update', $this->currentUser)) {
          unset($entities[$entity_id]);
        }
      }
    }
    return $entities;
  }

  /****************************************************************************/

  // Helper methods.

  /****************************************************************************/

  /**
   * Build a renderable array of email addresses.
   *
   * @param array $emails
   *   The email addresses to be rendered.
   *
   * @return array
   *   A renderable array of email addresses.
   */
  public static function buildEmails(array $emails) {
    return [
      '#theme' => 'item_list',
      '#items' => $emails,
    ];
  }

  /**
   * Build a renderable array of user accounts.
   *
   * @param array $uids
   *   The user ids to be rendered.
   *
   * @return array
   *   A renderable array of user accounts.
   */
  public static function buildUserAccounts(array $uids) {

    /** @var \Drupal\user\UserInterface[] $users */
    $users = $uids ? User::loadMultiple($uids) : [];
    $items = [];
    foreach ($users as $user) {
      $items[] = $user
        ->toLink();
    }
    return [
      '#theme' => 'item_list',
      '#items' => $items,
    ];
  }

  /**
   * Build a renderable array of entities.
   *
   * @param array $entity_references
   *   The entity references (i.e. entity_type:entity_id) to be rendered.
   *
   * @return array
   *   A renderable array of entities.
   */
  public static function buildEntities(array $entity_references) {
    $items = [];
    foreach ($entity_references as $entity_reference) {
      list($entity_type, $entity_id, $field_name, $webform_id) = explode(':', $entity_reference);
      $entity = \Drupal::entityTypeManager()
        ->getStorage($entity_type)
        ->load($entity_id);
      $webform = \Drupal::entityTypeManager()
        ->getStorage('webform')
        ->load($webform_id);
      if ($entity && $webform) {
        $items[] = [
          'source_entity' => $entity
            ->toLink()
            ->toRenderable(),
          'webform' => [
            '#prefix' => '<br/>',
            '#markup' => $webform
              ->label(),
          ],
        ];
      }
    }
    return [
      '#theme' => 'item_list',
      '#items' => $items,
    ];
  }

  /**
   * Build a renderable array of permissions.
   *
   * @param array $permissions
   *   The permissions to be rendered.
   *
   * @return array
   *   A renderable array of permissions.
   */
  public static function buildPermissions(array $permissions) {
    $permissions = array_intersect_key([
      'create' => t('Create submissions'),
      'view_any' => t('View any submissions'),
      'update_any' => t('Update any submissions'),
      'delete_any' => t('Delete any submissions'),
      'purge_any' => t('Purge any submissions'),
      'view_own' => t('View own submissions'),
      'update_own' => t('Update own submissions'),
      'delete_own' => t('Delete own submissions'),
      'administer' => t('Administer submissions'),
      'test' => t('Test webform'),
    ], array_flip($permissions));
    return [
      '#theme' => 'item_list',
      '#items' => $permissions,
    ];
  }

}

Members

Namesort descending 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
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityListBuilder::$entityType protected property Information about the entity type.
EntityListBuilder::$entityTypeId protected property The entity type ID.
EntityListBuilder::$storage protected property The entity storage class. 1
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL.
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 4
EntityListBuilder::getLabel Deprecated protected function Gets the label of an entity.
EntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations 2
EntityListBuilder::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle protected function Gets the title of the page. 1
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
WebformAccessGroupListBuilder::$currentUser protected property The current user.
WebformAccessGroupListBuilder::$entityTypeManager protected property The entity type manager.
WebformAccessGroupListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities. Overrides EntityListBuilder::$limit
WebformAccessGroupListBuilder::buildEmails public static function Build a renderable array of email addresses.
WebformAccessGroupListBuilder::buildEntities public static function Build a renderable array of entities.
WebformAccessGroupListBuilder::buildFilterForm protected function Build the filter form.
WebformAccessGroupListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
WebformAccessGroupListBuilder::buildInfo protected function Build information summary.
WebformAccessGroupListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. Overrides EntityListBuilder::buildOperations
WebformAccessGroupListBuilder::buildPermissions public static function Build a renderable array of permissions.
WebformAccessGroupListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
WebformAccessGroupListBuilder::buildUserAccounts public static function Build a renderable array of user accounts.
WebformAccessGroupListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
WebformAccessGroupListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
WebformAccessGroupListBuilder::load public function Loads entities of this type from storage for listing. Overrides ConfigEntityListBuilder::load
WebformAccessGroupListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
WebformAccessGroupListBuilder::__construct public function Constructs a new WebformListBuilder object. Overrides EntityListBuilder::__construct