You are here

Home » API reference » Private files download permission 8.2 » DirectoryListBuilder.php

class DirectoryListBuilder in Private files download permission 8.2

Same name and namespace in other branches
  1. 3.x src/DirectoryListBuilder.php \Drupal\pfdp\DirectoryListBuilder

Defines a class to build a list of Private files download permission directory entities.

Hierarchy

Expanded class hierarchy of DirectoryListBuilder

File

src/DirectoryListBuilder.php, line 17

Namespace

Drupal\pfdp
View source 
class DirectoryListBuilder extends ConfigEntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function render() {
    $settings = \Drupal::config('pfdp.settings');

    // Prepare the information render array.
    $information = [];
    $information['margin'] = [
      '#markup' => '<p />',
    ];

    // Check if the file system download method is set to private.
    if ('private' !== \Drupal::config('system.file')
      ->get('default_scheme')) {
      \Drupal::messenger()
        ->addWarning($this
        ->t('Your @default_download_method is not set to private. Please keep in mind that these settings only affect private file system downloads.', [
        '@default_download_method' => Link::fromTextAndUrl('default download method', Url::fromRoute('system.file_system_settings'))
          ->toString(),
      ]));
    }

    // Check the private file system path.
    $private_file_system_path = Settings::get('file_private_path');
    if (!$private_file_system_path) {
      \Drupal::messenger()
        ->addWarning($this
        ->t('Your private file system path is not set.'));
    }
    else {
      $information['private_file_system_path'] = [
        '#markup' => '<p>' . $this
          ->t('Your private file system path is set to %path.', [
          '%path' => $private_file_system_path,
        ]) . '</p>',
      ];
    }

    // Check if by-user checks are enabled.
    if (!$settings
      ->get('by_user_checks')) {
      $information['by_user_checks'] = [
        '#markup' => '<p>' . $this
          ->t('@by_user_checks are not enabled.', [
          '@by_user_checks' => Link::fromTextAndUrl('By-user checks', Url::fromRoute('pfdp.settings'))
            ->toString(),
        ]) . '</p>',
      ];
    }

    // Return the render array.
    return $information + parent::render();
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {

    // Prepare the table header.
    $header = [];
    $header['id'] = $this
      ->t('Id');
    $header['path'] = $this
      ->t('Directory path');
    $header['bypass'] = $this
      ->t('Bypass');
    $header['users'] = $this
      ->t('Enabled users');
    $header['roles'] = $this
      ->t('Enabled roles');

    // Return the table header.
    return $header + parent::buildHeader();
  }

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

    // Prepare the table row for the directory.
    $row = [];
    $row['id'] = $pfdp_directory
      ->id();
    $row['path'] = $pfdp_directory->path;
    $row['bypass'] = $pfdp_directory->bypass ? $this
      ->t('Yes') : '';
    $row['users'] = implode(', ', array_map(function ($uid) {
      $user = User::load($uid);
      return $user ? $user
        ->label() : NULL;
    }, pfdp_get_proper_user_array($pfdp_directory->users)));
    if ($pfdp_directory->grant_file_owners) {
      $row['users'] = $this
        ->t('File owners') . ', ' . $row['users'];
    }
    if (', ' == mb_substr($row['users'], -2, 2)) {
      $row['users'] = mb_substr($row['users'], 0, -2);
    }
    $row['roles'] = implode(', ', array_map(function ($rid) {
      $role = Role::load($rid);
      return $role ? $role
        ->label() : NULL;
    }, $pfdp_directory->roles));
    if (', ' == mb_substr($row['roles'], -2, 2)) {
      $row['roles'] = mb_substr($row['roles'], 0, -2);
    }

    // Return the table row.
    return $row + parent::buildRow($pfdp_directory);
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity) {
    $pfdp_directory = $entity;

    // Prepare the table row operations for the directory.
    $operations = parent::getDefaultOperations($pfdp_directory);
    if ($pfdp_directory
      ->hasLinkTemplate('edit')) {
      $operations['edit'] = [
        'title' => t('Edit directory'),
        'weight' => 20,
        'url' => $pfdp_directory
          ->toUrl('edit'),
      ];
    }
    if ($pfdp_directory
      ->hasLinkTemplate('delete')) {
      $operations['delete'] = [
        'title' => t('Delete directory'),
        'weight' => 40,
        'url' => $pfdp_directory
          ->toUrl('delete'),
      ];
    }

    // Return the table row operations.
    return $operations;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load 7
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
DirectoryListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
DirectoryListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
DirectoryListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
DirectoryListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
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::$limit protected property The number of entities to list per page, or FALSE to list all entities. 3
EntityListBuilder::$storage protected property The entity storage class. 1
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance 20
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
EntityListBuilder::__construct public function Constructs a new EntityListBuilder object. 16
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.