vendor/adldap2/adldap2/src/Connections/ConnectionInterface.php

   1 <?php
   2
   3 namespace Adldap\Connections;
   4
   5 /**
   6  * The Connection interface used for making connections. Implementing
   7  * this interface on connection classes helps unit and functional
   8  * test classes that require a connection.
   9  *
  10  * Interface ConnectionInterface
  11  */
  12 interface ConnectionInterface
  13 {
  14     /**
  15      * The SSL LDAP protocol string.
  16      *
  17      * @var string
  18      */
  19     const PROTOCOL_SSL = 'ldaps://';
  20
  21     /**
  22      * The standard LDAP protocol string.
  23      *
  24      * @var string
  25      */
  26     const PROTOCOL = 'ldap://';
  27
  28     /**
  29      * The LDAP SSL port number.
  30      *
  31      * @var string
  32      */
  33     const PORT_SSL = 636;
  34
  35     /**
  36      * The standard LDAP port number.
  37      *
  38      * @var string
  39      */
  40     const PORT = 389;
  41
  42     /**
  43      * Returns true / false if the
  44      * current connection is supported
  45      * on the current PHP install.
  46      *
  47      * @return bool
  48      */
  49     public function isSupported();
  50
  51     /**
  52      * Returns true / false if the
  53      * current connection supports
  54      * SASL for single sign on
  55      * capability.
  56      *
  57      * @return bool
  58      */
  59     public function isSaslSupported();
  60
  61     /**
  62      * Returns true / false if the
  63      * current connection pagination.
  64      *
  65      * @return bool
  66      */
  67     public function isPagingSupported();
  68
  69     /**
  70      * Returns true / false if the
  71      * current connection supports batch
  72      * modification.
  73      *
  74      * @return bool
  75      */
  76     public function isBatchSupported();
  77
  78     /**
  79      * Returns true / false if the
  80      * current connection instance is using
  81      * SSL.
  82      *
  83      * @return bool
  84      */
  85     public function isUsingSSL();
  86
  87     /**
  88      * Returns true / false if the
  89      * current connection instance is using
  90      * TLS.
  91      *
  92      * @return bool
  93      */
  94     public function isUsingTLS();
  95
  96     /**
  97      * Returns true / false if the current
  98      * connection is able to modify passwords.
  99      *
 100      * @return bool
 101      */
 102     public function canChangePasswords();
 103
 104     /**
 105      * Returns true / false if the current
 106      * connection is bound.
 107      *
 108      * @return bool
 109      */
 110     public function isBound();
 111
 112     /**
 113      * Sets the current connection to use SSL.
 114      *
 115      * @param bool $enabled
 116      *
 117      * @return ConnectionInterface
 118      */
 119     public function ssl($enabled = true);
 120
 121     /**
 122      * Sets the current connection to use TLS.
 123      *
 124      * @param bool $enabled
 125      *
 126      * @return ConnectionInterface
 127      */
 128     public function tls($enabled = true);
 129
 130     /**
 131      * Get the current connection.
 132      *
 133      * @return mixed
 134      */
 135     public function getConnection();
 136
 137     /**
 138      * Retrieve the entries from a search result.
 139      *
 140      * @param $searchResult
 141      *
 142      * @return mixed
 143      */
 144     public function getEntries($searchResult);
 145
 146     /**
 147      * Returns the number of entries from a search
 148      * result.
 149      *
 150      * @param $searchResult
 151      *
 152      * @return int
 153      */
 154     public function countEntries($searchResult);
 155
 156     /**
 157      * Compare value of attribute found in entry specified with DN.
 158      *
 159      * @param string $dn
 160      * @param string $attribute
 161      * @param string $value
 162      *
 163      * @return mixed
 164      */
 165     public function compare($dn, $attribute, $value);
 166
 167     /**
 168      * Retrieves the first entry from a search result.
 169      *
 170      * @param $searchResult
 171      *
 172      * @return mixed
 173      */
 174     public function getFirstEntry($searchResult);
 175
 176     /**
 177      * Retrieves the next entry from a search result.
 178      *
 179      * @param $entry
 180      *
 181      * @return mixed
 182      */
 183     public function getNextEntry($entry);
 184
 185     /**
 186      * Retrieves the ldap entry's attributes.
 187      *
 188      * @param $entry
 189      *
 190      * @return mixed
 191      */
 192     public function getAttributes($entry);
 193
 194     /**
 195      * Retrieve the last error on the current
 196      * connection.
 197      *
 198      * @return string
 199      */
 200     public function getLastError();
 201
 202     /**
 203      * Get all binary values from the specified result entry.
 204      *
 205      * @param $entry
 206      * @param $attribute
 207      *
 208      * @return array
 209      */
 210     public function getValuesLen($entry, $attribute);
 211
 212     /**
 213      * Sets an option on the current connection.
 214      *
 215      * @param int   $option
 216      * @param mixed $value
 217      *
 218      * @return mixed
 219      */
 220     public function setOption($option, $value);
 221
 222     /**
 223      * Sets options on the current connection.
 224      *
 225      * @param array $options
 226      *
 227      * @return mixed
 228      */
 229     public function setOptions(array $options = []);
 230
 231     /**
 232      * Set a callback function to do re-binds on referral chasing.
 233      *
 234      * @param callable $callback
 235      *
 236      * @return bool
 237      */
 238     public function setRebindCallback(callable $callback);
 239
 240     /**
 241      * Connects to the specified hostname using the specified port.
 242      *
 243      * @param string|array $hostname
 244      * @param int          $port
 245      *
 246      * @return mixed
 247      */
 248     public function connect($hostname = [], $port = 389);
 249
 250     /**
 251      * Starts a connection using TLS.
 252      *
 253      * @return mixed
 254      */
 255     public function startTLS();
 256
 257     /**
 258      * Binds to the current connection using
 259      * the specified username and password. If sasl
 260      * is true, the current connection is bound using
 261      * SASL.
 262      *
 263      * @param string $username
 264      * @param string $password
 265      * @param bool   $sasl
 266      *
 267      * @return bool
 268      */
 269     public function bind($username, $password, $sasl = false);
 270
 271     /**
 272      * Closes the current connection.
 273      *
 274      * Returns false if no connection is present.
 275      *
 276      * @return bool
 277      */
 278     public function close();
 279
 280     /**
 281      * Performs a search on the current connection.
 282      *
 283      * @param string $dn
 284      * @param string $filter
 285      * @param array  $fields
 286      * @param bool   $onlyAttributes
 287      * @param int    $size
 288      * @param int    $time
 289      *
 290      * @return mixed
 291      */
 292     public function search($dn, $filter, array $fields, $onlyAttributes = false, $size = 0, $time = 0);
 293
 294     /**
 295      * Reads an entry on the current connection.
 296      *
 297      * @param string $dn
 298      * @param $filter
 299      * @param array $fields
 300      * @param bool   $onlyAttributes
 301      * @param int    $size
 302      * @param int    $time
 303      *
 304      * @return mixed
 305      */
 306     public function read($dn, $filter, array $fields, $onlyAttributes = false, $size = 0, $time = 0);
 307
 308     /**
 309      * Performs a single level search on the current connection.
 310      *
 311      * @param string $dn
 312      * @param string $filter
 313      * @param array  $attributes
 314      * @param bool   $onlyAttributes
 315      * @param int    $size
 316      * @param int    $time
 317      *
 318      * @return mixed
 319      */
 320     public function listing($dn, $filter, array $attributes, $onlyAttributes = false, $size = 0, $time = 0);
 321
 322     /**
 323      * Adds an entry to the current connection.
 324      *
 325      * @param string $dn
 326      * @param array  $entry
 327      *
 328      * @return bool
 329      */
 330     public function add($dn, array $entry);
 331
 332     /**
 333      * Deletes an entry on the current connection.
 334      *
 335      * @param string $dn
 336      *
 337      * @return bool
 338      */
 339     public function delete($dn);
 340
 341     /**
 342      * Modify the name of an entry on the current
 343      * connection.
 344      *
 345      * @param string $dn
 346      * @param string $newRdn
 347      * @param string $newParent
 348      * @param bool   $deleteOldRdn
 349      *
 350      * @return bool
 351      */
 352     public function rename($dn, $newRdn, $newParent, $deleteOldRdn = false);
 353
 354     /**
 355      * Modifies an existing entry on the
 356      * current connection.
 357      *
 358      * @param string $dn
 359      * @param array  $entry
 360      *
 361      * @return bool
 362      */
 363     public function modify($dn, array $entry);
 364
 365     /**
 366      * Batch modifies an existing entry on the
 367      * current connection.
 368      *
 369      * @param string $dn
 370      * @param array  $values
 371      *
 372      * @return mixed
 373      */
 374     public function modifyBatch($dn, array $values);
 375
 376     /**
 377      * Add attribute values to current attributes.
 378      *
 379      * @param string $dn
 380      * @param array  $entry
 381      *
 382      * @return mixed
 383      */
 384     public function modAdd($dn, array $entry);
 385
 386     /**
 387      * Replaces attribute values with new ones.
 388      *
 389      * @param string $dn
 390      * @param array  $entry
 391      *
 392      * @return mixed
 393      */
 394     public function modReplace($dn, array $entry);
 395
 396     /**
 397      * Delete attribute values from current attributes.
 398      *
 399      * @param string $dn
 400      * @param array  $entry
 401      *
 402      * @return mixed
 403      */
 404     public function modDelete($dn, array $entry);
 405
 406     /**
 407      * Send LDAP pagination control.
 408      *
 409      * @param int    $pageSize
 410      * @param bool   $isCritical
 411      * @param string $cookie
 412      *
 413      * @return mixed
 414      */
 415     public function controlPagedResult($pageSize = 1000, $isCritical = false, $cookie = '');
 416
 417     /**
 418      * Retrieve a paginated result response.
 419      *
 420      * @param $result
 421      * @param string $cookie
 422      *
 423      * @return mixed
 424      */
 425     public function controlPagedResultResponse($result, &$cookie);
 426
 427     /**
 428      * Returns the error number of the last command
 429      * executed on the current connection.
 430      *
 431      * @return int
 432      */
 433     public function errNo();
 434
 435     /**
 436      * Returns the extended error string of the last command.
 437      *
 438      * @return string
 439      */
 440     public function getExtendedError();
 441
 442     /**
 443      * Returns the extended error hex code of the last command.
 444      *
 445      * @return string|null
 446      */
 447     public function getExtendedErrorHex();
 448
 449     /**
 450      * Returns the extended error code of the last command.
 451      *
 452      * @return string
 453      */
 454     public function getExtendedErrorCode();
 455
 456     /**
 457      * Returns the error string of the specified
 458      * error number.
 459      *
 460      * @param int $number
 461      *
 462      * @return string
 463      */
 464     public function err2Str($number);
 465
 466     /**
 467      * Return the diagnostic Message.
 468      *
 469      * @return string
 470      */
 471     public function getDiagnosticMessage();
 472
 473     /**
 474      * Extract the diagnostic code from the message.
 475      *
 476      * @param string $message
 477      *
 478      * @return string|bool
 479      */
 480     public function extractDiagnosticCode($message);
 481 }