vendor/adldap2/adldap2/src/Connections/ProviderInterface.php

   1 <?php
   2
   3 namespace Adldap\Connections;
   4
   5 use Adldap\Auth\GuardInterface;
   6 use Adldap\Schemas\SchemaInterface;
   7 use Adldap\Configuration\DomainConfiguration;
   8
   9 interface ProviderInterface
  10 {
  11     /**
  12       * Constructor.
  13       *
  14       * @param DomainConfiguration|array $configuration
  15       * @param ConnectionInterface|null  $connection
  16       * @param SchemaInterface|null      $schema
  17       */
  18     public function __construct($configuration, ConnectionInterface $connection, SchemaInterface $schema = null);
  19
  20     /**
  21      * Returns the current connection instance.
  22      *
  23      * @return ConnectionInterface
  24      */
  25     public function getConnection();
  26
  27     /**
  28      * Returns the current configuration instance.
  29      *
  30      * @return DomainConfiguration
  31      */
  32     public function getConfiguration();
  33
  34     /**
  35      * Returns the current Guard instance.
  36      *
  37      * @return \Adldap\Auth\Guard
  38      */
  39     public function getGuard();
  40
  41     /**
  42      * Returns a new default Guard instance.
  43      *
  44      * @param ConnectionInterface $connection
  45      * @param DomainConfiguration $configuration
  46      *
  47      * @return \Adldap\Auth\Guard
  48      */
  49     public function getDefaultGuard(ConnectionInterface $connection, DomainConfiguration $configuration);
  50
  51     /**
  52      * Sets the current connection.
  53      *
  54      * @param ConnectionInterface $connection
  55      *
  56      * @return $this
  57      */
  58     public function setConnection(ConnectionInterface $connection = null);
  59
  60     /**
  61      * Sets the current configuration.
  62      *
  63      * @param DomainConfiguration|array $configuration
  64      */
  65     public function setConfiguration($configuration = []);
  66
  67     /**
  68      * Sets the current LDAP attribute schema.
  69      *
  70      * @param SchemaInterface|null $schema
  71      *
  72      * @return $this
  73      */
  74     public function setSchema(SchemaInterface $schema = null);
  75
  76     /**
  77      * Returns the current LDAP attribute schema.
  78      *
  79      * @return SchemaInterface
  80      */
  81     public function getSchema();
  82
  83     /**
  84      * Sets the current Guard instance.
  85      *
  86      * @param GuardInterface $guard
  87      *
  88      * @return $this
  89      */
  90     public function setGuard(GuardInterface $guard);
  91
  92     /**
  93      * Returns a new Model factory instance.
  94      *
  95      * @return \Adldap\Models\Factory
  96      */
  97     public function make();
  98
  99     /**
 100      * Returns a new Search factory instance.
 101      *
 102      * @return \Adldap\Query\Factory
 103      */
 104     public function search();
 105
 106     /**
 107      * Returns a new Auth Guard instance.
 108      *
 109      * @return \Adldap\Auth\Guard
 110      */
 111     public function auth();
 112
 113     /**
 114      * Connects and Binds to the Domain Controller.
 115      *
 116      * If no username or password is specified, then the
 117      * configured administrator credentials are used.
 118      *
 119      * @param string|null $username
 120      * @param string|null $password
 121      *
 122      * @throws \Adldap\Auth\BindException When binding to your LDAP server fails.
 123      *
 124      * @return ProviderInterface
 125      */
 126     public function connect($username = null, $password = null);
 127 }