class HostListBuilder in http:BL 8

Provides a list controller for a host entity.

Hierarchy

class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
  - class \Drupal\httpbl\Entity\Controller\HostListBuilder

Expanded class hierarchy of HostListBuilder

File

src/Entity/Controller/HostListBuilder.php, line 18

Namespace

Drupal\httpbl\Entity\Controller

View source

class HostListBuilder extends EntityListBuilder {

  /**
   * The url generator.
   *
   * @var \Drupal\Core\Routing\UrlGeneratorInterface
   */
  protected $urlGenerator;

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

  /**
   * Constructs a new ContactListBuilder 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\Routing\UrlGeneratorInterface $url_generator
   *   The url generator.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, UrlGeneratorInterface $url_generator) {
    parent::__construct($entity_type, $storage);
    $this->urlGenerator = $url_generator;
  }

  /**
   * {@inheritdoc}
   *
   * We override ::render() so that we can add our own content above the table.
   * parent::render() is where EntityListBuilder creates the table using our
   * buildHeader() and buildRow() implementations.
   */
  public function render() {
    $build['table'] = parent::render();
    return $build;
  }

  /**
   * {@inheritdoc}
   *
   * Building the header and content lines for the contact list.
   *
   * Calling the parent::buildHeader() adds a column for the possible actions
   * and inserts the 'edit' and 'delete' links as defined for the entity type.
   */
  public function buildHeader() {
    $header['id'] = $this
      ->t('hid');
    $header['name'] = $this
      ->t('Host');
    $header['host_status'] = $this
      ->t('Host Status');
    $header['source'] = $this
      ->t('Source');
    $header['expire'] = $this
      ->t('Expires');
    $header['created'] = $this
      ->t('Created');
    $header['changed'] = $this
      ->t('Changed');
    return $header + parent::buildHeader();
  }

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

    /* @var $entity \Drupal\httpbl\Entity\Host */
    $row['id'] = $entity
      ->id();

    //$row['name'] = $entity->link();

    // We don't really need to "view" the entity as content; there is nothing
    // interesting to see there. So override the default link with a link to a
    // profile on Project Honeypot.
    $host_ip = $entity->host_ip->value;
    $url = \Drupal\Core\Url::fromUri('http://www.projecthoneypot.org/search_ip.php?ip=' . $host_ip);
    $url_options = [
      'attributes' => [
        'target' => '_blank',
        'title' => 'View this host\'s profile on Project Honeypot.',
      ],
    ];
    $url
      ->setOptions($url_options);
    $project_link = \Drupal\Core\Link::fromTextAndUrl(t($host_ip), $url)
      ->toString();
    $row['name'] = $project_link;

    // Status with humanized conversion.
    $httpblManager = \Drupal::service('httpbl.evaluator');
    $human = $httpblManager
      ->getHumanStatus($entity->host_status->value);
    $row['host_status'] = t($entity->host_status->value . ' - <em style="color: lightgrey;">' . $human . '</em>');

    // If this entity is blacklisted && Ban module exists...
    if ($entity->host_status->value == HTTPBL_LIST_BLACK && \Drupal::moduleHandler()
      ->moduleExists('ban')) {

      // Also check if it has been banned.
      $ip = $entity->host_ip->value;
      $banManager = \Drupal::service('ban.ip_manager');

      // If this host is also found in ban_ip table...
      if ($banManager
        ->isBanned($ip)) {

        // Report as banned on the list, in addition to being blacklisted.
        $row['host_status'] = t($entity->host_status->value . ' - <em style="color: lightgrey;">' . $human . ' and Banned!</em>');
      }
    }

    // Source of this evaluation.
    // If this is original, un-altered (no admin management decisions) Project
    // Honeypot source, then also provide the project link here.
    if ($entity->source->value == t(HTTPBL_ORIGINAL_SOURCE)) {

      // recycle the url from above...
      $url
        ->setOptions($url_options);
      $project_link = \Drupal\Core\Link::fromTextAndUrl(t($entity->source->value), $url)
        ->toString();
      $row['source'] = $project_link;
    }
    else {
      $row['source'] = $entity->source->value;
    }

    // Expiration...
    // If expire has zero time left, show  as "next cron".
    // Otherwise, show expire timestamp formatted as "time until."
    if ($entity->expire->value < \Drupal::time()
      ->getRequestTime()) {
      $row['expire'] = t('(next cron)');
    }
    else {
      $row['expire'] = \Drupal::service('date.formatter')
        ->formatTimeDiffUntil($entity->expire->value);
    }

    // Created and Changed
    $row['created'] = \Drupal::service('date.formatter')
      ->format($entity->created->value, 'html_date');
    $row['changed'] = \Drupal::service('date.formatter')
      ->format($entity->changed->value, 'html_datetime');
    return $row + parent::buildRow($entity);
  }

}

Members

Name	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::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::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::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load	4
HostListBuilder::$urlGenerator	protected	property	The url generator.
HostListBuilder::buildHeader	public	function	Building the header and content lines for the contact list. Overrides EntityListBuilder::buildHeader
HostListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
HostListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
HostListBuilder::render	public	function	We override ::render() so that we can add our own content above the table. parent::render() is where EntityListBuilder creates the table using our buildHeader() and buildRow() implementations. Overrides EntityListBuilder::render
HostListBuilder::__construct	public	function	Constructs a new ContactListBuilder object. Overrides EntityListBuilder::__construct
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.

You are here

class HostListBuilder in http:BL 8

Hierarchy

File

Namespace

Members

API Navigation