use constructor property promotion

xabbuh · xabbuh · commit d8831c0c4b9b · 2024-06-01T10:26:03.000+02:00
diff --git a/Adapter/AbstractQuery.php b/Adapter/AbstractQuery.php
@@ -19,13 +19,14 @@
  */
 abstract class AbstractQuery implements QueryInterface
 {
-    protected ConnectionInterface $connection;
-    protected string $dn;
-    protected string $query;
     protected array $options;
 
-    public function __construct(ConnectionInterface $connection, string $dn, string $query, array $options = [])
-    {
+    public function __construct(
+        protected ConnectionInterface $connection,
+        protected string $dn,
+        protected string $query,
+        array $options = [],
+    ) {
         $resolver = new OptionsResolver();
         $resolver->setDefaults([
             'filter' => '*',
@@ -42,9 +43,6 @@ public function __construct(ConnectionInterface $connection, string $dn, string
 
         $resolver->setNormalizer('filter', fn (Options $options, $value) => \is_array($value) ? $value : [$value]);
 
-        $this->connection = $connection;
-        $this->dn = $dn;
-        $this->query = $query;
         $this->options = $resolver->resolve($options);
     }
 }
diff --git a/Adapter/ExtLdap/Adapter.php b/Adapter/ExtLdap/Adapter.php
@@ -22,17 +22,15 @@
  */
 class Adapter implements AdapterInterface
 {
-    private array $config;
     private ConnectionInterface $connection;
     private EntryManagerInterface $entryManager;
 
-    public function __construct(array $config = [])
-    {
+    public function __construct(
+        private array $config = [],
+    ) {
         if (!\extension_loaded('ldap')) {
             throw new LdapException('The LDAP PHP extension is not enabled.');
         }
-
-        $this->config = $config;
     }
 
     public function getConnection(): ConnectionInterface
diff --git a/Adapter/ExtLdap/Collection.php b/Adapter/ExtLdap/Collection.php
@@ -20,15 +20,13 @@
  */
 class Collection implements CollectionInterface
 {
-    private Connection $connection;
-    private Query $search;
     /** @var list<Entry> */
     private array $entries;
 
-    public function __construct(Connection $connection, Query $search)
-    {
-        $this->connection = $connection;
-        $this->search = $search;
+    public function __construct(
+        private Connection $connection,
+        private Query $search,
+    ) {
     }
 
     public function toArray(): array
diff --git a/Adapter/ExtLdap/UpdateOperation.php b/Adapter/ExtLdap/UpdateOperation.php
@@ -15,10 +15,6 @@
 
 class UpdateOperation
 {
-    private int $operationType;
-    private ?array $values;
-    private string $attribute;
-
     private const VALID_OPERATION_TYPES = [
         \LDAP_MODIFY_BATCH_ADD,
         \LDAP_MODIFY_BATCH_REMOVE,
@@ -32,18 +28,17 @@ class UpdateOperation
      *
      * @throws UpdateOperationException on consistency errors during construction
      */
-    public function __construct(int $operationType, string $attribute, ?array $values)
-    {
+    public function __construct(
+        private int $operationType,
+        private string $attribute,
+        private ?array $values,
+    ) {
         if (!\in_array($operationType, self::VALID_OPERATION_TYPES, true)) {
             throw new UpdateOperationException(sprintf('"%s" is not a valid modification type.', $operationType));
         }
         if (\LDAP_MODIFY_BATCH_REMOVE_ALL === $operationType && null !== $values) {
             throw new UpdateOperationException(sprintf('$values must be null for LDAP_MODIFY_BATCH_REMOVE_ALL operation, "%s" given.', get_debug_type($values)));
         }
-
-        $this->operationType = $operationType;
-        $this->attribute = $attribute;
-        $this->values = $values;
     }
 
     public function toArray(): array
diff --git a/Entry.php b/Entry.php
@@ -17,8 +17,6 @@
  */
 class Entry
 {
-    private string $dn;
-
     /**
      * @var array<string, array>
      */
@@ -32,10 +30,10 @@ class Entry
     /**
      * @param array<string, array> $attributes
      */
-    public function __construct(string $dn, array $attributes = [])
-    {
-        $this->dn = $dn;
-
+    public function __construct(
+        private string $dn,
+        array $attributes = [],
+    ) {
         foreach ($attributes as $key => $attribute) {
             $this->setAttribute($key, $attribute);
         }
diff --git a/Ldap.php b/Ldap.php
@@ -22,11 +22,9 @@
  */
 final class Ldap implements LdapInterface
 {
-    private AdapterInterface $adapter;
-
-    public function __construct(AdapterInterface $adapter)
-    {
-        $this->adapter = $adapter;
+    public function __construct(
+        private AdapterInterface $adapter,
+    ) {
     }
 
     public function bind(?string $dn = null, #[\SensitiveParameter] ?string $password = null): void
diff --git a/Security/CheckLdapCredentialsListener.php b/Security/CheckLdapCredentialsListener.php
@@ -29,11 +29,9 @@
  */
 class CheckLdapCredentialsListener implements EventSubscriberInterface
 {
-    private ContainerInterface $ldapLocator;
-
-    public function __construct(ContainerInterface $ldapLocator)
-    {
-        $this->ldapLocator = $ldapLocator;
+    public function __construct(
+        private ContainerInterface $ldapLocator,
+    ) {
     }
 
     public function onCheckPassport(CheckPassportEvent $event): void
diff --git a/Security/LdapAuthenticator.php b/Security/LdapAuthenticator.php
@@ -34,21 +34,14 @@
  */
 class LdapAuthenticator implements AuthenticationEntryPointInterface, InteractiveAuthenticatorInterface
 {
-    private AuthenticatorInterface $authenticator;
-    private string $ldapServiceId;
-    private string $dnString;
-    private string $searchDn;
-    private string $searchPassword;
-    private string $queryString;
-
-    public function __construct(AuthenticatorInterface $authenticator, string $ldapServiceId, string $dnString = '{user_identifier}', string $searchDn = '', string $searchPassword = '', string $queryString = '')
-    {
-        $this->authenticator = $authenticator;
-        $this->ldapServiceId = $ldapServiceId;
-        $this->dnString = $dnString;
-        $this->searchDn = $searchDn;
-        $this->searchPassword = $searchPassword;
-        $this->queryString = $queryString;
+    public function __construct(
+        private AuthenticatorInterface $authenticator,
+        private string $ldapServiceId,
+        private string $dnString = '{user_identifier}',
+        private string $searchDn = '',
+        private string $searchPassword = '',
+        private string $queryString = '',
+    ) {
     }
 
     public function supports(Request $request): ?bool
diff --git a/Security/LdapBadge.php b/Security/LdapBadge.php
@@ -25,18 +25,15 @@
 class LdapBadge implements BadgeInterface
 {
     private bool $resolved = false;
-    private string $ldapServiceId;
-    private string $dnString;
-    private string $searchDn;
-    private string $searchPassword;
-    private ?string $queryString;
+    private string $queryString;
 
-    public function __construct(string $ldapServiceId, string $dnString = '{user_identifier}', string $searchDn = '', string $searchPassword = '', ?string $queryString = null)
-    {
-        $this->ldapServiceId = $ldapServiceId;
-        $this->dnString = $dnString;
-        $this->searchDn = $searchDn;
-        $this->searchPassword = $searchPassword;
+    public function __construct(
+        private string $ldapServiceId,
+        private string $dnString = '{user_identifier}',
+        private string $searchDn = '',
+        private string $searchPassword = '',
+        ?string $queryString = null,
+    ) {
         $this->queryString = $queryString ?? '';
     }
 
@@ -60,7 +57,7 @@ public function getSearchPassword(): string
         return $this->searchPassword;
     }
 
-    public function getQueryString(): ?string
+    public function getQueryString(): string
     {
         return $this->queryString;
     }
diff --git a/Security/LdapUser.php b/Security/LdapUser.php
@@ -23,23 +23,16 @@
  */
 class LdapUser implements UserInterface, PasswordAuthenticatedUserInterface, EquatableInterface
 {
-    private Entry $entry;
-    private string $identifier;
-    private ?string $password;
-    private array $roles;
-    private array $extraFields;
-
-    public function __construct(Entry $entry, string $identifier, #[\SensitiveParameter] ?string $password, array $roles = [], array $extraFields = [])
-    {
+    public function __construct(
+        private Entry $entry,
+        private string $identifier,
+        #[\SensitiveParameter] private ?string $password,
+        private array $roles = [],
+        private array $extraFields = [],
+    ) {
         if (!$identifier) {
             throw new \InvalidArgumentException('The username cannot be empty.');
         }
-
-        $this->entry = $entry;
-        $this->identifier = $identifier;
-        $this->password = $password;
-        $this->roles = $roles;
-        $this->extraFields = $extraFields;
     }
 
     public function getEntry(): Entry
diff --git a/Security/LdapUserProvider.php b/Security/LdapUserProvider.php
@@ -35,30 +35,25 @@
  */
 class LdapUserProvider implements UserProviderInterface, PasswordUpgraderInterface
 {
-    private LdapInterface $ldap;
-    private string $baseDn;
-    private ?string $searchDn;
-    private ?string $searchPassword;
-    private array $defaultRoles;
-    private ?string $uidKey;
+    private string $uidKey;
     private string $defaultSearch;
-    private ?string $passwordAttribute;
-    private array $extraFields;
 
-    public function __construct(LdapInterface $ldap, string $baseDn, ?string $searchDn = null, #[\SensitiveParameter] ?string $searchPassword = null, array $defaultRoles = [], ?string $uidKey = null, ?string $filter = null, ?string $passwordAttribute = null, array $extraFields = [])
-    {
+    public function __construct(
+        private LdapInterface $ldap,
+        private string $baseDn,
+        private ?string $searchDn = null,
+        #[\SensitiveParameter] private ?string $searchPassword = null,
+        private array $defaultRoles = [],
+        ?string $uidKey = null,
+        ?string $filter = null,
+        private ?string $passwordAttribute = null,
+        private array $extraFields = [],
+    ) {
         $uidKey ??= 'sAMAccountName';
         $filter ??= '({uid_key}={user_identifier})';
 
-        $this->ldap = $ldap;
-        $this->baseDn = $baseDn;
-        $this->searchDn = $searchDn;
-        $this->searchPassword = $searchPassword;
-        $this->defaultRoles = $defaultRoles;
         $this->uidKey = $uidKey;
         $this->defaultSearch = str_replace('{uid_key}', $uidKey, $filter);
-        $this->passwordAttribute = $passwordAttribute;
-        $this->extraFields = $extraFields;
     }
 
     public function loadUserByIdentifier(string $identifier): UserInterface
@@ -93,9 +88,7 @@ public function loadUserByIdentifier(string $identifier): UserInterface
         $entry = $entries[0];
 
         try {
-            if (null !== $this->uidKey) {
-                $identifier = $this->getAttributeValue($entry, $this->uidKey);
-            }
+            $identifier = $this->getAttributeValue($entry, $this->uidKey);
         } catch (InvalidArgumentException) {
         }
 

Original file line number	Diff line number	Diff line change
`@@ -22,17 +22,15 @@`
`22`	`22`	`*/`
`23`	`23`	`class Adapter implements AdapterInterface`
`24`	`24`	`{`
`25`		`- private array $config;`
`26`	`25`	`private ConnectionInterface $connection;`
`27`	`26`	`private EntryManagerInterface $entryManager;`
`28`	`27`
`29`		`- public function __construct(array $config = [])`
`30`		`- {`
	`28`	`+ public function __construct(`
	`29`	`+ private array $config = [],`
	`30`	`+ ) {`
`31`	`31`	`if (!\extension_loaded('ldap')) {`
`32`	`32`	`throw new LdapException('The LDAP PHP extension is not enabled.');`
`33`	`33`	`}`
`34`		`-`
`35`		`- $this->config = $config;`
`36`	`34`	`}`
`37`	`35`
`38`	`36`	`public function getConnection(): ConnectionInterface`
Original file line number	Diff line number	Diff line change
`@@ -22,11 +22,9 @@`
`22`	`22`	`*/`
`23`	`23`	`final class Ldap implements LdapInterface`
`24`	`24`	`{`
`25`		`- private AdapterInterface $adapter;`
`26`		`-`
`27`		`- public function __construct(AdapterInterface $adapter)`
`28`		`- {`
`29`		`- $this->adapter = $adapter;`
	`25`	`+ public function __construct(`
	`26`	`+ private AdapterInterface $adapter,`
	`27`	`+ ) {`
`30`	`28`	`}`
`31`	`29`
`32`	`30`	`public function bind(?string $dn = null, #[\SensitiveParameter] ?string $password = null): void`
Original file line number	Diff line number	Diff line change
`@@ -29,11 +29,9 @@`
`29`	`29`	`*/`
`30`	`30`	`class CheckLdapCredentialsListener implements EventSubscriberInterface`
`31`	`31`	`{`
`32`		`- private ContainerInterface $ldapLocator;`
`33`		`-`
`34`		`- public function __construct(ContainerInterface $ldapLocator)`
`35`		`- {`
`36`		`- $this->ldapLocator = $ldapLocator;`
	`32`	`+ public function __construct(`
	`33`	`+ private ContainerInterface $ldapLocator,`
	`34`	`+ ) {`
`37`	`35`	`}`
`38`	`36`
`39`	`37`	`public function onCheckPassport(CheckPassportEvent $event): void`