Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JLDAP
+ Graphe d'héritage de JLDAP:
+ Graphe de collaboration de JLDAP:

Liste de tous les membres

Fonctions membres publiques

 __construct ($configObj=null)
 connect ()
 close ()
 setDN ($username, $nosub=0)
 getDN ()
 anonymous_bind ()
 bind ($username=null, $password=null, $nosub=0)
 simple_search ($search)
 search ($filters, $dnoverride=null)
 replace ($dn, $attribute)
 modify ($dn, $attribute)
 remove ($dn, $attribute)
 compare ($dn, $attribute, $value)
 read ($dn, $attribute=array())
 delete ($dn)
 create ($dn, $entries)
 add ($dn, $entry)
 rename ($dn, $newdn, $newparent, $deleteolddn)
 getErrorMsg ()
 ipToNetAddress ($ip)
 LDAPNetAddr ($networkaddress)
 generatePassword ($password, $type= 'md5')
- Fonctions membres publiques inherited from JObject
 __toString ()
 def ($property, $default=null)
 get ($property, $default=null)
 getProperties ($public=true)
 getError ($i=null, $toString=true)
 getErrors ()
 set ($property, $value=null)
 setProperties ($properties)
 setError ($error)
 toString ()

Attributs publics

 $host = null
 $auth_method = null
 $port = null
 $base_dn = null
 $users_dn = null
 $search_string = null
 $use_ldapV3 = null
 $no_referrals = null
 $negotiate_tls = null
 $username = null
 $password = null

Attributs privés

 $_resource = null
 $_dn = null

Additional Inherited Members

- Attributs protégés inherited from JObject
 $_errors = array()

Documentation des constructeurs et destructeur

JLDAP::__construct (   $configObj = null)

Constructor

Paramètres:
object$configObjAn object of configuration variables
Depuis:
11.1

Réimplémentée à partir de JObject.


Documentation des fonctions membres

JLDAP::add (   $dn,
  $entry 
)

Add an attribute to the given DN Note: DN has to exist already

Paramètres:
string$dnThe DN of the entry to add the attribute
array$entryAn array of arrays with attributes to add
Renvoie:
boolean Result of operation
JLDAP::anonymous_bind ( )

Anonymously binds to LDAP directory

Renvoie:
array
Depuis:
11.1
JLDAP::bind (   $username = null,
  $password = null,
  $nosub = 0 
)

Binds to the LDAP directory

Paramètres:
string$usernameThe username
string$passwordThe password
string$nosub...
Renvoie:
boolean
Depuis:
11.1
JLDAP::close ( )

Close the connection

Renvoie:
void
Depuis:
11.1
JLDAP::compare (   $dn,
  $attribute,
  $value 
)

Compare an entry and return a true or false result

Paramètres:
string$dnThe DN which contains the attribute you want to compare
string$attributeThe attribute whose value you want to compare
string$valueThe value you want to check against the LDAP attribute
Renvoie:
mixed result of comparison (true, false, -1 on error)
Depuis:
11.1
JLDAP::connect ( )

Connect to server

Renvoie:
boolean True if successful
Depuis:
11.1
JLDAP::create (   $dn,
  $entries 
)

Create a new DN

Paramètres:
string$dnThe DN where you want to put the object
array$entriesAn array of arrays describing the object to add
Renvoie:
boolean Result of operation
JLDAP::delete (   $dn)

Deletes a given DN from the tree

Paramètres:
string$dnThe DN of the object you want to delete
Renvoie:
boolean Result of operation
JLDAP::generatePassword (   $password,
  $type = 'md5' 
)

Generates a LDAP compatible password

Paramètres:
string$passwordClear text password to encrypt
string$typeType of password hash, either md5 or SHA
Renvoie:
string Encrypted password
Depuis:
11.1

Références $type.

JLDAP::getDN ( )

Get the DN

Renvoie:
string The current dn
Depuis:
11.1
JLDAP::getErrorMsg ( )

Returns the error message

Renvoie:
string error message
Depuis:
11.1
JLDAP::ipToNetAddress (   $ip)

Converts a dot notation IP address to net address (e.g. for Netware, etc)

Paramètres:
string$ipIP Address (e.g. xxx.xxx.xxx.xxx)
Renvoie:
string Net address
Depuis:
11.1

Références $parts.

JLDAP::LDAPNetAddr (   $networkaddress)

Extract readable network address from the LDAP encoded networkAddress attribute.

Please keep this document block and author attribution in place.

Novell Docs, see: http://developer.novell.com/ndk/doc/ndslib/schm_enu/data/sdk5624.html#sdk5624 for Address types: http://developer.novell.com/ndk/doc/ndslib/index.html?page=/ndk/doc/ndslib/schm_enu/data/sdk4170.html LDAP Format, String: taggedData = uint32String "#" octetstring byte 0 = uint32String = Address Type: 0= IPX Address; 1 = IP Address byte 1 = char = "#" - separator byte 2+ = octetstring - the ordinal value of the address Note: with eDirectory 8.6.2, the IP address (type 1) returns correctly, however, an IPX address does not seem to. eDir 8.7 may correct this. Enhancement made by Merijn van de Schoot: If addresstype is 8 (UDP) or 9 (TCP) do some additional parsing like still returning the IP address

Paramètres:
string$networkaddressThe network address
Renvoie:
array
Auteur:
Jay Burrell, Systems & Networks, Mississippi State University
Depuis:
11.1

Références $i, et JText\_().

+ Voici le graphe d'appel pour cette fonction :

JLDAP::modify (   $dn,
  $attribute 
)

Modifies an entry and return a true or false result

Paramètres:
string$dnThe DN which contains the attribute you want to modify
string$attributeThe attribute values you want to modify
Renvoie:
mixed result of comparison (true, false, -1 on error)
Depuis:
11.1
JLDAP::read (   $dn,
  $attribute = array() 
)

Read all or specified attributes of given dn

Paramètres:
string$dnThe DN of the object you want to read
string$attributeThe attribute values you want to read (Optional)
Renvoie:
mixed array of attributes or -1 on error
Depuis:
11.1

Références $base.

JLDAP::remove (   $dn,
  $attribute 
)

Removes attribute value from given dn and return a true or false result

Paramètres:
string$dnThe DN which contains the attribute you want to remove
string$attributeThe attribute values you want to remove
Renvoie:
mixed result of comparison (true, false, -1 on error)
Depuis:
11.1
JLDAP::rename (   $dn,
  $newdn,
  $newparent,
  $deleteolddn 
)

Rename the entry

Paramètres:
string$dnThe DN of the entry at the moment
string$newdnThe DN of the entry should be (only cn=newvalue)
string$newparentThe full DN of the parent (null by default)
boolean$deleteolddnDelete the old values (default)
Renvoie:
boolean Result of operation
Depuis:
11.1
JLDAP::replace (   $dn,
  $attribute 
)

Replace an entry and return a true or false result

Paramètres:
string$dnThe DN which contains the attribute you want to replace
string$attributeThe attribute values you want to replace
Renvoie:
mixed result of comparison (true, false, -1 on error)
Depuis:
11.1
JLDAP::search (   $filters,
  $dnoverride = null 
)

Perform an LDAP search

Paramètres:
array$filtersSearch Filters (array of strings)
string$dnoverrideDN Override
Renvoie:
array Multidimensional array of results
Depuis:
11.1

Références $count, et $i.

JLDAP::setDN (   $username,
  $nosub = 0 
)

Sets the DN with some template replacements

Paramètres:
string$usernameThe username
string$nosub...
Renvoie:
void
Depuis:
11.1

Références elseif.

JLDAP::simple_search (   $search)

Perform an LDAP search using comma separated search strings

Paramètres:
string$searchsearch string of search values
Renvoie:
array Search results
Depuis:
11.1

Références $key.


Documentation des données membres

JLDAP::$_dn = null
private
JLDAP::$_resource = null
private
JLDAP::$auth_method = null
JLDAP::$base_dn = null
JLDAP::$host = null
JLDAP::$negotiate_tls = null
JLDAP::$no_referrals = null
JLDAP::$password = null
JLDAP::$port = null
JLDAP::$search_string = null
JLDAP::$use_ldapV3 = null
JLDAP::$username = null
JLDAP::$users_dn = null

La documentation de cette classe a été générée à partir du fichier suivant :