Guest create page: name field autofocus

[bookstack] / app / Auth / Access / Ldap.php

diff --git a/app/Auth/Access/Ldap.php b/app/Auth/Access/Ldap.php
index 6b7bd9b9bf2a4d4699a74609ab507d33cc72f98d..4bf6db474d527d92de5135b7b924aeee969fd73e 100644 (file)
--- a/app/Auth/Access/Ldap.php
+++ b/app/Auth/Access/Ldap.php
@@ -1,4 +1,6 @@
-<?php namespace BookStack\Auth\Access;
+<?php
+
+namespace BookStack\Auth\Access;

 
 /**
  * Class Ldap
 
 /**
  * Class Ldap


@@ -7,47 +9,53 @@
  */
 class Ldap
 {
  */
 class Ldap
 {

-

     /**
     /**

-     * Connect to a LDAP server.
-     * @param string $hostName
-     * @param int    $port
+     * Connect to an LDAP server.
+     *

      * @return resource
      */
      * @return resource
      */

-    public function connect($hostName, $port)
+    public function connect(string $hostName, int $port)

     {
         return ldap_connect($hostName, $port);
     }
 
     /**
      * Set the value of a LDAP option for the given connection.
     {
         return ldap_connect($hostName, $port);
     }
 
     /**
      * Set the value of a LDAP option for the given connection.

+     *

      * @param resource $ldapConnection
      * @param resource $ldapConnection

-     * @param int $option
-     * @param mixed $value
-     * @return bool
+     * @param mixed    $value

      */
      */

-    public function setOption($ldapConnection, $option, $value)
+    public function setOption($ldapConnection, int $option, $value): bool

     {
         return ldap_set_option($ldapConnection, $option, $value);
     }
 
     {
         return ldap_set_option($ldapConnection, $option, $value);
     }
 

+    /**
+     * Start TLS on the given LDAP connection.
+     */
+    public function startTls($ldapConnection): bool
+    {
+        return ldap_start_tls($ldapConnection);
+    }
+

     /**
      * Set the version number for the given ldap connection.
     /**
      * Set the version number for the given ldap connection.

-     * @param $ldapConnection
-     * @param $version
-     * @return bool
+     *
+     * @param resource $ldapConnection

      */
      */

-    public function setVersion($ldapConnection, $version)
+    public function setVersion($ldapConnection, int $version): bool

     {
         return $this->setOption($ldapConnection, LDAP_OPT_PROTOCOL_VERSION, $version);
     }
 
     /**
      * Search LDAP tree using the provided filter.
     {
         return $this->setOption($ldapConnection, LDAP_OPT_PROTOCOL_VERSION, $version);
     }
 
     /**
      * Search LDAP tree using the provided filter.

+     *

      * @param resource   $ldapConnection
      * @param string     $baseDn
      * @param string     $filter
      * @param array|null $attributes
      * @param resource   $ldapConnection
      * @param string     $baseDn
      * @param string     $filter
      * @param array|null $attributes

+     *

      * @return resource
      */
     public function search($ldapConnection, $baseDn, $filter, array $attributes = null)
      * @return resource
      */
     public function search($ldapConnection, $baseDn, $filter, array $attributes = null)


@@ -57,8 +65,10 @@ class Ldap
 
     /**
      * Get entries from an ldap search result.
 
     /**
      * Get entries from an ldap search result.

+     *

      * @param resource $ldapConnection
      * @param resource $ldapSearchResult
      * @param resource $ldapConnection
      * @param resource $ldapSearchResult

+     *

      * @return array
      */
     public function getEntries($ldapConnection, $ldapSearchResult)
      * @return array
      */
     public function getEntries($ldapConnection, $ldapSearchResult)


@@ -68,23 +78,28 @@ class Ldap
 
     /**
      * Search and get entries immediately.
 
     /**
      * Search and get entries immediately.

+     *

      * @param resource   $ldapConnection
      * @param string     $baseDn
      * @param string     $filter
      * @param array|null $attributes
      * @param resource   $ldapConnection
      * @param string     $baseDn
      * @param string     $filter
      * @param array|null $attributes

+     *

      * @return resource
      */
     public function searchAndGetEntries($ldapConnection, $baseDn, $filter, array $attributes = null)
     {
         $search = $this->search($ldapConnection, $baseDn, $filter, $attributes);
      * @return resource
      */
     public function searchAndGetEntries($ldapConnection, $baseDn, $filter, array $attributes = null)
     {
         $search = $this->search($ldapConnection, $baseDn, $filter, $attributes);

+

         return $this->getEntries($ldapConnection, $search);
     }
 
     /**
      * Bind to LDAP directory.
         return $this->getEntries($ldapConnection, $search);
     }
 
     /**
      * Bind to LDAP directory.

+     *

      * @param resource $ldapConnection
      * @param string   $bindRdn
      * @param string   $bindPassword
      * @param resource $ldapConnection
      * @param string   $bindRdn
      * @param string   $bindPassword

+     *

      * @return bool
      */
     public function bind($ldapConnection, $bindRdn = null, $bindPassword = null)
      * @return bool
      */
     public function bind($ldapConnection, $bindRdn = null, $bindPassword = null)


@@ -94,8 +109,10 @@ class Ldap
 
     /**
      * Explode a LDAP dn string into an array of components.
 
     /**
      * Explode a LDAP dn string into an array of components.

+     *

      * @param string $dn
      * @param string $dn

-     * @param int $withAttrib
+     * @param int    $withAttrib
+     *

      * @return array
      */
     public function explodeDn(string $dn, int $withAttrib)
      * @return array
      */
     public function explodeDn(string $dn, int $withAttrib)


@@ -105,12 +122,14 @@ class Ldap
 
     /**
      * Escape a string for use in an LDAP filter.
 
     /**
      * Escape a string for use in an LDAP filter.

+     *

      * @param string $value
      * @param string $ignore
      * @param string $value
      * @param string $ignore

-     * @param int $flags
+     * @param int    $flags
+     *

      * @return string
      */
      * @return string
      */

-    public function escape(string $value, string $ignore = "", int $flags = 0)
+    public function escape(string $value, string $ignore = '', int $flags = 0)

     {
         return ldap_escape($value, $ignore, $flags);
     }
     {
         return ldap_escape($value, $ignore, $flags);
     }