[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/client/ -> ldap.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: ldap.php 14401 2010-01-26 14:10:00Z louis $
File Size: 487 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JLDAP:: (22 methods):
  __construct()
  connect()
  close()
  setDN()
  getDN()
  anonymous_bind()
  bind()
  simple_search()
  search()
  replace()
  modify()
  remove()
  compare()
  read()
  delete()
  create()
  add()
  rename()
  getErrorMsg()
  ipToNetAddress()
  LDAPNetAddr()
  generatePassword()


Class: JLDAP  - X-Ref

__construct($configObj = null)   X-Ref
Constructor

param: object An object of configuration variables

connect()   X-Ref
Connect to server

return: boolean True if successful

close()   X-Ref
Close the connection


setDN($username,$nosub = 0)   X-Ref
Sets the DN with some template replacements

param: string The username

getDN()   X-Ref

return: string The current dn

anonymous_bind()   X-Ref
Anonymously Binds to LDAP Directory


bind($username = null, $password = null, $nosub = 0)   X-Ref
Binds to the LDAP directory

param: string The username
param: string The password
return: boolean Result

simple_search($search)   X-Ref
Perform an LDAP search using comma seperated search strings

param: string search string of search values

search($filters, $dnoverride = null)   X-Ref
Perform an LDAP search

param: array Search Filters (array of strings)
param: string DN Override
return: array Multidimensional array of results

replace($dn, $attribute)   X-Ref
Replace an entry and return a true or false result

param: string dn The DN which contains the attribute you want to replace
param: string attribute The attribute values you want to replace
return: mixed result of comparison (true, false, -1 on error)

modify($dn, $attribute)   X-Ref
Modifies an entry and return a true or false result

param: string dn The DN which contains the attribute you want to modify
param: string attribute The attribute values you want to modify
return: mixed result of comparison (true, false, -1 on error)

remove($dn, $attribute)   X-Ref
Removes attribute value from given dn and return a true or false result

param: string dn The DN which contains the attribute you want to remove
param: string attribute The attribute values you want to remove
return: mixed result of comparison (true, false, -1 on error)

compare($dn, $attribute, $value)   X-Ref
Compare an entry and return a true or false result

param: string dn The DN which contains the attribute you want to compare
param: string attribute The attribute whose value you want to compare
param: string value The value you want to check against the LDAP attribute
return: mixed result of comparison (true, false, -1 on error)

read($dn, $attribute = array()   X-Ref
Read all or specified attributes of given dn

param: string dn The DN of the object you want to read
param: string attribute The attribute values you want to read (Optional)
return: array of attributes or -1 on error

delete($dn)   X-Ref
Deletes a given DN from the tree

param: string dn The DN of the object you want to delete
return: bool result of operation

create($dn, $entries)   X-Ref
Create a new DN

param: string dn The DN where you want to put the object
param: array entries An array of arrays describing the object to add
return: bool result of operation

add($dn, $entry)   X-Ref
Add an attribute to the given DN
Note: DN has to exist already

param: string dn The DN of the entry to add the attribute
param: array entry An array of arrays with attributes to add
return: bool Result of operation

rename($dn, $newdn, $newparent, $deleteolddn)   X-Ref
Rename the entry

param: string dn The DN of the entry at the moment
param: string newdn The DN of the entry should be (only cn=newvalue)
param: string newparent The full DN of the parent (null by default)
param: bool deleteolddn Delete the old values (default)
return: bool Result of operation

getErrorMsg()   X-Ref
Returns the error message

return: string error message

ipToNetAddress($ip)   X-Ref
Converts a dot notation IP address to net address (e.g. for Netware, etc)

param: string IP Address (e.g. xxx.xxx.xxx.xxx)
return: string Net address

LDAPNetAddr($networkaddress)   X-Ref
extract readable network address from the LDAP encoded networkAddress attribute.

author: Jay Burrell, Systems & Networks, Mississippi State University

generatePassword($password, $type='md5')   X-Ref
Generates a LDAP compatible password

param: string password Clear text password to encrypt
param: string type Type of password hash, either md5 or SHA
return: string encrypted password



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1