You are here

Home » API reference » Automatic IP ban (Autoban) 8 » AutobanListBuilder.php

class AutobanListBuilder in Automatic IP ban (Autoban) 8

Provides a listing of autoban entities.

@package Drupal\autoban\Controller

Hierarchy

Expanded class hierarchy of AutobanListBuilder

File

src/Controller/AutobanListBuilder.php, line 20

Namespace

Drupal\autoban\Controller
View source 
class AutobanListBuilder extends ConfigEntityListBuilder {
  use RedirectDestinationTrait;

  /**
   * Autoban provider list.
   *
   * @var array
   */
  private $banProviderList = NULL;

  /**
   * The autoban object.
   *
   * @var \Drupal\autoban\Controller\AutobanController
   */
  protected $autoban;

  /**
   * Construct the AutobanListBuilder.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage class.
   * @param \Drupal\autoban\Controller\AutobanController $autoban
   *   Autoban object.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, AutobanController $autoban) {
    parent::__construct($entity_type, $storage);
    $this->autoban = $autoban;
  }

  /**
   * {@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('autoban'));
  }

  /**
   * Get ban providers list.
   *
   * @return array
   *   An array ban providers name.
   */
  private function getBanProvidersList() {
    $controller = $this->autoban;
    $providers = [];
    $banManagerList = $controller
      ->getBanProvidersList();
    if (!empty($banManagerList)) {
      foreach ($banManagerList as $id => $item) {
        $providers[$id] = $item['name'];
      }
    }
    return $providers;
  }

  /**
   * Builds the header row for the entity listing.
   *
   * @return array
   *   A render array structure of header strings.
   *
   * @see Drupal\Core\Entity\EntityListController::render()
   */
  public function buildHeader() {
    $header['id'] = $this
      ->t('Id');
    $header['type'] = $this
      ->t('Type');
    $header['message'] = $this
      ->t('Message pattern');
    $header['referer'] = $this
      ->t('Referrer');
    $header['threshold'] = $this
      ->t('Threshold');
    $header['user_type'] = $this
      ->t('User type');
    $header['provider'] = $this
      ->t('Provider');
    return $header + parent::buildHeader();
  }

  /**
   * Builds a row for an entity in the entity listing.
   *
   * @param Drupal\Core\Entity\EntityInterface $entity
   *   The entity for which to build the row.
   *
   * @return array
   *   A render array of the table row for displaying the entity.
   *
   * @see Drupal\Core\Entity\EntityListController::render()
   */
  public function buildRow(EntityInterface $entity) {
    $row['id'] = $entity
      ->id();
    $row['type'] = $entity->type;
    $row['message'] = $entity->message;
    $row['referer'] = $entity->referer;
    $row['threshold'] = $entity->threshold;
    $controller = $this->autoban;
    $row['user_type'] = $controller
      ->userTypeList($entity->user_type ?: 0);
    if (!$this->banProviderList) {
      $this->banProviderList = $this
        ->getBanProvidersList();
    }
    if (!empty($this->banProviderList) && isset($this->banProviderList[$entity->provider])) {
      $row['provider'] = $this->banProviderList[$entity->provider];
    }
    else {

      // If ban provider module is disabled.
      $row['provider'] = $this
        ->t('Inactive provider %provider', [
        '%provider' => $entity->provider,
      ]);
    }
    return $row + parent::buildRow($entity);
  }

  /**
   * Operations list in the entity listing.
   *
   * @param Drupal\Core\Entity\EntityInterface $entity
   *   The entity for which to build the row.
   *
   * @return array
   *   A render array of the operations.
   */
  public function getOperations(EntityInterface $entity) {
    $operations = $this
      ->getDefaultOperations($entity);
    $rule = $entity
      ->id();
    $destination = $this
      ->getDestinationArray();
    $operations['test'] = [
      'title' => $this
        ->t('Test'),
      'url' => Url::fromRoute('autoban.test', [
        'rule' => $rule,
      ], [
        'query' => $destination,
      ]),
      'weight' => 20,
    ];
    $operations['ban'] = [
      'title' => $this
        ->t('Ban'),
      'url' => Url::fromRoute('autoban.ban', [
        'rule' => $rule,
      ], [
        'query' => $destination,
      ]),
      'weight' => 30,
    ];
    $operations['clone'] = [
      'title' => $this
        ->t('Clone'),
      'url' => Url::fromRoute('entity.autoban.add_form', [
        'rule' => $rule,
      ], [
        'query' => $destination,
      ]),
      'weight' => 40,
    ];
    uasort($operations, '\\Drupal\\Component\\Utility\\SortArray::sortByWeightElement');
    return $operations;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AutobanListBuilder::$autoban protected property The autoban object.
AutobanListBuilder::$banProviderList private property Autoban provider list.
AutobanListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
AutobanListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
AutobanListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
AutobanListBuilder::getBanProvidersList private function Get ban providers list.
AutobanListBuilder::getOperations public function Operations list in the entity listing. Overrides EntityListBuilder::getOperations
AutobanListBuilder::__construct public function Construct the AutobanListBuilder. Overrides EntityListBuilder::__construct
ConfigEntityListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations 15
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
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::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::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle protected function Gets the title of the page. 1
EntityListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render 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.