QueryEntity.php in Lightweight Directory Access Protocol (LDAP) 8.4

Namespace

Drupal\ldap_query\Entity

File

ldap_query/src/Entity/QueryEntity.php

<?php

declare (strict_types=1);
namespace Drupal\ldap_query\Entity;

use Drupal\Core\Config\Entity\ConfigEntityBase;
use Drupal\ldap_query\QueryEntityInterface;

/**
 * Defines the LDAP Queries entity.
 *
 * @ConfigEntityType(
 *   id = "ldap_query_entity",
 *   label = @Translation("LDAP Queries"),
 *   handlers = {
 *     "list_builder" = "Drupal\ldap_query\QueryEntityListBuilder",
 *     "form" = {
 *       "add" = "Drupal\ldap_query\Form\QueryEntityForm",
 *       "edit" = "Drupal\ldap_query\Form\QueryEntityForm",
 *       "delete" = "Drupal\ldap_query\Form\QueryEntityDeleteForm"
 *     },
 *     "route_provider" = {
 *       "html" = "Drupal\ldap_query\QueryEntityHtmlRouteProvider",
 *     },
 *   },
 *   config_prefix = "ldap_query_entity",
 *   admin_permission = "administer ldap",
 *   entity_keys = {
 *     "id" = "id",
 *     "label" = "label",
 *     "uuid" = "uuid"
 *   },
 *   links = {
 *     "add-form" = "/admin/config/people/ldap/query/add",
 *     "edit-form" = "/admin/config/people/ldap/query/{ldap_query_entity}/edit",
 *     "delete-form" = "/admin/config/people/ldap/query/{ldap_query_entity}/delete",
 *     "collection" = "/admin/config/people/ldap/query",
 *     "test" = "/admin/config/people/ldap/query/{ldap_query_entity}/test"
 *   },
 *   config_export = {
 *    "id",
 *    "label",
 *    "uuid",
 *    "server_id",
 *    "status",
 *    "attributes",
 *    "base_dn",
 *    "filter",
 *    "size_limit",
 *    "time_limit",
 *    "scope",
 *    "dereference",
 *   }
 * )
 */
class QueryEntity extends ConfigEntityBase implements QueryEntityInterface {

  /**
   * The LDAP Queries ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The LDAP Queries label.
   *
   * @var string
   */
  protected $label;

  /**
   * Server ID.
   *
   * @var string
   */
  protected $server_id;

  /**
   * Base DN.
   *
   * @var string
   */
  protected $base_dn;

  /**
   * Filter.
   *
   * @var string
   */
  protected $filter;

  /**
   * Attributes.
   *
   * @var string
   */
  protected $attributes;

  /**
   * Size limit.
   *
   * @var int
   */
  protected $size_limit;

  /**
   * Time limit.
   *
   * @var int
   */
  protected $time_limit;

  /**
   * Dereference.
   *
   * @var int
   */
  protected $dereference;

  /**
   * Scope.
   *
   * @var string
   */
  protected $scope;

  /**
   * {@inheritdoc}
   */
  public function getProcessedBaseDns() : array {
    return explode("\r\n", $this->base_dn);
  }

  /**
   * {@inheritdoc}
   */
  public function getProcessedAttributes() : array {
    if (!empty($this->attributes)) {
      return explode(',', $this->attributes);
    }
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getFilter() : string {
    return $this->filter;
  }

  /**
   * {@inheritdoc}
   */
  public function getSizeLimit() : int {
    return $this->size_limit;
  }

  /**
   * {@inheritdoc}
   */
  public function getTimeLimit() : int {
    return $this->time_limit;
  }

  /**
   * {@inheritdoc}
   */
  public function getDereference() : int {
    return $this->dereference;
  }

  /**
   * {@inheritdoc}
   */
  public function getScope() : string {
    return $this->scope;
  }

  /**
   * {@inheritdoc}
   */
  public function getServerId() : string {
    return $this->server_id;
  }

  /**
   * {@inheritdoc}
   */
  public function isActive() : bool {
    return $this->status;
  }

}

Classes

Name	Description
QueryEntity	Defines the LDAP Queries entity.