SilverStripe\LDAP\Model\LDAPGateway
Class LDAPGateway
Works within the LDAP domain model to provide basic operations.
These are exclusively used in LDAPService for constructing more complex operations.
Synopsis
class LDAPGateway
{
- // methods
- public void __construct()
- public Ldap getLdap()
- protected void searchWithIterator()
- protected array search()
- protected array processSearchResults()
- public Result authenticate()
- public array getNodes()
- public array getGroups()
- public array getNestedGroups()
- public array getGroupByGUID()
- public array getGroupByDN()
- public array getUsers()
- public array getUsersWithIterator()
- public array getUserByGUID()
- public array getUserByDN()
- public array getUserByEmail()
- public array getUserByUsername()
- public string getCanonicalUsername()
- public void changePassword()
- public void resetPassword()
- public void update()
- public void delete()
- public void move()
- public void add()
- private string getLastPasswordError()
Hierarchy
Uses
- SilverStripe\Core\Injector\Injectable
- SilverStripe\Core\Extensible
- SilverStripe\Core\Config\Configurable
Members
private
- $ldap — SilverStripe\LDAP\Model\Zend\Ldap\Ldap
- $options — array
Methods
private
protected
- processSearchResults() — Processes results from either self::search() or self::searchAll(), expecting eitheran array of records
- search() — Query the LDAP directory with the given filter.
- searchWithIterator()
public
- __construct()
- add() — Add an LDAP object.
- authenticate() — Authenticate the given username and password with LDAP.
- changePassword() — Changes user password via LDAP.
- delete() — Deletes an LDAP object.
- getCanonicalUsername() — Get a canonical username from the record based on the connection settings.
- getGroupByDN() — Return a particular LDAP group by DN value.
- getGroupByGUID() — Return a particular LDAP group by objectGUID value.
- getGroups() — Query for LDAP groups.
- getLdap()
- getNestedGroups() — Return all nested AD groups underneath a specific DN
- getNodes() — Query for LDAP nodes (organizational units, containers, and domains).
- getUserByDN() — Return a particular LDAP user by DN value.
- getUserByEmail() — Return a particular LDAP user by mail value.
- getUserByGUID() — Return a particular LDAP user by objectGUID value.
- getUserByUsername() — Get a specific user's data from LDAP
- getUsers() — Query for LDAP users, but don't include built-in user accounts.
- getUsersWithIterator() — Query for LDAP users, but don't include built-in user accounts. Iterate over all users, regardless of the paging size control built into the LDAP server.
- move() — Move an LDAP object from it's original DN location to another.
- resetPassword() — Administrative password reset.
- update() — Updates an LDAP object.