ldap_compare

Function • Params changed in PHP 8.1

Compare value of attribute found in entry specified with DN.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
Improved
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

ldap_compare Function synopsis

ldap_compare(
    LDAP\Connection $ldap,
    string $dn,
    string $attribute,
    string $value,
    ?array $controls = null
  ): int|bool

Parameters

$ldap

TypeLDAP\Connection

An LDAP\Connection instance, returned by ldap_connect.

$dn

Typestring

The distinguished name of an LDAP entity.

$attribute

Typestring

The attribute name.

$value

Typestring

The compared value.

$controls

OptionalType?arrayDefault valuenull

Array of LDAP Controls to send with the request.

Return value

Typeint|bool

Returns true if $value matches otherwise returns false. Returns -1 on error.

Changes to the ldap_compare Function

PHP 8.1

  • Parameter type added for parameter #1 ($ldap): LDAP\Connection
  ldap_compare(
-     $ldap,
+     LDAP\Connection $ldap,
      string $dn,
      string $attribute,
      string $value,
      ?array $controls = null
    ): int|bool

PHP 8.0

  • Return type added: int|bool
  • Parameter name of parameter #1 changed: $link_identifier to $ldap
  • Parameter type added for parameter #2 ($dn): string
  • Parameter type added for parameter #3 ($attribute): string
  • Parameter type added for parameter #4 ($value): string
  • Parameter name of parameter #5 changed: $servercontrols to $controls
  • Parameter type added for parameter #5 ($controls): ?array
  • Parameter default value added for position #5 ($controls): null
  ldap_compare(
-     $link_identifier,
+     $ldap,
-     $dn,
+     string $dn,
-     $attribute,
+     string $attribute,
-     $value,
+     string $value,
-     $servercontrols
+     ?array $controls = null
-   )
+   ): int|bool

PHP 7.3

  • Optional parameter added - #5: $servercontrols
 ldap_compare(
     $link_identifier,
     $dn,
     $attribute,
-    $value
+    $value,
+    $servercontrols
   )

ldap_compare Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes