vendor/adldap2/adldap2/src/Auth/GuardInterface.php

   1 <?php
   2
   3 namespace Adldap\Auth;
   4
   5 use Adldap\Connections\ConnectionInterface;
   6 use Adldap\Configuration\DomainConfiguration;
   7
   8 interface GuardInterface
   9 {
  10     /**
  11      * Constructor.
  12      *
  13      * @param ConnectionInterface $connection
  14      * @param DomainConfiguration $configuration
  15      */
  16     public function __construct(ConnectionInterface $connection, DomainConfiguration $configuration);
  17
  18     /**
  19      * Authenticates a user using the specified credentials.
  20      *
  21      * @param string $username   The users AD username.
  22      * @param string $password   The users AD password.
  23      * @param bool   $bindAsUser Whether or not to bind as the user.
  24      *
  25      * @throws \Adldap\Auth\BindException When re-binding to your LDAP server fails.
  26      * @throws \Adldap\Auth\UsernameRequiredException When username is empty.
  27      * @throws \Adldap\Auth\PasswordRequiredException When password is empty.
  28      *
  29      * @return bool
  30      */
  31     public function attempt($username, $password, $bindAsUser = false);
  32
  33     /**
  34      * Binds to the current connection using the inserted credentials.
  35      *
  36      * @param string $username
  37      * @param string $password
  38      * @param string $prefix
  39      * @param string $suffix
  40      *
  41      * @throws \Adldap\Auth\BindException When binding to your LDAP server fails.
  42      *
  43      * @return void
  44      */
  45     public function bind($username, $password, $prefix = null, $suffix = null);
  46
  47     /**
  48      * Binds to the current LDAP server using the
  49      * configuration administrator credentials.
  50      *
  51      * @throws \Adldap\Auth\BindException When binding as your administrator account fails.
  52      *
  53      * @return void
  54      */
  55     public function bindAsAdministrator();
  56 }