2006-11-15 17:12:15 +00:00
< html >
< head >
< title > Docs For Class cache< / title >
< link rel = "stylesheet" type = "text/css" href = "../media/style.css" >
< / head >
< body >
< table border = "0" cellspacing = "0" cellpadding = "0" height = "48" width = "100%" >
< tr >
< td class = "header_top" > lib< / td >
< / tr >
< tr > < td class = "header_line" > < img src = "../media/empty.png" width = "1" height = "1" border = "0" alt = "" / > < / td > < / tr >
< tr >
< td class = "header_menu" >
2007-11-04 11:19:11 +00:00
[ < a href = "../classtrees_lib.html" class = "menu" > class tree: lib< / a > ]
2006-11-15 17:12:15 +00:00
[ < a href = "../elementindex_lib.html" class = "menu" > index: lib< / a > ]
2007-11-04 11:19:11 +00:00
[ < a href = "../elementindex.html" class = "menu" > all elements< / a > ]
2006-11-15 17:12:15 +00:00
< / td >
< / tr >
< tr > < td class = "header_line" > < img src = "../media/empty.png" width = "1" height = "1" border = "0" alt = "" / > < / td > < / tr >
< / table >
< table width = "100%" border = "0" cellpadding = "0" cellspacing = "0" >
< tr valign = "top" >
< td width = "200" class = "menu" >
< div id = "ric" >
< p > < a href = "../ric_INSTALL.html" > INSTALL< / a > < / p >
2007-11-04 11:19:11 +00:00
< p > < a href = "../ric_README.html" > README< / a > < / p >
2006-11-15 17:12:15 +00:00
< / div >
< b > Packages:< / b > < br / >
< a href = "../li_configuration.html" > configuration< / a > < br / >
< a href = "../li_Help.html" > Help< / a > < br / >
< a href = "../li_LDAP.html" > LDAP< / a > < br / >
< a href = "../li_lib.html" > lib< / a > < br / >
< a href = "../li_lists.html" > lists< / a > < br / >
< a href = "../li_main.html" > main< / a > < br / >
< a href = "../li_modules.html" > modules< / a > < br / >
< a href = "../li_PDF.html" > PDF< / a > < br / >
< a href = "../li_profiles.html" > profiles< / a > < br / >
< a href = "../li_selfService.html" > selfService< / a > < br / >
< a href = "../li_tests.html" > tests< / a > < br / >
< a href = "../li_tools.html" > tools< / a > < br / >
< a href = "../li_types.html" > types< / a > < br / >
< br / > < br / >
< b > Files:< / b > < br / >
< div class = "package" >
2007-11-04 11:19:11 +00:00
< a href = "../lib/_lib---account.inc.html" > account.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../lib/_lib---cache.inc.html" > cache.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../lib/_lib---schema.inc.html" > schema.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../lib/_lib---security.inc.html" > security.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../lib/_lib---status.inc.html" > status.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
< / div > < br / >
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
< b > Classes:< / b > < br / >
< div class = "package" >
< a href = "../lib/AttributeType.html" > AttributeType< / a > < br / >
< a href = "../lib/cache.html" > cache< / a > < br / >
< a href = "../lib/MatchingRule.html" > MatchingRule< / a > < br / >
< a href = "../lib/MatchingRuleUse.html" > MatchingRuleUse< / a > < br / >
< a href = "../lib/ObjectClass.html" > ObjectClass< / a > < br / >
< a href = "../lib/ObjectClassAttribute.html" > ObjectClassAttribute< / a > < br / >
< a href = "../lib/SchemaItem.html" > SchemaItem< / a > < br / >
< a href = "../lib/Syntax.html" > Syntax< / a > < br / >
< / div >
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
< / td >
< td >
< table cellpadding = "10" cellspacing = "0" width = "100%" border = "0" > < tr > < td valign = "top" >
< h1 > Class: cache< / h1 >
Source Location: /lib/cache.inc< br / > < br / >
< table width = "100%" border = "0" >
< tr > < td valign = "top" >
< h3 > < a href = "#class_details" > Class Overview< / a > < / h3 >
< pre > < / pre > < br / >
< div class = "description" > This class contains all functions which are needed to manage the LDAP cache.< / div > < br / > < br / >
< / td >
< td valign = "top" >
< h3 > < a href = "#class_methods" > Methods< / a > < / h3 >
< ul >
< li > < a href = "../lib/cache.html#methodcache" > cache< / a > < / li >
< li > < a href = "../lib/cache.html#methodadd_cache" > add_cache< / a > < / li >
< li > < a href = "../lib/cache.html#methodfindgroups" > findgroups< / a > < / li >
< li > < a href = "../lib/cache.html#methodgetgid" > getgid< / a > < / li >
< li > < a href = "../lib/cache.html#methodgetgrnam" > getgrnam< / a > < / li >
< li > < a href = "../lib/cache.html#methodget_cache" > get_cache< / a > < / li >
< li > < a href = "../lib/cache.html#methodin_cache" > in_cache< / a > < / li >
< li > < a href = "../lib/cache.html#methodrefresh_cache" > refresh_cache< / a > < / li >
< li > < a href = "../lib/cache.html#method__sleep" > __sleep< / a > < / li >
< li > < a href = "../lib/cache.html#method__wakeup" > __wakeup< / a > < / li >
< / ul >
< / td >
< / tr > < / table >
< hr / >
< table width = "100%" border = "0" > < tr >
< / tr > < / table >
< hr / >
< a name = "class_details" > < / a >
< h3 > Class Details< / h3 >
< div class = "tags" >
2007-11-04 11:19:11 +00:00
[line 42]< br / >
2006-11-15 17:12:15 +00:00
This class contains all functions which are needed to manage the LDAP cache.< br / > < br / > < / div > < br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div > < br / >
< hr / >
< a name = "class_methods" > < / a >
< h3 > Class Methods< / h3 >
< div class = "tags" >
< hr / >
< a name = "methodcache" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > constructor cache < span class = "smalllinenumber" > [line 56]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > < a href = "../lib/cache.html" > cache< / a > cache(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Constructor.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > cache object< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodadd_cache" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method add_cache < span class = "smalllinenumber" > [line 66]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > void add_cache(
array
$attributes)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
This function adds attributes to the cache.< br / > < br / > < br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > array < / td >
< td > < b > $attributes< / b > < / td >
< td > syntax: is array( scope1 => array ( attributes ), scope2 => array ( attributes ), ...)< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodfindgroups" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method findgroups < span class = "smalllinenumber" > [line 241]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array findgroups(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
This function returns an array with all group names which were found in the LDAP directory.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > group names< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetgid" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method getgid < span class = "smalllinenumber" > [line 223]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > string getgid(
string
$groupname)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
This function will return the GID number to an existing group name (using the cache).< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > GID number< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > string < / td >
< td > < b > $groupname< / b > < / td >
< td > name of group< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetgrnam" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method getgrnam < span class = "smalllinenumber" > [line 259]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > < a href = "../types/group.html" > group< / a > getgrnam(
string
$gidNumber)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
This function returns the group name to an existing gidNumber.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > name< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > string < / td >
< td > < b > $gidNumber< / b > < / td >
< td > GID number< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_cache" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_cache < span class = "smalllinenumber" > [line 95]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array get_cache(
mixed
$attributes, string
$objectClass, mixed
$scopelist)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Queries the cache for a list of LDAP entries and their attributes.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > The found LDAP entries. < br / > Format: array(dn1 => array(uidnumber1), dn2 => array(uidnumber2), ... ) if $attributes is of type string < br / > or array(dn1 => array(uid => array(myuid), uidNumber => array(1234)), ... ) if $attributes is an array< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > mixed < / td >
< td > < b > $attributes< / b > < / td >
< td > One (string) or many (array) attribute names.< / td >
< / tr >
< tr >
< td class = "type" > string < / td >
< td > < b > $objectClass< / b > < / td >
< td > The resulting entries need to contain this object class.< / td >
< / tr >
< tr >
< td class = "type" > mixed < / td >
< td > < b > $scopelist< / b > < / td >
< td > the account type(s) as string or array, all scopes if NULL given< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodin_cache" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method in_cache < span class = "smalllinenumber" > [line 140]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > void in_cache(
string
$value, string
$attribute, mixed
$scopelist)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
This function returns the DN if an LDAP entry with $attribute=$value is found.< br / > < br / > < br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > string < / td >
< td > < b > $value< / b > < / td >
< td > is the searched value of the attribute $attribute< / td >
< / tr >
< tr >
< td class = "type" > string < / td >
< td > < b > $attribute< / b > < / td >
< td > name of the LDAP attribute< / td >
< / tr >
< tr >
< td class = "type" > mixed < / td >
< td > < b > $scopelist< / b > < / td >
< td > the account type(s) as string or array, all scopes if NULL given< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodrefresh_cache" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method refresh_cache < span class = "smalllinenumber" > [line 175]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > void refresh_cache(
[boolean
$rebuild = false])< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
This function refreshes the cache.< br / > < br / > < br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > boolean < / td >
< td > < b > $rebuild< / b > < / td >
< td > forces a refresh if set to true< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "method__sleep" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method __sleep < span class = "smalllinenumber" > [line 277]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > array __sleep(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Encrypts LDAP cache before saving to session file.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > list of variables to save< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "method__wakeup" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method __wakeup < span class = "smalllinenumber" > [line 286]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< div class = "function" >
< table width = "90%" border = "0" cellspacing = "0" cellpadding = "1" > < tr > < td class = "code_border" >
< table width = "100%" border = "0" cellspacing = "0" cellpadding = "2" > < tr > < td class = "code" >
< code > void __wakeup(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Decrypts LDAP cache after loading from session file.< br / > < br / > < br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< / div > < br / >
< div class = "credit" >
< hr / >
2007-11-04 11:19:11 +00:00
Documentation generated on Sun, 04 Nov 2007 12:10:40 +0100 by < a href = "http://www.phpdoc.org" > phpDocumentor 1.4.0< / a >
2006-11-15 17:12:15 +00:00
< / div >
< / td > < / tr > < / table >
< / td >
< / tr >
< / table >
< / body >
< / html >
