Merge pull request #74 from ChadSikorra/v1-start_the_changelog

[1.0.0] Start a changelog / upgrade doc for version 1.0.0 changes.

CHANGELOG.md

@@ -1,6 +1,16 @@
 CHANGELOG
 =========
 
+1.0.0 (2023-xx-xx)
+------------------
+* Updated the minimum version of PHP to version 8.1.
+* All classes now use "strict_types=1". This internal change should not impact external usage.
+* Client and server options arrays have been replaced by ClientOptions and ServerOptions classes.
+* Added client side support for RFC4533 (SyncRepl) style directory synchronization.
+* Added entry handler processing of searches. This allows immediate processing of entries via anonymous functions.
+* Added the ability to cancel search or sync requests when using entry handler processing for searches.
+* Added support for the SensitiveParameter attribute to mask bind related credentials from stack traces.
+
 0.8.0 (2022-05-21)
 ------------------
 * Properly handle and reap child processes in the LDAP server.

UPGRADE-1.0.md

@@ -0,0 +1,64 @@
+Upgrading from 0.x to 1.0
+=======================
+
+Client Options
+--------------
+
+When instantiating the `LdapClient`, options are now an options object instead of an associative array.
+
+**Before**:
+
+```php
+use FreeDSx\Ldap\LdapClient;
+
+$ldap = new LdapClient([
+    # Servers are tried in order until one connects
+    'servers' => ['dc1', 'dc2'],
+    # The base_dn is used as the default for searches
+    'base_dn' => 'dc=example,dc=local'
+]);
+```
+
+**After**:
+
+```php
+use FreeDSx\Ldap\LdapClient;
+use FreeDSx\Ldap\ClientOptions;
+
+$ldap = new LdapClient(
+    (new ClientOptions)
+        # Servers are tried in order until one connects
+        ->setServers(['dc1', 'dc2'])
+        # The base_dn is used as the default for searches
+        ->setBaseDn('dc=example,dc=local')
+);
+```
+
+Server Options
+--------------
+
+When instantiating the `LdapServer`, options are now an options object instead of an associative array.
+
+**Before**:
+
+```php
+use FreeDSx\Ldap\LdapServer;
+
+$ldap = new LdapServer([
+    'dse_alt_server' => 'dc2.local',
+    'port' => 33389,
+]);
+```
+
+**After**:
+
+```php
+use FreeDSx\Ldap\LdapServer;
+use FreeDSx\Ldap\ServerOptions;
+
+$ldap = new LdapServer(
+    (new ServerOptions)
+        ->setDseAltServer('dc2.local')
+        ->setPort(33389)
+);
+```