class Server in Lightweight Directory Access Protocol (LDAP) 8.4

Same name and namespace in other branches

8.3 ldap_servers/src/Entity/Server.php \Drupal\ldap_servers\Entity\Server

Defines the Server entity.

Plugin annotation


@ConfigEntityType(
  id = "ldap_server",
  label = @Translation("LDAP Server"),
  handlers = {
    "list_builder" = "Drupal\ldap_servers\ServerListBuilder",
    "form" = {
      "add" = "Drupal\ldap_servers\Form\ServerForm",
      "edit" = "Drupal\ldap_servers\Form\ServerForm",
      "delete" = "Drupal\ldap_servers\Form\ServerDeleteForm",
      "test" = "Drupal\ldap_servers\Form\ServerTestForm",
      "enable_disable" = "Drupal\ldap_servers\Form\ServerEnableDisableForm"
    }
  },
  config_prefix = "server",
  admin_permission = "administer ldap",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid"
  },
  links = {
    "edit-form" = "/admin/config/people/ldap/server/{server}/edit",
    "delete-form" = "/admin/config/people/ldap/server/{server}/delete",
    "collection" = "/admin/config/people/ldap/server"
  },
  config_export = {
   "id",
   "label",
   "type",
   "uuid",
   "account_name_attr",
   "address",
   "basedn",
   "bind_method",
   "binddn",
   "bindpw",
   "encryption",
   "grp_derive_from_dn_attr",
   "grp_derive_from_dn",
   "grp_memb_attr_match_user_attr",
   "grp_memb_attr",
   "grp_nested",
   "grp_object_cat",
   "grp_test_grp_dn_writeable",
   "grp_test_grp_dn",
   "grp_unused",
   "grp_user_memb_attr_exists",
   "grp_user_memb_attr",
   "mail_attr",
   "mail_template",
   "picture_attr",
   "port",
   "status",
   "testing_drupal_user_dn",
   "testing_drupal_username",
   "timeout",
   "unique_persistent_attr_binary",
   "unique_persistent_attr",
   "user_attr",
   "user_dn_expression",
   "weight",
  }
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\ldap_servers\Entity\Server implements ServerInterface uses StringTranslationTrait, LdapTransformationTraits

Expanded class hierarchy of Server

14 files declare their use of Server

FakeBridge.php in ldap_servers/tests/modules/ldap_servers_dummy/src/FakeBridge.php
FieldProvider.php in ldap_user/src/FieldProvider.php
FieldProviderTest.php in ldap_user/tests/src/Kernel/FieldProviderTest.php
GroupManagerTest.php in ldap_servers/tests/src/Kernel/GroupManagerTest.php
LdapBaseManager.php in ldap_servers/src/LdapBaseManager.php

... See full list

2 string references to 'Server'

QueryEntityListBuilder::buildHeader in ldap_query/src/QueryEntityListBuilder.php: Builds the header row for the entity listing.
ServerForm::form in ldap_servers/src/Form/ServerForm.php: Gets the actual form array to be built.

File

ldap_servers/src/Entity/Server.php, line 81

Namespace

Drupal\ldap_servers\Entity

View source

class Server extends ConfigEntityBase implements ServerInterface {
  use LdapTransformationTraits;
  use StringTranslationTrait;

  /**
   * Logger channel.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * LDAP Details logger.
   *
   * @var \Drupal\ldap_servers\Logger\LdapDetailLog
   */
  protected $detailLog;

  /**
   * Token processor.
   *
   * @var \Drupal\ldap_servers\Processor\TokenProcessor
   */
  protected $tokenProcessor;

  /**
   * Module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandler
   */
  protected $moduleHandler;

  /**
   * Server machine name.
   *
   * @var string
   */
  protected $id;

  /**
   * Human readable name.
   *
   * @var string
   */
  protected $label;

  /**
   * Server type.
   *
   * @var string
   */
  protected $type;

  /**
   * LDAP Server connection.
   *
   * @var resource|false
   */
  protected $connection = FALSE;

  /**
   * Account name attribute.
   *
   * @var string
   */
  protected $account_name_attr;

  /**
   * Server address.
   *
   * @var string
   */
  protected $address;

  /**
   * Base DN.
   *
   * @var array
   */
  protected $basedn;

  /**
   * Bind method.
   *
   * @var string
   */
  protected $bind_method;

  /**
   * Bind DN.
   *
   * @var string
   */
  protected $binddn;

  /**
   * Bind password.
   *
   * @var string
   */
  protected $bindpw;

  /**
   * Attribute of the User's LDAP Entry DN which contains the group.
   *
   * @var string
   */
  protected $grp_derive_from_dn_attr;

  /**
   * Groups are derived from user's LDAP entry DN.
   *
   * @var bool
   */
  protected $grp_derive_from_dn = FALSE;

  /**
   * User attribute held in "LDAP Group Entry Attribute Holding...".
   *
   * @var string
   */
  protected $grp_memb_attr_match_user_attr;

  /**
   * LDAP Group Entry Attribute Holding User's DN, CN, etc.
   *
   * @var string
   */
  protected $grp_memb_attr;

  /**
   * Nested groups are used in my LDAP.
   *
   * @var bool
   */
  protected $grp_nested = FALSE;

  /**
   * Name of Group Object Class.
   *
   * @var string
   */
  protected $grp_object_cat;

  /**
   * Testing LDAP Group DN that is writable.
   *
   * @var string
   */
  protected $grp_test_grp_dn_writeable;

  /**
   * Testing LDAP Group DN.
   *
   * @var string
   */
  protected $grp_test_grp_dn;

  /**
   * Groups are not relevant to this Drupal site.
   *
   * @var bool
   */
  protected $grp_unused = TRUE;

  /**
   * Attribute in User Entry Containing Groups.
   *
   * @var bool
   */
  protected $grp_user_memb_attr_exists;

  /**
   * Attribute in User Entry Containing Groups.
   *
   * @var string
   */
  protected $grp_user_memb_attr;

  /**
   * Email attribute.
   *
   * @var string
   */
  protected $mail_attr;

  /**
   * Email template.
   *
   * @var string
   */
  protected $mail_template;

  /**
   * Thumbnail attribute.
   *
   * @var string
   */
  protected $picture_attr;

  /**
   * Port.
   *
   * @var int
   */
  protected $port;

  /**
   * DN of testing username.
   *
   * @var string
   */
  protected $testing_drupal_user_dn;

  /**
   * Testing Drupal Username.
   *
   * @var string
   */
  protected $testing_drupal_username;

  /**
   * Timeout.
   *
   * @var int
   */
  protected $timeout;

  /**
   * Use Start-TLS.
   *
   * @var bool
   */
  protected $tls = FALSE;

  /**
   * Does PUID hold a binary value?
   *
   * @var bool
   */
  protected $unique_persistent_attr_binary;

  /**
   * Persistent and Unique User ID Attribute.
   *
   * @var string
   */
  protected $unique_persistent_attr;

  /**
   * Authentication name attribute.
   *
   * @var string
   */
  protected $user_attr;

  /**
   * Expression for user DN.
   *
   * @var string
   */
  protected $user_dn_expression;

  /**
   * Weight.
   *
   * @var int
   */
  protected $weight;

  /**
   * Constructor.
   *
   * @param array $values
   *   Values.
   * @param string $entity_type
   *   Entity Type.
   */
  public function __construct(array $values, $entity_type) {
    parent::__construct($values, $entity_type);
    $this->logger = \Drupal::logger('ldap_servers');
    $this->detailLog = \Drupal::service('ldap.detail_log');
    $this->tokenProcessor = \Drupal::service('ldap.token_processor');
    $this->moduleHandler = \Drupal::service('module_handler');
  }

  /**
   * {@inheritdoc}
   */
  public function getFormattedBind() : TranslatableMarkup {
    switch ($this
      ->get('bind_method')) {
      case 'service_account':
      default:
        $namedBind = $this
          ->t('service account bind');
        break;
      case 'user':
        $namedBind = $this
          ->t('user credentials bind');
        break;
      case 'anon':
        $namedBind = $this
          ->t('anonymous bind (search), then user credentials');
        break;
      case 'anon_user':
        $namedBind = $this
          ->t('anonymous bind');
        break;
    }
    return $namedBind;
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseDn() : array {
    return $this
      ->get('basedn');
  }

  /**
   * {@inheritdoc}
   */
  public function deriveUsernameFromLdapResponse(Entry $ldap_entry) : string {
    $accountName = '';
    if ($this
      ->getAccountNameAttribute()) {
      if ($ldap_entry
        ->hasAttribute($this
        ->getAccountNameAttribute(), FALSE)) {
        $accountName = $ldap_entry
          ->getAttribute($this
          ->getAccountNameAttribute(), FALSE)[0];
      }
    }
    elseif ($this
      ->getAuthenticationNameAttribute()) {
      if ($ldap_entry
        ->hasAttribute($this
        ->getAuthenticationNameAttribute(), FALSE)) {
        $accountName = $ldap_entry
          ->getAttribute($this
          ->getAuthenticationNameAttribute(), FALSE)[0];
      }
    }
    return $accountName;
  }

  /**
   * {@inheritdoc}
   */
  public function deriveEmailFromLdapResponse(Entry $ldap_entry) : string {
    $mail = '';

    // Not using template.
    if ($this
      ->getMailAttribute() && $ldap_entry
      ->hasAttribute($this
      ->getMailAttribute(), FALSE)) {
      $mail = $ldap_entry
        ->getAttribute($this
        ->getMailAttribute(), FALSE)[0];
    }
    elseif ($this
      ->getMailTemplate()) {

      // Template is of form [cn]@illinois.edu.
      $mail = $this->tokenProcessor
        ->ldapEntryReplacementsForDrupalAccount($ldap_entry, $this
        ->getMailTemplate());
    }
    return $mail;
  }

  /**
   * {@inheritdoc}
   */
  public function derivePuidFromLdapResponse(Entry $ldapEntry) : string {
    $puid = '';
    if ($this
      ->getUniquePersistentAttribute() && $ldapEntry
      ->hasAttribute($this
      ->getUniquePersistentAttribute(), FALSE)) {
      $puid = $ldapEntry
        ->getAttribute($this
        ->getUniquePersistentAttribute(), FALSE)[0];
      if ($this
        ->isUniquePersistentAttributeBinary()) {
        $puid = bin2hex($puid);
      }
    }
    return $puid;
  }

  /**
   * {@inheritdoc}
   */
  public function getAccountNameAttribute() : ?string {
    return $this->account_name_attr;
  }

  /**
   * {@inheritdoc}
   */
  public function hasAccountNameAttribute() : bool {
    return !empty($this->account_name_attr);
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getBindDn() : ?string {
    return $this->binddn;
  }

  /**
   * {@inheritdoc}
   */
  public function getBindPassword() : ?string {
    return $this->bindpw;
  }

  /**
   * {@inheritdoc}
   */
  public function getDerivedGroupFromDnAttribute() : ?string {
    return $this->grp_derive_from_dn_attr;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getUserAttributeFromGroupMembershipEntryAttribute() : ?string {
    return $this->grp_memb_attr_match_user_attr;
  }

  /**
   * {@inheritdoc}
   */
  public function getGroupMembershipAttribute() : ?string {
    return $this->grp_memb_attr;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getGroupObjectClass() : ?string {
    return $this->grp_object_cat;
  }

  /**
   * {@inheritdoc}
   */
  public function getGroupTestGroupDnWriteable() : ?string {
    return $this->grp_test_grp_dn_writeable;
  }

  /**
   * {@inheritdoc}
   */
  public function getGroupTestGroupDn() : ?string {
    return $this->grp_test_grp_dn;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getGroupUserMembershipAttribute() : ?string {
    return $this->grp_user_memb_attr;
  }

  /**
   * {@inheritdoc}
   */
  public function getMailAttribute() : ?string {
    return $this->mail_attr;
  }

  /**
   * {@inheritdoc}
   */
  public function getMailTemplate() : ?string {
    return $this->mail_template;
  }

  /**
   * {@inheritdoc}
   */
  public function getPictureAttribute() : ?string {
    return $this->picture_attr;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getTestingDrupalUserDn() : ?string {
    return $this->testing_drupal_user_dn;
  }

  /**
   * {@inheritdoc}
   */
  public function getTestingDrupalUsername() : ?string {
    return $this->testing_drupal_username;
  }

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

  /**
   * {@inheritdoc}
   */
  public function isUniquePersistentAttributeBinary() : bool {
    return $this->unique_persistent_attr_binary ?: FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getUniquePersistentAttribute() : ?string {
    return $this->unique_persistent_attr;
  }

  /**
   * {@inheritdoc}
   */
  public function getAuthenticationNameAttribute() : ?string {
    return $this->user_attr;
  }

  /**
   * {@inheritdoc}
   */
  public function getUserDnExpression() : ?string {
    return $this->user_dn_expression;
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling	private	property	Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode	protected	property	The language code of the entity's default language.
ConfigEntityBase::$originalId	protected	property	The original ID of the configuration entity.
ConfigEntityBase::$status	protected	property	The enabled/disabled status of the configuration entity.	4
ConfigEntityBase::$third_party_settings	protected	property	Third party entity settings.
ConfigEntityBase::$trustedData	protected	property	Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid	protected	property	The UUID for this entity.
ConfigEntityBase::$_core	protected	property	Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies	13
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityBase::createDuplicate	1
ConfigEntityBase::disable	public	function	Disables the configuration entity. Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable	public	function	Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate	1
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig	protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData	public	function	Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete	protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable	public	function	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	7
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete	8
ConfigEntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave	13
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides EntityBase::save	1
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling	public	function
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.	6
ConfigEntityBase::status	public	function	Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status	4
ConfigEntityBase::toArray	public	function	Gets an array of all property values. Overrides EntityBase::toArray	2
ConfigEntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url	public	function	Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	4
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	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId	protected	property	The entity type.
EntityBase::$typedData	protected	property	A typed data object wrapping this entity.
EntityBase::access	public	function	Checks data value access. Overrides AccessibleInterface::access	1
EntityBase::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle	1
EntityBase::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
EntityBase::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated	protected	function	Gets the entity manager.
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id	public	function	Gets the identifier. Overrides EntityInterface::id	11
EntityBase::label	public	function	Gets the label of the entity. Overrides EntityInterface::label	6
EntityBase::language	public	function	Gets the language of the entity. Overrides EntityInterface::language	1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::linkTemplates	protected	function	Gets an array link templates.	1
EntityBase::load	public static	function	Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple	public static	function	Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate	4
EntityBase::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	16
EntityBase::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave	14
EntityBase::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	5
EntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities	1
EntityBase::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	2
EntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid	1
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
LdapTransformationTraits::ldapEscapeDn	protected	function	Wrapper for ldap_escape().
LdapTransformationTraits::ldapEscapeFilter	protected	function	Wrapper for ldap_escape().
LdapTransformationTraits::php56PolyfillLdapEscape	public static	function	Stub implementation of the {@link ldap_escape()} function of ext-ldap.
LdapTransformationTraits::splitDnWithAttributes	public static	function	Wrapper for ldap_explode_dn().
LdapTransformationTraits::splitDnWithValues	public static	function	Wrapper for ldap_explode_dn().
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
Server::$account_name_attr	protected	property	Account name attribute.
Server::$address	protected	property	Server address.
Server::$basedn	protected	property	Base DN.
Server::$binddn	protected	property	Bind DN.
Server::$bindpw	protected	property	Bind password.
Server::$bind_method	protected	property	Bind method.
Server::$connection	protected	property	LDAP Server connection.
Server::$detailLog	protected	property	LDAP Details logger.
Server::$grp_derive_from_dn	protected	property	Groups are derived from user's LDAP entry DN.
Server::$grp_derive_from_dn_attr	protected	property	Attribute of the User's LDAP Entry DN which contains the group.
Server::$grp_memb_attr	protected	property	LDAP Group Entry Attribute Holding User's DN, CN, etc.
Server::$grp_memb_attr_match_user_attr	protected	property	User attribute held in "LDAP Group Entry Attribute Holding...".
Server::$grp_nested	protected	property	Nested groups are used in my LDAP.
Server::$grp_object_cat	protected	property	Name of Group Object Class.
Server::$grp_test_grp_dn	protected	property	Testing LDAP Group DN.
Server::$grp_test_grp_dn_writeable	protected	property	Testing LDAP Group DN that is writable.
Server::$grp_unused	protected	property	Groups are not relevant to this Drupal site.
Server::$grp_user_memb_attr	protected	property	Attribute in User Entry Containing Groups.
Server::$grp_user_memb_attr_exists	protected	property	Attribute in User Entry Containing Groups.
Server::$id	protected	property	Server machine name.
Server::$label	protected	property	Human readable name.
Server::$logger	protected	property	Logger channel.
Server::$mail_attr	protected	property	Email attribute.
Server::$mail_template	protected	property	Email template.
Server::$moduleHandler	protected	property	Module handler.
Server::$picture_attr	protected	property	Thumbnail attribute.
Server::$port	protected	property	Port.
Server::$testing_drupal_username	protected	property	Testing Drupal Username.
Server::$testing_drupal_user_dn	protected	property	DN of testing username.
Server::$timeout	protected	property	Timeout.
Server::$tls	protected	property	Use Start-TLS.
Server::$tokenProcessor	protected	property	Token processor.
Server::$type	protected	property	Server type.
Server::$unique_persistent_attr	protected	property	Persistent and Unique User ID Attribute.
Server::$unique_persistent_attr_binary	protected	property	Does PUID hold a binary value?
Server::$user_attr	protected	property	Authentication name attribute.
Server::$user_dn_expression	protected	property	Expression for user DN.
Server::$weight	protected	property	Weight.
Server::deriveEmailFromLdapResponse	public	function	Returns the user's email from the LDAP entry. Overrides ServerInterface::deriveEmailFromLdapResponse
Server::derivePuidFromLdapResponse	public	function	Fetches the persistent UID from the LDAP entry. Overrides ServerInterface::derivePuidFromLdapResponse
Server::deriveUsernameFromLdapResponse	public	function	Returns the username from the LDAP entry. Overrides ServerInterface::deriveUsernameFromLdapResponse
Server::getAccountNameAttribute	public	function	Get account name attribute. Overrides ServerInterface::getAccountNameAttribute
Server::getAuthenticationNameAttribute	public	function	Get authentication name attribute. Overrides ServerInterface::getAuthenticationNameAttribute
Server::getBaseDn	public	function	Fetch base DN. Overrides ServerInterface::getBaseDn
Server::getBindDn	public	function	Get bind DN. Overrides ServerInterface::getBindDn
Server::getBindMethod	public	function	Get bind method. Overrides ServerInterface::getBindMethod
Server::getBindPassword	public	function	Get bind password. Overrides ServerInterface::getBindPassword
Server::getDerivedGroupFromDnAttribute	public	function	Get attribute of the user's LDAP entry DN which contains the group. Overrides ServerInterface::getDerivedGroupFromDnAttribute
Server::getFormattedBind	public	function	Returns the formatted label of the bind method. Overrides ServerInterface::getFormattedBind
Server::getGroupMembershipAttribute	public	function	Get LDAP group entry attribute holding user's DN, CN, etc. Overrides ServerInterface::getGroupMembershipAttribute
Server::getGroupObjectClass	public	function	Get the name group object class. Overrides ServerInterface::getGroupObjectClass
Server::getGroupTestGroupDn	public	function	Get group DN for group testing. Overrides ServerInterface::getGroupTestGroupDn
Server::getGroupTestGroupDnWriteable	public	function	Get writable Group DN for group testing. Overrides ServerInterface::getGroupTestGroupDnWriteable
Server::getGroupUserMembershipAttribute	public	function	Get attribute in user entry containing groups. Overrides ServerInterface::getGroupUserMembershipAttribute
Server::getMailAttribute	public	function	Get mail. Overrides ServerInterface::getMailAttribute
Server::getMailTemplate	public	function	Get mail template. Overrides ServerInterface::getMailTemplate
Server::getPictureAttribute	public	function	Get picture attribute. Overrides ServerInterface::getPictureAttribute
Server::getPort	public	function	Get port. Overrides ServerInterface::getPort
Server::getServerAddress	public	function	Get server address. Overrides ServerInterface::getServerAddress
Server::getTestingDrupalUserDn	public	function	Get Drupal user DN for testing. Overrides ServerInterface::getTestingDrupalUserDn
Server::getTestingDrupalUsername	public	function	Get Drupal username for testing. Overrides ServerInterface::getTestingDrupalUsername
Server::getTimeout	public	function	Get timeout. Overrides ServerInterface::getTimeout
Server::getUniquePersistentAttribute	public	function	Get the PUID attribute. Overrides ServerInterface::getUniquePersistentAttribute
Server::getUserAttributeFromGroupMembershipEntryAttribute	public	function	Get user attribute held in "LDAP Group Entry Attribute Holding...". Overrides ServerInterface::getUserAttributeFromGroupMembershipEntryAttribute
Server::getUserDnExpression	public	function	Get User DN expression. Overrides ServerInterface::getUserDnExpression
Server::getWeight	public	function	Get Weight. Overrides ServerInterface::getWeight
Server::hasAccountNameAttribute	public	function	Account name attribute set. Overrides ServerInterface::hasAccountNameAttribute
Server::isActive	public	function	Get status. Overrides ServerInterface::isActive
Server::isGroupDerivedFromDn	public	function	Groups are derived from user's LDAP entry DN. Overrides ServerInterface::isGroupDerivedFromDn
Server::isGrouppNested	public	function	Are groups nested? Overrides ServerInterface::isGrouppNested
Server::isGroupUnused	public	function	Get group usage. Overrides ServerInterface::isGroupUnused
Server::isGroupUserMembershipAttributeInUse	public	function	Attribute in user entry contains groups. Overrides ServerInterface::isGroupUserMembershipAttributeInUse
Server::isUniquePersistentAttributeBinary	public	function	Is the PUID attribute binary? Overrides ServerInterface::isUniquePersistentAttributeBinary
Server::__construct	public	function	Constructor. Overrides ConfigEntityBase::__construct
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.
SynchronizableEntityTrait::$isSyncing	protected	property	Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing	public	function
SynchronizableEntityTrait::setSyncing	public	function

You are here

class Server in Lightweight Directory Access Protocol (LDAP) 8.4

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation