Add types to private and internal properties

Author: nicolas-grekas

Adapter/ExtLdap/Connection.php

@@ -37,9 +37,7 @@ class Connection extends AbstractConnection
     ];
 
     private bool $bound = false;
-
-    /** @var resource|LDAPConnection */
-    private $connection;
+    private ?LDAPConnection $connection = null;
 
     public function __sleep(): array
     {
@@ -92,11 +90,9 @@ public function bind(string $dn = null, #[\SensitiveParameter] string $password
     }
 
     /**
-     * @return resource|LDAPConnection
-     *
      * @internal
      */
-    public function getResource()
+    public function getResource(): ?LDAPConnection
     {
         return $this->connection;
     }

Adapter/ExtLdap/EntryManager.php

@@ -24,11 +24,9 @@
  */
 class EntryManager implements EntryManagerInterface
 {
-    private Connection $connection;
-
-    public function __construct(Connection $connection)
-    {
-        $this->connection = $connection;
+    public function __construct(
+        private Connection $connection,
+    ) {
     }
 
     /**
@@ -135,8 +133,8 @@ public function rename(Entry $entry, string $newRdn, bool $removeOldRdn = true)
      */
     public function move(Entry $entry, string $newParent)
     {
-        $con = $this->getConnectionResource();
         $rdn = $this->parseRdnFromEntry($entry);
+        $con = $this->getConnectionResource();
         // deleteOldRdn does not matter here, since the Rdn will not be changing in the move.
         if (!@ldap_rename($con, $entry->getDn(), $rdn, $newParent, true)) {
             throw new LdapException(sprintf('Could not move entry "%s" to "%s": ', $entry->getDn(), $newParent).ldap_error($con), ldap_errno($con));
@@ -147,10 +145,8 @@ public function move(Entry $entry, string $newParent)
 
     /**
      * Get the connection resource, but first check if the connection is bound.
-     *
-     * @return resource|LDAPConnection
      */
-    private function getConnectionResource()
+    private function getConnectionResource(): LDAPConnection
     {
         // If the connection is not bound, throw an exception. Users should use an explicit bind call first.
         if (!$this->connection->isBound()) {

Adapter/ExtLdap/Query.php

@@ -11,7 +11,6 @@
 
 namespace Symfony\Component\Ldap\Adapter\ExtLdap;
 
-use LDAP\Connection as LDAPConnection;
 use LDAP\Result;
 use Symfony\Component\Ldap\Adapter\AbstractQuery;
 use Symfony\Component\Ldap\Adapter\CollectionInterface;
@@ -26,7 +25,7 @@ class Query extends AbstractQuery
 {
     public const PAGINATION_OID = \LDAP_CONTROL_PAGEDRESULTS;
 
-    /** @var resource[]|Result[] */
+    /** @var Result[] */
     private array $results;
 
     private array $serverctrls = [];
@@ -102,7 +101,7 @@ public function execute(): CollectionInterface
                 if ($pageSize > 0 && $sizeLimit >= $pageSize) {
                     $sizeLimit = 0;
                 }
-                $search = $this->callSearchFunction($con, $func, $sizeLimit);
+                $search = @$func($con, $this->dn, $this->query, $this->options['filter'], $this->options['attrsOnly'], $sizeLimit, $this->options['timeout'], $this->options['deref'], $this->serverctrls);
 
                 if (false === $search) {
                     $ldapError = '';
@@ -123,7 +122,9 @@ public function execute(): CollectionInterface
                     break;
                 }
                 if ($pageControl) {
-                    $cookie = $this->controlPagedResultResponse($con, $search);
+                    ldap_parse_result($con, $search, $errcode, $matcheddn, $errmsg, $referrals, $controls);
+
+                    $cookie = $controls[\LDAP_CONTROL_PAGEDRESULTS]['value']['cookie'] ?? '';
                 }
             } while (null !== $cookie && '' !== $cookie);
 
@@ -139,19 +140,17 @@ public function execute(): CollectionInterface
      * Returns an LDAP search resource. If this query resulted in multiple searches, only the first
      * page will be returned.
      *
-     * @return resource|Result|null
-     *
      * @internal
      */
-    public function getResource(int $idx = 0)
+    public function getResource(int $idx = 0): ?Result
     {
         return $this->results[$idx] ?? null;
     }
 
     /**
      * Returns all LDAP search resources.
      *
-     * @return resource[]|Result[]
+     * @return Result[]
      *
      * @internal
      */
@@ -209,29 +208,4 @@ private function controlPagedResult(int $pageSize, bool $critical, string $cooki
 
         return true;
     }
-
-    /**
-     * Retrieve LDAP pagination cookie.
-     *
-     * @param resource|LDAPConnection $con
-     * @param resource|Result         $result
-     */
-    private function controlPagedResultResponse($con, $result): string
-    {
-        ldap_parse_result($con, $result, $errcode, $matcheddn, $errmsg, $referrals, $controls);
-
-        return $controls[\LDAP_CONTROL_PAGEDRESULTS]['value']['cookie'] ?? '';
-    }
-
-    /**
-     * Calls actual LDAP search function with the prepared options and parameters.
-     *
-     * @param resource|LDAPConnection $con
-     *
-     * @return resource|Result|false
-     */
-    private function callSearchFunction($con, callable $func, int $sizeLimit)
-    {
-        return @$func($con, $this->dn, $this->query, $this->options['filter'], $this->options['attrsOnly'], $sizeLimit, $this->options['timeout'], $this->options['deref'], $this->serverctrls);
-    }
 }

Tests/Adapter/ExtLdap/EntryManagerTest.php

@@ -25,9 +25,6 @@ public function testMove()
         $this->expectException(LdapException::class);
         $this->expectExceptionMessage('Entry "$$$$$$" malformed, could not parse RDN.');
         $connection = $this->createMock(Connection::class);
-        $connection
-            ->expects($this->once())
-            ->method('isBound')->willReturn(true);
 
         $entry = new Entry('$$$$$$');
         $entryManager = new EntryManager($connection);