Public Member Functions | |
__construct ($options=array()) | |
__destruct () | |
getResource () | |
getLastErrorCode () | |
getLastError (&$errorCode=null, array &$errorMessages=null) | |
setOptions ($options) | |
getOptions () | |
getBaseDn () | |
getCanonicalAccountName ($acctname, $form=0) | |
disconnect () | |
connect ($host=null, $port=null, $useSsl=null, $useStartTls=null) | |
bind ($username=null, $password=null) | |
search ($filter, $basedn=null, $scope=self::SEARCH_SCOPE_SUB, array $attributes=array(), $sort=null, $collectionClass=null) | |
count ($filter, $basedn=null, $scope=self::SEARCH_SCOPE_SUB) | |
countChildren ($dn) | |
exists ($dn) | |
searchEntries ($filter, $basedn=null, $scope=self::SEARCH_SCOPE_SUB, array $attributes=array(), $sort=null) | |
getEntry ($dn, array $attributes=array(), $throwOnNotFound=false) | |
add ($dn, array $entry) | |
update ($dn, array $entry) | |
save ($dn, array $entry) | |
delete ($dn, $recursively=false) | |
moveToSubtree ($from, $to, $recursively=false, $alwaysEmulate=false) | |
move ($from, $to, $recursively=false, $alwaysEmulate=false) | |
rename ($from, $to, $recursively=false, $alwaysEmulate=false) | |
copyToSubtree ($from, $to, $recursively=false) | |
copy ($from, $to, $recursively=false) | |
getNode ($dn) | |
getBaseNode () | |
getRootDse () | |
getSchema () | |
Static Public Member Functions | |
static | filterEscape ($str) |
static | explodeDn ($dn, array &$keys=null, array &$vals=null) |
static | prepareLdapEntryArray (array &$entry) |
Data Fields | |
const | SEARCH_SCOPE_SUB = 1 |
const | SEARCH_SCOPE_ONE = 2 |
const | SEARCH_SCOPE_BASE = 3 |
const | ACCTNAME_FORM_DN = 1 |
const | ACCTNAME_FORM_USERNAME = 2 |
const | ACCTNAME_FORM_BACKSLASH = 3 |
const | ACCTNAME_FORM_PRINCIPAL = 4 |
Protected Member Functions | |
_getHost () | |
_getPort () | |
_getUseSsl () | |
_getUsername () | |
_getPassword () | |
_getBindRequiresDn () | |
_getAccountCanonicalForm () | |
_getAccountDomainName () | |
_getAccountDomainNameShort () | |
_getAccountFilterFormat () | |
_getAllowEmptyPassword () | |
_getUseStartTls () | |
_getOptReferrals () | |
_getTryUsernameSplit () | |
_getAccountFilter ($acctname) | |
_splitName ($name, &$dname, &$aname) | |
_getAccountDn ($acctname) | |
_isPossibleAuthority ($dname) | |
_getAccount ($acctname, array $attrs=null) | |
_getChildrenDns ($parentDn) | |
Protected Attributes | |
$_options = null | |
$_resource = null | |
$_rootDse = null | |
$_schema = null |
Definition at line 29 of file Ldap.php.
__construct | ( | $ | options = array() ) |
Constructor.
array | Zend_Config | $options | Options used in connecting, binding, etc. |
_getAccount | ( | $ | acctname, |
array $ | attrs = null |
||
) | [protected] |
array | $attrs | An array of names of desired attributes |
Zend_Ldap_Exception |
_getAccountCanonicalForm | ( | ) | [protected] |
_getAccountDn | ( | $ | acctname ) | [protected] |
_getAccountDomainName | ( | ) | [protected] |
_getAccountDomainNameShort | ( | ) | [protected] |
_getAccountFilter | ( | $ | acctname ) | [protected] |
_getAccountFilterFormat | ( | ) | [protected] |
_getAllowEmptyPassword | ( | ) | [protected] |
_getBindRequiresDn | ( | ) | [protected] |
_getChildrenDns | ( | $ | parentDn ) | [protected] |
_getHost | ( | ) | [protected] |
_getOptReferrals | ( | ) | [protected] |
_getPassword | ( | ) | [protected] |
_getPort | ( | ) | [protected] |
_getTryUsernameSplit | ( | ) | [protected] |
_getUsername | ( | ) | [protected] |
_getUseSsl | ( | ) | [protected] |
_getUseStartTls | ( | ) | [protected] |
_isPossibleAuthority | ( | $ | dname ) | [protected] |
_splitName | ( | $ | name, |
&$ | dname, | ||
&$ | aname | ||
) | [protected] |
add | ( | $ | dn, |
array $ | entry | ||
) |
bind | ( | $ | username = null , |
$ | password = null |
||
) |
string | $username | The username for authenticating the bind |
string | $password | The password for authenticating the bind |
Zend_Ldap_Exception |
connect | ( | $ | host = null , |
$ | port = null , |
||
$ | useSsl = null , |
||
$ | useStartTls = null |
||
) |
string | $host | The hostname of the LDAP server to connect to |
int | $port | The port number of the LDAP server to connect to |
boolean | $useSsl | Use SSL |
boolean | $useStartTls | Use STARTTLS |
Zend_Ldap_Exception |
copy | ( | $ | from, |
$ | to, | ||
$ | recursively = false |
||
) |
copyToSubtree | ( | $ | from, |
$ | to, | ||
$ | recursively = false |
||
) |
count | ( | $ | filter, |
$ | basedn = null , |
||
$ | scope = self::SEARCH_SCOPE_SUB |
||
) |
countChildren | ( | $ | dn ) |
delete | ( | $ | dn, |
$ | recursively = false |
||
) |
disconnect | ( | ) |
exists | ( | $ | dn ) |
static explodeDn | ( | $ | dn, |
array &$ | keys = null , |
||
array &$ | vals = null |
||
) | [static] |
string | $dn | The DN to parse |
array | $keys | An optional array to receive DN keys (e.g. CN, OU, DC, ...) |
array | $vals | An optional array to receive DN values |
static filterEscape | ( | $ | str ) | [static] |
string | $str | The string to escape. |
getBaseDn | ( | ) |
getBaseNode | ( | ) |
getCanonicalAccountName | ( | $ | acctname, |
$ | form = 0 |
||
) |
string | $acctname | The name to canonicalize |
int | $type | The desired form of canonicalization |
Zend_Ldap_Exception |
getEntry | ( | $ | dn, |
array $ | attributes = array() , |
||
$ | throwOnNotFound = false |
||
) |
getLastError | ( | &$ | errorCode = null , |
array &$ | errorMessages = null |
||
) |
getLastErrorCode | ( | ) |
getNode | ( | $ | dn ) |
getResource | ( | ) |
getRootDse | ( | ) |
getSchema | ( | ) |
move | ( | $ | from, |
$ | to, | ||
$ | recursively = false , |
||
$ | alwaysEmulate = false |
||
) |
moveToSubtree | ( | $ | from, |
$ | to, | ||
$ | recursively = false , |
||
$ | alwaysEmulate = false |
||
) |
static prepareLdapEntryArray | ( | array &$ | entry ) | [static] |
rename | ( | $ | from, |
$ | to, | ||
$ | recursively = false , |
||
$ | alwaysEmulate = false |
||
) |
Renames a LDAP entry from one DN to another DN.
This method implicitely moves the entry to another location within the tree.
string | Zend_Ldap_Dn | $from | |
string | Zend_Ldap_Dn | $to | |
boolean | $recursively | |
boolean | $alwaysEmulate |
Zend_Ldap_Exception |
save | ( | $ | dn, |
array $ | entry | ||
) |
search | ( | $ | filter, |
$ | basedn = null , |
||
$ | scope = self::SEARCH_SCOPE_SUB , |
||
array $ | attributes = array() , |
||
$ | sort = null , |
||
$ | collectionClass = null |
||
) |
A global LDAP search routine for finding information.
string | Zend_Ldap_Filter_Abstract | $filter | |
string | Zend_Ldap_Dn | null | $basedn | |
integer | $scope | |
array | $attributes | |
string | null | $sort | |
string | null | $collectionClass |
Zend_Ldap_Exception |
Zend_Ldap_Collection_Iterator_Default
Zend_Ldap_Collection
searchEntries | ( | $ | filter, |
$ | basedn = null , |
||
$ | scope = self::SEARCH_SCOPE_SUB , |
||
array $ | attributes = array() , |
||
$ | sort = null |
||
) |
Search LDAP registry for entries matching filter and optional attributes
string | Zend_Ldap_Filter_Abstract | $filter | |
string | Zend_Ldap_Dn | null | $basedn | |
integer | $scope | |
array | $attributes | |
string | null | $sort |
Zend_Ldap_Exception |
setOptions | ( | $ | options ) |
Sets the options used in connecting, binding, etc.
Valid option keys: host port useSsl username password bindRequiresDn baseDn accountCanonicalForm accountDomainName accountDomainNameShort accountFilterFormat allowEmptyPassword useStartTls optRefferals tryUsernameSplit
array | Zend_Config | $options | Options used in connecting, binding, etc. |
Zend_Ldap_Exception |
update | ( | $ | dn, |
array $ | entry | ||
) |