You are here

Home » API reference » Lightweight Directory Access Protocol (LDAP) 8.4 » ServerListBuilder.php

class ServerListBuilder in Lightweight Directory Access Protocol (LDAP) 8.4

Same name and namespace in other branches
  1. 8.3 ldap_servers/src/ServerListBuilder.php \Drupal\ldap_servers\ServerListBuilder

Provides a listing of Server entities.

Hierarchy

Expanded class hierarchy of ServerListBuilder

File

ldap_servers/src/ServerListBuilder.php, line 16

Namespace

Drupal\ldap_servers
View source 
class ServerListBuilder extends ConfigEntityListBuilder {

  /**
   * {@inheritdoc}
   *
   * Building the header and content lines for the server 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() : array {
    $header['label'] = $this
      ->t('Name');
    $header['bind_method'] = $this
      ->t('Method');
    $header['binddn'] = $this
      ->t('Account');
    $header['status'] = $this
      ->t('Enabled');
    $header['address'] = $this
      ->t('Server address');
    $header['port'] = $this
      ->t('Server port');
    $header['current_status'] = $this
      ->t('Server reachable');
    return $header + parent::buildHeader();
  }

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

    /** @var \Drupal\ldap_servers\Entity\Server $entity */
    $entityWithoutOverrides = $entity;

    /** @var \Drupal\ldap_servers\Entity\Server $entity_with_overrides */
    $entity = $this->storage
      ->load($entity
      ->id());
    $row = [];
    $row['label'] = $entity
      ->label();
    $row['bind_method'] = ucfirst((string) $entity
      ->getFormattedBind());
    if ($entity
      ->get('bind_method') === 'service_account') {
      $row['binddn'] = $entity
        ->get('binddn');
    }
    else {
      $row['binddn'] = $this
        ->t('N/A');
    }
    $row['status'] = $entity
      ->get('status') ? 'Yes' : 'No';
    $row['address'] = $entity
      ->get('address');
    $row['port'] = $entity
      ->get('port');
    $row['current_status'] = $this
      ->checkStatus($entity);
    $fields = [
      'bind_method',
      'binddn',
      'status',
      'address',
      'port',
    ];
    foreach ($fields as $field) {
      if ($entity
        ->get($field) !== $entityWithoutOverrides
        ->get($field)) {
        $row[$field] .= ' ' . $this
          ->t('(overridden)');
      }
    }
    return $row + parent::buildRow($entity);
  }

  /**
   * Format a server status response.
   *
   * @param \Drupal\ldap_servers\Entity\Server $server
   *   Server.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The status string.
   */
  private function checkStatus(Server $server) : TranslatableMarkup {

    /** @var \Drupal\ldap_servers\LdapBridge $bridge */
    $bridge = \Drupal::service('ldap.bridge');
    $bridge
      ->setServer($server);
    if ($server
      ->get('status')) {
      if ($bridge
        ->bind()) {
        $result = $this
          ->t('Server available');
      }
      else {
        $result = $this
          ->t('Binding issues, please see log.');
      }
    }
    else {
      $result = $this
        ->t('Deactivated');
    }
    return $result;
  }

  /**
   * Get Operations.
   *
   * @param \Drupal\Core\Entity\EntityInterface|\Drupal\ldap_servers\ServerInterface $entity
   *   Entity interface.
   *
   * @return array
   *   Available operations in dropdown.
   */
  public function getOperations(EntityInterface $entity) : array {
    $operations = $this
      ->getDefaultOperations($entity);
    if (!isset($operations['test'])) {
      $operations['test'] = [
        'title' => $this
          ->t('Test'),
        'weight' => 10,
        'url' => Url::fromRoute('entity.ldap_server.test_form', [
          'ldap_server' => $entity
            ->id(),
        ]),
      ];
    }
    if ($entity
      ->get('status')) {
      $operations['disable'] = [
        'title' => $this
          ->t('Disable'),
        'weight' => 15,
        'url' => Url::fromRoute('entity.ldap_server.enable_disable_form', [
          'ldap_server' => $entity
            ->id(),
        ]),
      ];
    }
    else {
      $operations['enable'] = [
        'title' => $this
          ->t('Enable'),
        'weight' => 15,
        'url' => Url::fromRoute('entity.ldap_server.enable_disable_form', [
          'ldap_server' => $entity
            ->id(),
        ]),
      ];
    }
    return $operations;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::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::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
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.
ServerListBuilder::buildHeader public function Building the header and content lines for the server list. Overrides EntityListBuilder::buildHeader
ServerListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
ServerListBuilder::checkStatus private function Format a server status response.
ServerListBuilder::getOperations public function Get Operations. Overrides EntityListBuilder::getOperations
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.