API Joomla 1.5.26
Documentation des API du CMS Joomla en version 1.5

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

Attributs publics


Documentation des constructeurs et destructeur

JLDAP::__construct ( configObj = null)

Constructor

Paramètres:
objectAn object of configuration variables public

Documentation des fonctions membres

JLDAP::add ( dn,
entry 
)

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

Paramètres:
stringdn The DN of the entry to add the attribute
arrayentry An array of arrays with attributes to add
Renvoie:
bool Result of operation
JLDAP::anonymous_bind ( )

Anonymously Binds to LDAP Directory

JLDAP::bind ( username = null,
password = null,
nosub = 0 
)

Binds to the LDAP directory

Paramètres:
stringThe username
stringThe password
Renvoie:
boolean Result public
JLDAP::close ( )

Close the connection public

JLDAP::compare ( dn,
attribute,
value 
)

Compare an entry and return a true or false result

Paramètres:
stringdn The DN which contains the attribute you want to compare
stringattribute The attribute whose value you want to compare
stringvalue The value you want to check against the LDAP attribute
Renvoie:
mixed result of comparison (true, false, -1 on error) public
JLDAP::connect ( )

Connect to server

Renvoie:
boolean True if successful public
JLDAP::create ( dn,
entries 
)

Create a new DN

Paramètres:
stringdn The DN where you want to put the object
arrayentries An array of arrays describing the object to add
Renvoie:
bool result of operation
JLDAP::delete ( dn)

Deletes a given DN from the tree

Paramètres:
stringdn The DN of the object you want to delete
Renvoie:
bool result of operation public
JLDAP::generatePassword ( password,
type = 'md5' 
)

Generates a LDAP compatible password

Paramètres:
stringpassword Clear text password to encrypt
stringtype Type of password hash, either md5 or SHA
Renvoie:
string encrypted password

Références $type.

JLDAP::getDN ( )
Renvoie:
string The current dn public
JLDAP::getErrorMsg ( )

Returns the error message

Renvoie:
string error message
JLDAP::ipToNetAddress ( ip)

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

Paramètres:
stringIP Address (e.g. xxx.xxx.xxx.xxx)
Renvoie:
string Net address public

Références $parts.

JLDAP::LDAPNetAddr ( networkaddress)

extract readable network address from the LDAP encoded networkAddress attribute.

Auteur:
Jay Burrell, Systems & Networks, Mississippi State University 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

Références $i.

JLDAP::modify ( dn,
attribute 
)

Modifies an entry and return a true or false result

Paramètres:
stringdn The DN which contains the attribute you want to modify
stringattribute The attribute values you want to modify
Renvoie:
mixed result of comparison (true, false, -1 on error)
JLDAP::read ( dn,
attribute = array() 
)

Read all or specified attributes of given dn

Paramètres:
stringdn The DN of the object you want to read
stringattribute The attribute values you want to read (Optional)
Renvoie:
array of attributes or -1 on error public
JLDAP::remove ( dn,
attribute 
)

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

Paramètres:
stringdn The DN which contains the attribute you want to remove
stringattribute The attribute values you want to remove
Renvoie:
mixed result of comparison (true, false, -1 on error)
JLDAP::rename ( dn,
newdn,
newparent,
deleteolddn 
)

Rename the entry

Paramètres:
stringdn The DN of the entry at the moment
stringnewdn The DN of the entry should be (only cn=newvalue)
stringnewparent The full DN of the parent (null by default)
booldeleteolddn Delete the old values (default)
Renvoie:
bool Result of operation
JLDAP::replace ( dn,
attribute 
)

Replace an entry and return a true or false result

Paramètres:
stringdn The DN which contains the attribute you want to replace
stringattribute The attribute values you want to replace
Renvoie:
mixed result of comparison (true, false, -1 on error)
JLDAP::search ( filters,
dnoverride = null 
)

Perform an LDAP search

Paramètres:
arraySearch Filters (array of strings)
stringDN Override
Renvoie:
array Multidimensional array of results public

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

JLDAP::setDN ( username,
nosub = 0 
)

Sets the DN with some template replacements

Paramètres:
stringThe username public
JLDAP::simple_search ( search)

Perform an LDAP search using comma seperated search strings

Paramètres:
stringsearch string of search values

Documentation des données membres

JLDAP::$_dn = null
JLDAP::$_resource = null
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 :