$conn $conn : \Pivot\Authentication\Managers\ldap connection object Type \Pivot\Authentication\Managers\ldap
__construct() __construct( $systemSettings, $possibleIdentity, $locations, $ldapGroupHandler) Parameters $systemSettings $possibleIdentity $locations $ldapGroupHandler
authenticate() authenticate( $credentials) : \Pivot\Authentication\Managers\result Authenticate User Parameters $credentials Returns \Pivot\Authentication\Managers\result
setLdapInformation() setLdapInformation( $systemSettings) : null Get current client's LDAP information Parameters $systemSettings Returns null
cleanServerString() cleanServerString(string $serverUri) : string Verify URI is prefixed with ldap:// or ldaps:// Parameters string $serverUri LDAP server URI Returns string — Prefixed LDAP server URI
checkLdapInformation() checkLdapInformation() : boolean Verify required LDAP settings are there and valid Returns boolean — Whether or not the LDAP settings are valid
connect() connect() : boolean Connect to LDAP server Returns boolean — Connection status (this can be a false positive until binds occur)
bindUser() bindUser(string $username, string $password) : boolean Submit user information and attempt binding to LDAP per location Parameters string $username Username to authenticate string $password Password to use when authenticating Returns boolean — Authentication success
getUserInfo() getUserInfo( $username) : array Once binded here we can search for users information in LDAP Parameters $username Returns array — LDAP user information, including permission level returns false if any errors
getErrorMessage() getErrorMessage() : string Return error message Returns string — Any error message that may have been set
ldap_quote() ldap_quote(string $str) : string Clean LDAP string Parameters string $str String to clean Returns string — Cleaned string for LDAP use