Creating a Custom Repository

---

A LDAP Object Repository gives a way to encapsulate and reuse common queries you may run against LDAP. So rather than recoding the same query in several spots, you can code it once in the repository then use the repository method instead.

Your custom repository class should extend the \LdapTools\Object\LdapObjectRepository class. For instance, your class could be something like:

namespace Acme\Demo;

use LdapTools\Object\LdapObjectRepository;

class CustomUserRepository extends LdapObjectRepository
{
    public function getAllSmiths()
    {
        // You can use the buildLdapQuery() method to construct a LdapQueryBuilder instance.
        return $this->buildLdapQuery()
            ->where(['lastName' => 'Smith'])
            ->getLdapQuery()
            ->execute();
    }
}

Then make sure to define your new repository in the the schema config as a directive underneath the user object type:

# If you just want a custom repository for the default user type, you could use a schema that extends the default...
#
# extends_default: ad
objects:
    #...
    user:
        #...
        repository: '\Acme\Demo\CustomUserRepository'

Then once you have your LdapManager class instantiated you can get your custom repository and use it:

 // Assuming you defined the custom repository under the 'user' object type.
 $repository = $ldapManager->getRepository('user');

 $smiths = $repository->getAllSmiths();