$instances
$instances :\LibMelanie\Ldap\Ldap
Instances LDAP
Gestion de la connexion LDAP
$instances :\LibMelanie\Ldap\Ldap
Instances LDAP
GetInstance(string $server): \LibMelanie\Ldap\Ldap
Récupèration de l'instance lié au serveur
| string | $server | Nom du serveur, l'instance sera liée à ce nom qui correspond à la configuration du serveur |
authenticateSASL(string $binddn = null,string $password = null,string $sasl_mech = null,string $sasl_realm = null,string $sasl_authc_id = null,string $sasl_authz_id = null,string $props = null): boolean
Authentification SASL sur le serveur LDAP
| string | $binddn | — [optional] |
| string | $password | — [optional] |
| string | $sasl_mech | — [optional] |
| string | $sasl_realm | — [optional] |
| string | $sasl_authc_id | — [optional] |
| string | $sasl_authz_id | — [optional] |
| string | $props | — [optional] |
— TRUE on success or FALSE on failure.
Authentification(string $username,string $password,string $server = null,boolean $useUserInfos = false): boolean
Authentification sur le serveur LDAP associé
| string | $username | |
| string | $password | |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
| boolean | $useUserInfos | [Optionnel] Utiliser la méthode GetUserInfos pour chercher le DN (intéressant si les données sont en cache) |
AuthentificationDirect(string $username,string $password,string $server = null): boolean
Authentification sur le serveur LDAP associé Fait directement un bind avec le username et le password
| string | $username | |
| string | $password | |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
GetUserInfos(string $username = null,string $filter = null,array $ldap_attr = null,string $server = null,string $base_dn = null): array
Retourne les données sur l'utilisateur lues depuis le Ldap Ne retourne qu'une seule entrée
| string | $username | [Optionnel] Identifiant de l'utilisateur recherché |
| string | $filter | [Optionnel] Filtre ldap à utiliser pour la recherche |
| array | $ldap_attr | [Optionnel] Liste des attributs ldap à retourner |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
| string | $base_dn | [Optionnel] Base DN utilisé pour la requête |
GetUserInfosFromDn(string $user_dn,array $ldap_attr = null,string $server = null): array
Retourne les données sur l'utilisateur lues depuis le Ldap en fonction de son DN Ne retourne qu'une seule entrée
| string | $user_dn | DN de l'utilisateur recherché |
| array | $ldap_attr | [Optionnel] Liste des attributs ldap à retourner |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
GetUsersList( $filter, $ldap_attr = null, $server = null): array|null
Retourne une liste user
| $filter | DN de l'utilisateur recherché |
|
| $ldap_attr | [Optionnel] Liste des attributs ldap à retourner |
|
| $server | [Optionnel] Server LDAP utilisé pour la requête |
GetUserBalPartagees(string $username = null,string $filter = null,array $ldap_attr = null,string $server = null): array
Retourne les boites partagées accessible pour un utilisateur depuis le LDAP
| string | $username | [Optionnel] Identifiant de l'utilisateur recherché |
| string | $filter | [Optionnel] Filtre ldap à utiliser pour la recherche |
| array | $ldap_attr | [Optionnel] Liste des attributs ldap à retourner |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
GetUserBalEmission(string $username = null,string $filter = null,array $ldap_attr = null,string $server = null): array
Retourne les boites partagées accessible en Emission ou Gestionnaire pour un utilisateur depuis le LDAP
| string | $username | [Optionnel] Identifiant de l'utilisateur recherché |
| string | $filter | [Optionnel] Filtre ldap à utiliser pour la recherche |
| array | $ldap_attr | [Optionnel] Liste des attributs ldap à retourner |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
GetUserBalGestionnaire(string $username = null,string $filter = null,array $ldap_attr = null,string $server = null): array
Retourne les boites partagées dont l'utilisateur est gestionnaire
| string | $username | [Optionnel] Identifiant de l'utilisateur recherché |
| string | $filter | [Optionnel] Filtre ldap à utiliser pour la recherche |
| array | $ldap_attr | [Optionnel] Liste des attributs ldap à retourner |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
GetGroups(string $filter,array $ldap_attr = null,integer $sizelimit,string $server = null): array
Retourne les groupes suivant le filter passé en parametre
| string | $filter | Filtre ldap à utiliser pour la recherche |
| array | $ldap_attr | [Optionnel] Liste des attributs ldap à retourner |
| integer | $sizelimit | Vous permet de limiter le nombre d'entrées à récupérer. Le fait de définir ce paramètre à 0 signifie qu'il n'y aura aucune limite. |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
GetUserGroups(string $username = null,string $filter = null,array $ldap_attr = null,string $server = null): array
Retourne les groupes dont l'utilisateur est propriétaire
| string | $username | [Optionnel] Identifiant de l'utilisateur recherché |
| string | $filter | [Optionnel] Filtre ldap à utiliser pour la recherche |
| array | $ldap_attr | [Optionnel] Liste des attributs ldap à retourner |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
GetGroupsUserIsMember(string $username = null,string $filter = null,array $ldap_attr = null,string $server = null): array
Retourne les groupes dont l'utilisateur est membres
| string | $username | [Optionnel] Identifiant de l'utilisateur recherché |
| string | $filter | [Optionnel] Filtre ldap à utiliser pour la recherche |
| array | $ldap_attr | [Optionnel] Liste des attributs ldap à retourner |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
GetListsUserIsMember(string $email = null,string $filter = null,array $ldap_attr = null,string $server = null): array
Retourne les listes de diffusion dont l'utilisateur est membres (par son e-mail)
| string | [Optionnel] E-mail de l'utilisateur recherché |
|
| string | $filter | [Optionnel] Filtre ldap à utiliser pour la recherche |
| array | $ldap_attr | [Optionnel] Liste des attributs ldap à retourner |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
GetUserInfosFromEmail(string $email = null,string $filter = null,array $ldap_attr = null,string $server = null): mixed
Retourne les informations sur un utilisateur depuis son adresse email depuis le LDAP Ne retourne qu'une seule entrée
| string | [Optionnel] Adresse email de l'utilisateur |
|
| string | $filter | [Optionnel] Filtre ldap à utiliser pour la recherche |
| array | $ldap_attr | [Optionnel] Liste des attributs ldap à retourner |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
dn cn uid
GetMap(string $name,string $defaultValue = null,string $server = null): NULL|string
Retourne le nom du champ mappé configuré pour le serveur LDAP (par défault SEARCH)
| string | $name | |
| string | $defaultValue | [Optionnel] valeur par défaut si le mapping n'existe pas |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
Nom du champ mappé
GetMapValue(array $infos,string $name,string $defaultValue = null,string $server = null,\LibMelanie\Ldap\number $valueNumber): NULL|string
Retourne la valeur (1ere si plusieurs) correspondant au nom en fonction des infos
| array | $infos | Données venant du LDAP |
| string | $name | |
| string | $defaultValue | [Optionnel] valeur par défaut si le mapping n'existe pas |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
| \LibMelanie\Ldap\number | $valueNumber | [Optionnel] numéro de l'élément du tableau, 0 par défaut |
Nom du champ mappé
GetMapValues(array $infos,string $name,string $defaultValue = null,string $server = null): NULL|string
Retourne les valeurs (tableau) correspondant au nom en fonction des infos
| array | $infos | Données venant du LDAP |
| string | $name | |
| string | $defaultValue | [Optionnel] valeur par défaut si le mapping n'existe pas |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
Nom du champ mappé
issetMap(array $infos,string $name,string $defaultValue = null,string $server = null): boolean
Retourne si les valeurs existent dans le tableau pour le nom mappé
| array | $infos | |
| string | $name | |
| string | $defaultValue | [Optionnel] valeur par défaut si le mapping n'existe pas |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
issetMapValue(array $infos,string $name,string $defaultValue = null,\LibMelanie\Ldap\number $valueNumber,string $server = null): boolean
Retourne si la valeur existe dans le tableau du nom mappé
| array | $infos | |
| string | $name | |
| string | $defaultValue | [Optionnel] valeur par défaut si le mapping n'existe pas |
| \LibMelanie\Ldap\number | $valueNumber | [Optionnel] numéro de l'élément du tableau, 0 par défaut |
| string | $server | [Optionnel] Server LDAP utilisé pour la requête |
search(string $base_dn,string $filter,array $attributes = null,integer $attrsonly,integer $sizelimit): resource
Recherche dans le LDAP
Effectue une recherche avec le filtre filter dans le dossier base_dn avec le paramétrage LDAP_SCOPE_SUBTREE. C'est l'équivalent d'une recherche dans le dossier.
| string | $base_dn | Base DN de recherche |
| string | $filter | Filtre de recherche |
| array | $attributes | Attributs à rechercher |
| integer | $attrsonly | Doit être défini à 1 si seuls les types des attributs sont demandés. S'il est défini à 0, les types et les valeurs des attributs sont récupérés, ce qui correspond au comportement par défaut. |
| integer | $sizelimit | Vous permet de limiter le nombre d'entrées à récupérer. Le fait de définir ce paramètre à 0 signifie qu'il n'y aura aucune limite. |
a search result identifier or false on error.
search_alias(string $base_dn,string $filter,array $attributes = null,integer $attrsonly,integer $sizelimit,integer $deref = LDAP_DEREF_ALWAYS): resource
Recherche dans le LDAP avec les Alias
Effectue une recherche avec le filtre filter dans le dossier base_dn avec le paramétrage LDAP_SCOPE_SUBTREE. C'est l'équivalent d'une recherche dans le dossier.
| string | $base_dn | Base DN de recherche |
| string | $filter | Filtre de recherche |
| array | $attributes | Attributs à rechercher |
| integer | $attrsonly | Doit être défini à 1 si seuls les types des attributs sont demandés. S'il est défini à 0, les types et les valeurs des attributs sont récupérés, ce qui correspond au comportement par défaut. |
| integer | $sizelimit | Vous permet de limiter le nombre d'entrées à récupérer. Le fait de définir ce paramètre à 0 signifie qu'il n'y aura aucune limite. |
| integer | $deref | Spécifie le nombre d'alias qui doivent être gérés pendant la recherche. Il peut être un parmi les suivants :
|
a search result identifier or false on error.
read(string $base_dn,string $filter,array $attributes = null,integer $attrsonly,integer $sizelimit): resource
Recherche dans le LDAP
Effectue une recherche avec le filtre filter dans le dossier base_dn avec la configuration LDAP_SCOPE_BASE. C'est équivalent à lire une entrée dans un dossier.
| string | $base_dn | Base DN de recherche |
| string | $filter | Filtre de recherche |
| array | $attributes | Attributs à rechercher |
| integer | $attrsonly | Doit être défini à 1 si seuls les types des attributs sont demandés. S'il est défini à 0, les types et les valeurs des attributs sont récupérés, ce qui correspond au comportement par défaut. |
| integer | $sizelimit | Vous permet de limiter le nombre d'entrées à récupérer. Le fait de définir ce paramètre à 0 signifie qu'il n'y aura aucune limite. |
a search result identifier or false on error.
read_alias(string $base_dn,string $filter,array $attributes = null,integer $attrsonly,integer $sizelimit,integer $deref = LDAP_DEREF_ALWAYS): resource
Recherche dans le LDAP avec les Alias
Effectue une recherche avec le filtre filter dans le dossier base_dn avec la configuration LDAP_SCOPE_BASE. C'est équivalent à lire une entrée dans un dossier.
| string | $base_dn | Base DN de recherche |
| string | $filter | Filtre de recherche |
| array | $attributes | Attributs à rechercher |
| integer | $attrsonly | Doit être défini à 1 si seuls les types des attributs sont demandés. S'il est défini à 0, les types et les valeurs des attributs sont récupérés, ce qui correspond au comportement par défaut. |
| integer | $sizelimit | Vous permet de limiter le nombre d'entrées à récupérer. Le fait de définir ce paramètre à 0 signifie qu'il n'y aura aucune limite. |
| integer | $deref | Spécifie le nombre d'alias qui doivent être gérés pendant la recherche. Il peut être un parmi les suivants :
|
a search result identifier or false on error.
ldap_list(string $base_dn,string $filter,array $attributes = null,integer $attrsonly,integer $sizelimit): resource
Recherche dans le LDAP Effectue une recherche avec le filtre filter dans le dossier base_dn avec l'option LDAP_SCOPE_ONELEVEL.
LDAP_SCOPE_ONELEVEL signifie que la recherche ne peut retourner des entrées que dans le niveau qui est immédiatement sous le niveau base_dn (c'est l'équivalent de la commande ls, pour obtenir la liste des fichiers et dossiers du dossier courant).
| string | $base_dn | Base DN de recherche |
| string | $filter | Filtre de recherche |
| array | $attributes | Attributs à rechercher |
| integer | $attrsonly | Doit être défini à 1 si seuls les types des attributs sont demandés. S'il est défini à 0, les types et les valeurs des attributs sont récupérés, ce qui correspond au comportement par défaut. |
| integer | $sizelimit | Vous permet de limiter le nombre d'entrées à récupérer. Le fait de définir ce paramètre à 0 signifie qu'il n'y aura aucune limite. |
a search result identifier or false on error.
list_alias(string $base_dn,string $filter,array $attributes = null,integer $attrsonly,integer $sizelimit,integer $deref = LDAP_DEREF_ALWAYS): resource
Recherche dans le LDAP avec les Alias
Effectue une recherche avec le filtre filter dans le dossier base_dn avec l'option LDAP_SCOPE_ONELEVEL. LDAP_SCOPE_ONELEVEL signifie que la recherche ne peut retourner des entrées que dans le niveau qui est immédiatement sous le niveau base_dn (c'est l'équivalent de la commande ls, pour obtenir la liste des fichiers et dossiers du dossier courant).
| string | $base_dn | Base DN de recherche |
| string | $filter | Filtre de recherche |
| array | $attributes | Attributs à rechercher |
| integer | $attrsonly | Doit être défini à 1 si seuls les types des attributs sont demandés. S'il est défini à 0, les types et les valeurs des attributs sont récupérés, ce qui correspond au comportement par défaut. |
| integer | $sizelimit | Vous permet de limiter le nombre d'entrées à récupérer. Le fait de définir ce paramètre à 0 signifie qu'il n'y aura aucune limite. |
| integer | $deref | Spécifie le nombre d'alias qui doivent être gérés pendant la recherche. Il peut être un parmi les suivants :
|
a search result identifier or false on error.
next_entry(\LDAP\ResultEntry $search): resource
Retourne les entrées suivantes de la recherche
| \LDAP\ResultEntry | $search | Resource retournée par le search |
entry identifier for the next entry in the result whose entries are being read starting with ldap_first_entry. If there are no more entries in the result then it returns false.
mod_add(string $dn,array $entry): boolean
Ajoute l'attribut entry à l'entrée dn.
Elle effectue la modification au niveau attribut, par opposition au niveau objet. Les additions au niveau objet sont réalisées par ldap_add().
| string | $dn | Le nom DN de l'entrée LDAP. |
| array | $entry | Entrée à remplacer dans l'annuaire |
Cette fonction retourne TRUE en cas de succès ou FALSE si une erreur survient.
mod_replace(string $dn,array $entry): boolean
Remplace l'attribut entry de l'entrée dn.
Elle effectue le remplacement au niveau attribut, par opposition au niveau objet. Les additions au niveau objet sont réalisées par ldap_modify().
| string | $dn | Le nom DN de l'entrée LDAP. |
| array | $entry | Entrée à remplacer dans l'annuaire |
Cette fonction retourne TRUE en cas de succès ou FALSE si une erreur survient.
mod_del(string $dn,array $entry): boolean
Efface l'attribut entry de l'entrée dn.
Elle effectue la modification au niveau attribut, par opposition au niveau objet. Les additions au niveau objet sont réalisées par ldap_delete().
| string | $dn | Le nom DN de l'entrée LDAP. |
| array | $entry | Entrée à remplacer dans l'annuaire |
Cette fonction retourne TRUE en cas de succès ou FALSE si une erreur survient.
modify(string $dn,array $entry): boolean
Modifie l'entrée identifiée par dn, avec les valeurs fournies dans entry.
La structure de entry est la même que détaillée dans ldap_add().
| string | $dn | Le nom DN de l'entrée LDAP. |
| array | $entry | Entrée à remplacer dans l'annuaire |
Cette fonction retourne TRUE en cas de succès ou FALSE si une erreur survient.
rename(string $dn,string $newrdn,string $newparent,boolean $deleteoldrdn): boolean
Renomme une entrée pour déplacer l'objet dans l'annuaire
| string | $dn | Le nom DN de l'entrée LDAP. |
| string | $newrdn | The new RDN. |
| string | $newparent | The new parent/superior entry. |
| boolean | $deleteoldrdn | If TRUE the old RDN value(s) is removed, else the old RDN value(s) is retained as non-distinguished values of the entry. |
Cette fonction retourne TRUE en cas de succès ou FALSE si une erreur survient.