lib

# Element index for package lib

[ a ] [ c ] [ d ] [ e ] [ f ] [ g ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ _ ]

## _

_get_raw_schema
  in file schema.inc, function _get_raw_schema()
  Fetches the raw schema array for the subschemaSubentry of the server. Note, this function has grown many hairs to accomodate more LDAP servers. It is needfully complicated as it now supports many popular LDAP servers that don't necessarily expose their schema "the right way".
_get_schema_dn
  in file schema.inc, function _get_schema_dn()
  Helper for _get_raw_schema() which fetches the DN of the schema object
__construct
  in file cache.inc, method cache::__construct()
  Constructor.
__sleep
  in file cache.inc, method cache::__sleep()
  Encrypts LDAP cache before saving to session file.
__wakeup
  in file cache.inc, method cache::__wakeup()
  Decrypts LDAP cache after loading from session file.

top

## a

$aliases
  in file schema.inc, variable AttributeType::$aliases
  An array of alias attribute names, strings
addAlias
  in file schema.inc, method AttributeType::addAlias()
  Adds an attribute name to the alias array.
addChildObjectClass
  in file schema.inc, method ObjectClass::addChildObjectClass()
  Adds an objectClass to the list of objectClasses that inherit from this objectClass.
addMayAttrs
  in file schema.inc, method ObjectClass::addMayAttrs()
  Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.
addMustAttrs
  in file schema.inc, method ObjectClass::addMustAttrs()
  Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.
addRequiredByObjectClass
  in file schema.inc, method AttributeType::addRequiredByObjectClass()
  Adds an objectClass name to this attribute's list of "required by" objectClasses, that is the list of objectClasses which must have this attribute.
addUsedByAttr
  in file schema.inc, method MatchingRule::addUsedByAttr()
  Adds an attribute name to the list of attributes who use this MatchingRule
addUsedInObjectClass
  in file schema.inc, method AttributeType::addUsedInObjectClass()
  Adds an objectClass name to this attribute's list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.
add_aliases_to_attrs
  in file schema.inc, function add_aliases_to_attrs()
  For each attribute that has multiple names, this function adds unique entries to the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.
add_cache
  in file cache.inc, method cache::add_cache()
  This function adds attributes to the cache.
add_sup_to_attrs
  in file schema.inc, function add_sup_to_attrs()
  Adds inherited values to each attributeType specified by the SUP directive.
array_delete
  in file account.inc, function array_delete()
  This function will return all values from $array without values of $values.
AttributeType
  in file schema.inc, method AttributeType::AttributeType()
  Creates a new AttributeType objcet from a raw LDAP AttributeType string.
AttributeType
  in file schema.inc, class AttributeType
  Represents an LDAP AttributeType
account.inc
  procedural page account.inc

top

## c

$children_objectclasses
  in file schema.inc, variable ObjectClass::$children_objectclasses
  array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)
cache
  in file cache.inc, class cache
  This class contains all functions which are needed to manage the LDAP cache.
cached_schema_available
  in file schema.inc, function cached_schema_available()
  Returns true if the schema for $schema_type has been cached and
checkClientIP
  in file security.inc, function checkClientIP()
  Checks if the client's IP address is on the list of allowed IPs.
checkIfPasswordChangeIsAllowed
  in file security.inc, function checkIfPasswordChangeIsAllowed()
  Checks if passwords may be changed.
checkIfWriteAccessIsAllowed
  in file security.inc, function checkIfWriteAccessIsAllowed()
  Checks if write access to LDAP is allowed.
checkPasswordStrength
  in file security.inc, function checkPasswordStrength()
  Checks if the password fulfills the password policies.
cmp_domain
  in file account.inc, function cmp_domain()
  Helper function to sort the domains
cache.inc
  procedural page cache.inc

top

## d

$description
  in file schema.inc, variable SchemaItem::$description
  The description of this schema item.

top

## e

$equality
  in file schema.inc, variable AttributeType::$equality
  The equality rule used
escapeDN
  in file account.inc, function escapeDN()
  Escapes any special characters in an LDAP DN.

top

## f

findgroups
  in file cache.inc, method cache::findgroups()
  This function returns an array with all group names which were found in the LDAP directory.

top

## g

generateRandomPassword
  in file account.inc, function generateRandomPassword()
  Generates a random password with 12 digits.
getAliases
  in file schema.inc, method AttributeType::getAliases()
  Gets the names of attributes that are an alias for this attribute (if any).
getChildObjectClasses
  in file schema.inc, method ObjectClass::getChildObjectClasses()
  Returns the array of objectClass names which inherit from this objectClass.
getdays
  in file account.inc, function getdays()
  This function will return the days from 1.1.1970 until now.
getDescription
  in file schema.inc, method SchemaItem::getDescription()
getEquality
  in file schema.inc, method AttributeType::getEquality()
  Gets this attribute's equality string
getgid
  in file cache.inc, method cache::getgid()
  This function will return the GID number to an existing group name (using the cache).
getgrnam
  in file cache.inc, method cache::getgrnam()
  This function returns the group name to an existing gidNumber.
getIsCollective
  in file schema.inc, method AttributeType::getIsCollective()
  Gets whether this attribute is collective.
getIsNoUserModification
  in file schema.inc, method AttributeType::getIsNoUserModification()
  Gets whether this attribute is not modifiable by users.
getIsObsolete
  in file schema.inc, method AttributeType::getIsObsolete()
  Gets whether this attribute has been flagged as obsolete by the LDAP server
getIsObsolete
  in file schema.inc, method ObjectClass::getIsObsolete()
  Gets whether this objectClass is flagged as obsolete by the LDAP server.
getIsObsolete
  in file schema.inc, method MatchingRule::getIsObsolete()
  Gets whether this MatchingRule is flagged as obsolete by the LDAP server.
getIsSingleValue
  in file schema.inc, method AttributeType::getIsSingleValue()
  Gets whether this attribute is single-valued. If this attribute only supports single values, true is returned. If this attribute supports multiple values, false is returned.
getMaxLength
  in file schema.inc, method AttributeType::getMaxLength()
  Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.
getMayAttrNames
  in file schema.inc, method ObjectClass::getMayAttrNames()
  Gets an array of attribute names (strings) that entries of this ObjectClass must define.
getMayAttrs
  in file schema.inc, method ObjectClass::getMayAttrs()
  Gets an array of AttributeType objects that entries of this ObjectClass may define.
getMustAttrNames
  in file schema.inc, method ObjectClass::getMustAttrNames()
  Gets an array of attribute names (strings) that entries of this ObjectClass must define.
getMustAttrs
  in file schema.inc, method ObjectClass::getMustAttrs()
  Gets an array of AttributeType objects that entries of this ObjectClass must define.
getName
  in file schema.inc, method MatchingRule::getName()
  Gets this MatchingRule's name.
getName
  in file schema.inc, method MatchingRuleUse::getName()
  Gets this MatchingRuleUse's name
getName
  in file schema.inc, method AttributeType::getName()
  Gets this attribute's name
getName
  in file schema.inc, method ObjectClass::getName()
  Gets the name of this objectClass (ie, "inetOrgPerson")
getName
  in file schema.inc, method ObjectClassAttribute::getName()
  Gets this attribute's name
getOID
  in file schema.inc, method SchemaItem::getOID()
getOrdering
  in file schema.inc, method AttributeType::getOrdering()
  Gets this attribute's ordering specification.
getRequiredByObjectClasses
  in file schema.inc, method AttributeType::getRequiredByObjectClasses()
  Gets the list of "required by" objectClasses, that is the list of objectClasses which provide must have attribute.
getshells
  in file account.inc, function getshells()
  Returns a list of shells listed in config/shells.
getSource
  in file schema.inc, method ObjectClassAttribute::getSource()
  Gets the name of the ObjectClass which originally specified this attribute.
getSubstr
  in file schema.inc, method AttributeType::getSubstr()
  Gets this attribute's substring matching specification
getSupAttribute
  in file schema.inc, method AttributeType::getSupAttribute()
  Gets this attribute's parent attribute (if any). If this attribute does not inherit from another attribute, null is returned.
getSupClasses
  in file schema.inc, method ObjectClass::getSupClasses()
  Gets the objectClass names from which this objectClass inherits.
getSyntaxOID
  in file schema.inc, method AttributeType::getSyntaxOID()
  Gets this attribute's syntax OID. Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed.
getSyntaxString
  in file schema.inc, method AttributeType::getSyntaxString()
  Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").
getType
  in file schema.inc, method ObjectClass::getType()
  Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.
getType
  in file schema.inc, method AttributeType::getType()
  Gets this attribute's type
getUsage
  in file schema.inc, method AttributeType::getUsage()
  Gets this attribute's usage string as defined by the LDAP server
getUsedByAttrs
  in file schema.inc, method MatchingRuleUse::getUsedByAttrs()
  Gets an array of attribute names (strings) which use this MatchingRuleUse object.
getUsedByAttrs
  in file schema.inc, method MatchingRule::getUsedByAttrs()
  Gets an array of attribute names (strings) which use this MatchingRule
getUsedInObjectClasses
  in file schema.inc, method AttributeType::getUsedInObjectClasses()
  Gets the list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.
get_cache
  in file cache.inc, method cache::get_cache()
  Queries the cache for a list of LDAP entries and their attributes.
get_cached_schema
  in file schema.inc, function get_cached_schema()
  Returns the cached array of schemaitem objects for the specified
get_preg
  in file account.inc, function get_preg()
  Checks if a given value matches the selected regular expression.
get_schema_attribute
  in file schema.inc, function get_schema_attribute()
  Gets a single AttributeType object specified by name.
get_schema_attributes
  in file schema.inc, function get_schema_attributes()
  Gets an associative array of AttributeType objects for the specified server. Each array entry's key is the name of the attributeType in lower-case and the value is an AttributeType object.
get_schema_matching_rules
  in file schema.inc, function get_schema_matching_rules()
  Returns an array of MatchingRule objects for the specified server.
get_schema_objectclass
  in file schema.inc, function get_schema_objectclass()
  Gets a single ObjectClass object specified by name.
get_schema_objectclasses
  in file schema.inc, function get_schema_objectclasses()
  Gets an associative array of ObjectClass objects for the specified server. Each array entry's key is the name of the objectClass in lower-case and the value is an ObjectClass object.
get_schema_syntaxes
  in file schema.inc, function get_schema_syntaxes()
  Returns an array of Syntax objects that this LDAP server uses mapped to their descriptions. The key of each entry is the OID of the Syntax.

top

## i

$is_collective
  in file schema.inc, variable AttributeType::$is_collective
  boolean: is collective?
$is_no_user_modification
  in file schema.inc, variable AttributeType::$is_no_user_modification
  boolean: can use modify?
$is_obsolete
  in file schema.inc, variable MatchingRule::$is_obsolete
  Boolean value indicating whether this MatchingRule is obsolete
$is_obsolete
  in file schema.inc, variable ObjectClass::$is_obsolete
  boolean value indicating whether this objectClass is obsolete
$is_obsolete
  in file schema.inc, variable AttributeType::$is_obsolete
  string: the description
$is_single_value
  in file schema.inc, variable AttributeType::$is_single_value
  boolean: is single valued only?
initVars
  in file schema.inc, method ObjectClass::initVars()
  Initialize the class' member variables
initVars
  in file schema.inc, method SchemaItem::initVars()
  Initialize class members to default values.
initVars
  in file schema.inc, method AttributeType::initVars()
  Initialize the class' member variables
initVars
  in file schema.inc, method Syntax::initVars()
  Initializes the class' member variables
initVars
  in file schema.inc, method MatchingRule::initVars()
  Initialize the class' member variables
initVars
  in file schema.inc, method MatchingRuleUse::initVars()
  Initialize the class' member variables
in_array_ignore_case
  in file account.inc, function in_array_ignore_case()
  Checks if a string exists in an array, ignoring case.
in_cache
  in file cache.inc, method cache::in_cache()
  This function returns the DN if an LDAP entry with $attribute=$value is found.
isAliasFor
  in file schema.inc, method AttributeType::isAliasFor()
  Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).

top

## l

lmPassword
  in file account.inc, function lmPassword()
  Generates the LM hash of a password.
logNewMessage
  in file security.inc, function logNewMessage()
  Puts a new message in the log file.
logoffAndBackToLoginPage
  in file security.inc, function logoffAndBackToLoginPage()
  Logs off the user and displays the login page.

top

## m

$max_length
  in file schema.inc, variable AttributeType::$max_length
  The max number of characters this attribute can be
$may_attrs
  in file schema.inc, variable ObjectClass::$may_attrs
  arrays of attribute names that this objectClass allows, but does not require
$must_attrs
  in file schema.inc, variable ObjectClass::$must_attrs
  arrays of attribute names that this objectClass requires
MatchingRule
  in file schema.inc, method MatchingRule::MatchingRule()
  Creates a new MatchingRule object from a raw LDAP MatchingRule string.
MatchingRule
  in file schema.inc, class MatchingRule
  Represents an LDAP MatchingRule
MatchingRuleUse
  in file schema.inc, class MatchingRuleUse
  Represents an LDAP schema matchingRuleUse entry
MatchingRuleUse
  in file schema.inc, method MatchingRuleUse::MatchingRuleUse()

top

## n

$name
  in file schema.inc, variable ObjectClass::$name
  This objectClass' name, ie "inetOrgPerson"
$name
  in file schema.inc, variable ObjectClassAttribute::$name
  This Attribute's name
$name
  in file schema.inc, variable MatchingRuleUse::$name
  The name of the MathingRule this applies to
$name
  in file schema.inc, variable MatchingRule::$name
  This rule's name
$name
  in file schema.inc, variable AttributeType::$name
  The name of this attributeType
ntPassword
  in file account.inc, function ntPassword()
  Generates the NT hash of a password.

top

## o

$oid
  in file schema.inc, variable SchemaItem::$oid
  The OID of this schema item.
$ordering
  in file schema.inc, variable AttributeType::$ordering
  The ordering of the attributeType
ObjectClass
  in file schema.inc, method ObjectClass::ObjectClass()
  Creates a new ObjectClass object given a raw LDAP objectClass string.
ObjectClass
  in file schema.inc, class ObjectClass
  Represents an LDAP objectClass
ObjectClassAttribute
  in file schema.inc, method ObjectClassAttribute::ObjectClassAttribute()
  Creates a new ObjectClassAttribute with specified name and source objectClass.
ObjectClassAttribute
  in file schema.inc, class ObjectClassAttribute
  A simple class for representing AttributeTypes used only by the ObjectClass class.

top

## p

pwd_disable
  in file account.inc, function pwd_disable()
  Marks an password hash as disabled and returns the new hash string
pwd_enable
  in file account.inc, function pwd_enable()
  Marks an password hash as enabled and returns the new hash string
pwd_hash
  in file account.inc, function pwd_hash()
  Returns the hash value of a plain text password the hash algorithm depends on the configuration file
pwd_is_enabled
  in file account.inc, function pwd_is_enabled()
  Checks if a password hash is enabled/disabled

top

## r

$required_by_object_classes
  in file schema.inc, variable AttributeType::$required_by_object_classes
  A list of object class names that require this attribute type.
refresh_cache
  in file cache.inc, method cache::refresh_cache()
  This function refreshes the cache.
removeAlias
  in file schema.inc, method AttributeType::removeAlias()
  Removes an attribute name from this attribute's alias array.

top

## s

$source
  in file schema.inc, variable ObjectClassAttribute::$source
  This Attribute's root
$sub_str
  in file schema.inc, variable AttributeType::$sub_str
  Boolean: supports substring matching?
$sup_attribute
  in file schema.inc, variable AttributeType::$sup_attribute
  The attribute from which this attribute inherits (if any)
$sup_classes
  in file schema.inc, variable ObjectClass::$sup_classes
  array of objectClass names from which this objectClass inherits
$syntax
  in file schema.inc, variable MatchingRule::$syntax
  This rule's syntax OID
$syntax
  in file schema.inc, variable AttributeType::$syntax
  The full syntax string, ie 1.2.3.4{16}
schema.inc
  procedural page schema.inc
security.inc
  procedural page security.inc
status.inc
  procedural page status.inc
SchemaItem
  in file schema.inc, class SchemaItem
  Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.
SchemaItem
  in file schema.inc, method SchemaItem::SchemaItem()
  Default constructor.
SCHEMA_SESSION_CACHE_ENABLED
  in file schema.inc, constant SCHEMA_SESSION_CACHE_ENABLED
  To enable/disable session-based schema caching (1: enabled, 0: disabled).
search_domains
  in file account.inc, function search_domains()
  Returns an array with all Samba 3 domain entries under the given suffix
setAliases
  in file schema.inc, method AttributeType::setAliases()
  Sets this attribute's list of aliases.
setDescription
  in file schema.inc, method SchemaItem::setDescription()
setIsSingleValue
  in file schema.inc, method AttributeType::setIsSingleValue()
  Sets whether this attribute is single-valued.
setName
  in file schema.inc, method AttributeType::setName()
  Sets this attriute's name.
setOID
  in file schema.inc, method SchemaItem::setOID()
setSupAttribute
  in file schema.inc, method AttributeType::setSupAttribute()
  Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).
setType
  in file schema.inc, method AttributeType::setType()
  Sets this attribute's type.
setUsedByAttrs
  in file schema.inc, method MatchingRule::setUsedByAttrs()
  Sets the list of used_by_attrs to the array specified by $attrs;
set_cached_schema
  in file schema.inc, function set_cached_schema()
  Caches the specified $schema_type.
set_schema_cache_unavailable
  in file schema.inc, function set_schema_cache_unavailable()
  Sets the schema entry for the server_id to be "unavailable" so that we realize that we tried to get the schema but could not, so quit trying next time to fetch it from the server.
smbflag
  in file account.inc, function smbflag()
  Takes a list of Samba flags and creates the corresponding flag string.
startSecureSession
  in file security.inc, function startSecureSession()
  Starts a session and checks the environment.
StatusMessage
  in file status.inc, function StatusMessage()
  This function prints a short status message. It can be used to print INFO, WARN and ERROR messages at the moment.
Syntax
  in file schema.inc, method Syntax::Syntax()
  Creates a new Syntax object from a raw LDAP syntax string.
Syntax
  in file schema.inc, class Syntax
  Represents an LDAP Syntax

top

## t

$type
  in file schema.inc, variable ObjectClass::$type
  one of STRUCTURAL, ABSTRACT, or AUXILIARY
$type
  in file schema.inc, variable AttributeType::$type
  A string description of the syntax type (taken from the LDAPSyntaxes)

top

## u

$usage
  in file schema.inc, variable AttributeType::$usage
  The usage string set by the LDAP schema
$used_by_attrs
  in file schema.inc, variable MatchingRule::$used_by_attrs
  An array of attribute names who use this MatchingRule
$used_by_attrs
  in file schema.inc, variable MatchingRuleUse::$used_by_attrs
  An array of attributeType names who make use of the mathingRule
$used_in_object_classes
  in file schema.inc, variable AttributeType::$used_in_object_classes
  An array of objectClasses which use this attributeType (must be set by caller)

top

Documentation generated on Wed, 05 Aug 2009 19:52:52 +0200 by phpDocumentor 1.4.1