vendor/adldap2/adldap2/src/Configuration/DomainConfiguration.php

   1 <?php
   2
   3 namespace Adldap\Configuration;
   4
   5 use Adldap\Connections\ConnectionInterface;
   6 use Adldap\Configuration\Validators\ArrayValidator;
   7 use Adldap\Configuration\Validators\StringOrNullValidator;
   8 use Adldap\Configuration\Validators\BooleanValidator;
   9 use Adldap\Configuration\Validators\IntegerValidator;
  10
  11 /**
  12  * Class DomainConfiguration
  13  *
  14  * Contains an array of configuration options for a single LDAP connection.
  15  *
  16  * @package Adldap\Configuration
  17  */
  18 class DomainConfiguration
  19 {
  20     /**
  21      * The configuration options array.
  22      *
  23      * The default values for each key indicate the type of value it requires.
  24      *
  25      * @var array
  26      */
  27     protected $options = [
  28         // An array of LDAP hosts.
  29         'domain_controllers' => [],
  30
  31         // The global LDAP operation timeout limit in seconds.
  32         'timeout' => 5,
  33
  34         // The LDAP version to utilize.
  35         'version' => 3,
  36
  37         // The port to use for connecting to your hosts.
  38         'port' => ConnectionInterface::PORT,
  39
  40         // The base distinguished name of your domain.
  41         'base_dn' => '',
  42
  43         // Whether or not to use SSL when connecting to your hosts.
  44         'use_ssl' => false,
  45
  46         // Whether or not to use TLS when connecting to your hosts.
  47         'use_tls' => false,
  48
  49         // Whether or not follow referrals is enabled when performing LDAP operations.
  50         'follow_referrals' => false,
  51
  52         // The account prefix to use when authenticating users.
  53         'account_prefix' => null,
  54
  55         // The account suffix to use when authenticating users.
  56         'account_suffix' => null,
  57
  58         // The username to connect to your hosts with.
  59         'admin_username' => '',
  60
  61         // The password that is utilized with the above user.
  62         'admin_password' => '',
  63
  64         // The account prefix to use when authenticating your admin account above.
  65         'admin_account_prefix' => null,
  66
  67         // The account prefix to use when authenticating your admin account above.
  68         'admin_account_suffix' => null,
  69
  70         // Custom LDAP options that you'd like to utilize.
  71         'custom_options' => [],
  72     ];
  73
  74     /**
  75      * Constructor.
  76      *
  77      * @param array $options
  78      *
  79      * @throws ConfigurationException When an option value given is an invalid type.
  80      */
  81     public function __construct(array $options = [])
  82     {
  83         foreach ($options as $key => $value) {
  84             $this->set($key, $value);
  85         }
  86     }
  87
  88     /**
  89      * Sets a configuration option.
  90      *
  91      * Throws an exception if the specified option does
  92      * not exist, or if it's an invalid type.
  93      *
  94      * @param string $key
  95      * @param mixed  $value
  96      *
  97      * @throws ConfigurationException When an option value given is an invalid type.
  98      */
  99     public function set($key, $value)
 100     {
 101         if($this->validate($key, $value)) {
 102             $this->options[$key] = $value;
 103         }
 104     }
 105
 106     /**
 107      * Returns the value for the specified configuration options.
 108      *
 109      * Throws an exception if the specified option does not exist.
 110      *
 111      * @param string $key
 112      *
 113      * @return mixed
 114      *
 115      * @throws ConfigurationException When the option specified does not exist.
 116      */
 117     public function get($key)
 118     {
 119         if ($this->has($key)) {
 120             return $this->options[$key];
 121         }
 122
 123         throw new ConfigurationException("Option {$key} does not exist.");
 124     }
 125
 126     /**
 127      * Checks if a configuration option exists.
 128      *
 129      * @param string $key
 130      *
 131      * @return bool
 132      */
 133     public function has($key)
 134     {
 135         return array_key_exists($key, $this->options);
 136     }
 137
 138     /**
 139      * Validates the new configuration option against its
 140      * default value to ensure it's the correct type.
 141      *
 142      * If an invalid type is given, an exception is thrown.
 143      *
 144      * @param string $key
 145      * @param mixed  $value
 146      *
 147      * @return bool
 148      *
 149      * @throws ConfigurationException When an option value given is an invalid type.
 150      */
 151     protected function validate($key, $value)
 152     {
 153         $default = $this->get($key);
 154
 155         if (is_array($default)) {
 156             $validator = new ArrayValidator($key, $value);
 157         } elseif (is_int($default)) {
 158             $validator = new IntegerValidator($key, $value);
 159         } elseif (is_bool($default)) {
 160             $validator = new BooleanValidator($key, $value);
 161         } else {
 162             $validator = new StringOrNullValidator($key, $value);
 163         }
 164
 165         return $validator->validate();
 166     }
 167 }