You are here

class OpignoModuleListBuilder in Opigno module 8

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

Defines a class to build a listing of Module entities.

Hierarchy

Expanded class hierarchy of OpignoModuleListBuilder

File

src/OpignoModuleListBuilder.php, line 16

Namespace

Drupal\opigno_module
View source
class OpignoModuleListBuilder extends EntityListBuilder {

  /**
   * Returns module list.
   */
  protected function getEntities() {
    $query = $this
      ->getStorage()
      ->getQuery()
      ->sort($this->entityType
      ->getKey('id'));
    $ids = $query
      ->execute();

    // Filter entities that user has edit access.
    $entities = OpignoModule::loadMultiple($ids);
    $entities = array_filter($entities, function ($entity) {
      return $entity
        ->access('update');
    });
    return $entities;
  }

  /**
   * Returns modules count.
   */
  protected function getTotalCount() {
    return count($this
      ->getEntities());
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntityIds() {
    $ids = array_keys($this
      ->getEntities());

    // Only add the pager if a limit is specified.
    if ($this->limit) {
      $page = \Drupal::request()->query
        ->get('page', 0);
      $limit = $this->limit;
      $start = $limit * $page;
      $ids = array_slice($ids, $start, $limit);
    }
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $pager_manager = \Drupal::service('pager.manager');
    $pager_manager
      ->createPager($this
      ->getTotalCount(), $this->limit);
    $build = parent::render();
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['id'] = $this
      ->t('Module ID');
    $header['name'] = $this
      ->t('Name');
    return $header + parent::buildHeader();
  }

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

    /* @var $entity \Drupal\opigno_module\Entity\OpignoModule */
    $row['id'] = $entity
      ->id();
    $row['name'] = Link::createFromRoute($entity
      ->label(), 'opigno_module.edit', [
      'opigno_module' => $entity
        ->id(),
    ]);

    // Change default edit link.
    $ops = parent::buildRow($entity);
    $destination = $_SERVER['REQUEST_URI'];
    $ops['operations']['data']['#links']['edit']['url'] = new Url('opigno_module.edit', [
      'opigno_module' => $entity
        ->id(),
    ], [
      'query' => [
        'destination' => $destination,
      ],
    ]);
    return $row + $ops;
  }

}

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::$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::getDefaultOperations protected function Gets this list's default operations. 2
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::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load 4
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.
OpignoModuleListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
OpignoModuleListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
OpignoModuleListBuilder::getEntities protected function Returns module list.
OpignoModuleListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. Overrides EntityListBuilder::getEntityIds
OpignoModuleListBuilder::getTotalCount protected function Returns modules count.
OpignoModuleListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
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.