lib

# Class: cache Source Location: /lib/cache.inc
### Class Overview
This class contains all functions which are needed to manage the LDAP cache. | ### Variables $attributes $ldapcache $time | ### Methods cache add_cache findgroups getgid getgrnam get_cache in_cache refresh_cache __sleep __wakeup
### Class Details [line 40] This class contains all functions which are needed to manage the LDAP cache. [ Top ] ### Class Variables #### $attributes = [line 47]
Type: | mixed
[ Top ] #### $ldapcache = [line 46]
Type: | mixed
[ Top ] #### $time = [line 48]
Type: | mixed
[ Top ] ### Class Methods ### constructor cache [line 41]
`cache cache( )`
[ Top ] ### method add_cache [line 53]
`void add_cache( mixed $attributes)`
[ Top ] ### method findgroups [line 215]
`void findgroups( )`
[ Top ] ### method getgid [line 199]
`string getgid( string $groupname)`
This function will return the GID number to an existing group name (using the cache). #### Tags:
return: | GID number
#### Parameters:
string | $groupname | name of group
[ Top ] ### method getgrnam [line 230]
`void getgrnam( mixed $gidNumber)`
[ Top ] ### method get_cache [line 82]
`array get_cache( mixed $attributes, string $objectClass, mixed $scopelist, mixed $scope)`
Queries the cache for a list of LDAP entries and their attributes. #### Tags:
return: | The found LDAP entries. Format: array(dn1 => array(uidnumber1), dn2 => array(uidnumber2), ... ) if $attributes is of type string or array(dn1 => array(uid => array(myuid), uidNumber => array(1234)), ... ) if $attributes is an array
#### Parameters:
mixed | $attributes | One (string) or many (array) attribute names.
string | $objectClass | The resulting entries need to contain this object class.
mixed | $scope | the account type(s) as string or array
[ Top ] ### method in_cache [line 123]
`void in_cache( mixed $value, mixed $attribute, mixed $scopelist)`
[ Top ] ### method refresh_cache [line 154]
`void refresh_cache( [mixed $rebuild = false])`
[ Top ] ### method __sleep [line 248]
`array __sleep( )`
Encrypts LDAP cache before saving to session file. #### Tags:
return: | list of variables to save
[ Top ] ### method __wakeup [line 257]
`void __wakeup( )`
Decrypts LDAP cache after loading from session file. [ Top ] Documentation generated on Tue, 07 Feb 2006 17:03:35 +0100 by phpDocumentor 1.2.3