Merge branch 'master' of https://github.com/Adldap2/Adldap2-Laravel

Author: stevebauman

docs/auth/installation.md

@@ -56,7 +56,7 @@ however you will still need to publish the configuration file using the
 command below:
 
 ```bash
-php artisan vendor:publish --provdier="Adldap\Laravel\AdldapAuthServiceProvider"
+php artisan vendor:publish --provider="Adldap\Laravel\AdldapAuthServiceProvider"
 ```
 
 Then, open your `config/auth.php` configuration file and change the `driver`
@@ -71,4 +71,4 @@ value inside the `users` authentication provider to `ldap`:
 ],
 ```
 
-Now that you've completed the basic installation, let's move along to the [setup guide](setup.md).
+Now that you've completed the basic installation, let's move along to the [setup guide](setup.md).

docs/tutorials/basics.md

@@ -0,0 +1,75 @@
+# The Basics
+
+Lets get down to the basics. This guide will help you get a quick understanding of
+using Adldap2 and cover some use cases you might want to learn how to
+perform before trying to work it out on your own.
+
+## Searching
+
+### Querying for your Base DN
+
+
+
+### Querying for Enabled / Disabled Users
+
+To locate enabled / disabled users in your directory, call the `whereEnabled()`
+and `whereDisabled()` methods on a query:
+
+```php
+$enabledUsers = Adldap:search()->users()->whereEnabled()->get();
+
+$disabledUsers = Adldap:search()->users()->whereDisabled()->get();
+```
+
+### Querying for Group Membership
+
+To locate records in your directory that are apart of a group, use the `whereMemberOf()` query method:
+
+```php
+// First, locate the group we want to retrieve the members for:
+$accounting = Adldap::search()->groups()->find('Accounting');
+
+// Retrieve the members that belong to the above group.
+$results = Adldap::search()->whereMemberOf($accounting)->get();
+
+// Iterate through the results:
+foreach ($results as $model) {
+    $model->getCommonName(); // etc.
+}
+```
+
+### Escaping Input Manually
+
+If you'd like to execute raw filters, it's best practice to escape any input you receive from a user.
+
+You can do this in a couple ways, so use whichever feels best to you.
+
+Each escape method below will escape all characters inputted unless an **ignore** parameter or **flag**
+parameter have been given (such as `LDAP_ESCAPE_FITLER` or `LDAP_ESCAPE_DN`).
+
+```php
+// Escaping using the query builder:
+$escaped = Adldap::search()->escape($input, $ignore = '', $flags = 0);
+
+// Escaping using the `Utilities` class:
+$escaped = \Adldap\Utilities::escape($input, $ignore = '', $flags = 0);
+
+// Escaping with the native PHP:
+$escaped = ldap_escape($input, $ignore = '', $flags = 0);
+
+$rawFilter = `(samaccountname=$escaped)`
+
+$results = Adldap::search()->rawFilter($rawFilter)->get();
+```
+
+## Models
+
+### Creating
+
+### Updating
+
+### Deleting
+
+### Moving
+
+### Renaming

docs/tutorials/users.md

@@ -120,3 +120,48 @@ $jdoe->userAccountControl = $uac->getValue();
 
 $jdoe->save();
 ```
+
+You can also use 'setter' methods to perform the same task.
+
+```php
+$jdoe = Adldap::search()->users()->find('jdoe');
+
+$uac = new Adldap\Models\Attributes\AccountControl();
+
+$uac->accountIsNormal();
+
+$jdoe
+    ->setDepartment('Accounting');
+    ->setTelephoneNumber('555 555-5555')
+    ->setMobileNumber('555 555-5555')
+    ->setUserAccountControl($uac);
+
+$jdoe->save();
+```
+
+Using setter methods offer a little bit of benefit, for example you can see above that
+`$uac->getValue()` does not need to be called as the `setUserAccountControl()` method
+will automatically convert an `AccountControl` object to its integer value.
+
+Setter methods are also chainable (if you prefer that syntax).
+
+## Deleting Users
+
+As any other returned model in Adldap2, you can call the `delete()` method
+to delete a user from your directory:
+
+```php
+$user = Adldap::search()->find('jdoe');
+
+$user->delete();
+```
+
+Once you `delete()` a user (successfully), the `exists` property on their model is set to `false`:
+
+```php
+$user = Adldap::search()->find('jdoe');
+
+$user->delete();
+
+var_dump($user->exists); // Returns 'bool(false)'
+```