nusait/nuldap-laravel

There is no license information available for the latest version (0.2.5) of this package.

0.2.5 2016-04-29 15:13 UTC

Requires

• php: >=5.3.0
• fzaninotto/faker: ^1.5
• illuminate/contracts: ~5.1
• illuminate/support: ~5.1
• nusait/nuldap: ^2.1

Requires (Dev)

• phpunit/phpunit: ~4.0

Unknown License

• Vahid Azam

README

This is a LDAP package meant for Northwestern University. (But can be extended for other entities)

Installation via Composer

composer require nusait/nuldap-laravel

Then update composer

composer update

Laravel

Add the service provider to config/app.php

Nusait\Nuldap\NuldapServiceProvider::class,

Publish the config:

php artisan vendor:publish --provider="Nusait\Nuldap\NuldapServiceProvider" 

To use the fake Ldap, make sure to add to your .env file the line:

ldap_fake=true

When using NuldapFake, any search will return a user with pre-filled data using Faker. Whatever search term you provide for a field will return as the value for that field, i.e. a searchNetid('asdf') will return a user with ['netid'] = 'asdf'. In order to simulate not finding a user, prepend the query with nf-, i.e. searchNetid('nf-blah') and it will not find that user.

New Instance:

$ldap = \App::make('ldap') or $ldap = app('ldap')

Validate:

$ldap->validate($netid, $password);

returns a boolean

Searching:

You can search by netid, email, emplid, or studentid.

$ldap->search('netid', $netid);
$ldap->search('email', $email);
$ldap->search('emplid', $emplid);
$ldap->search('studentid', $studentid);

This returns the raw ldap metadata.

You can also search using the magic methods:

$ldap->searchNetid($netid);
$ldap->searchEmail($email);
$ldap->searchEmplid($emplid);
$ldap->searchStudentid($studentid);

Parsing User

$ldap->parseUser($ldapUser [, $transformer ]);

You can parse the raw metadata of a user to create an associative array of the user. You can pass your own transformer into the function. The transformer must implement the TransformerInterface in the Contracts folder.

The default transforms maps the following keys and value:

return [
    'netid'       => $this->getSetValueOrNull($ldapUser, 'uid'),
    'phone'       => $this->getSetValueOrNull($ldapUser, 'telephonenumber'),
    'email'       => $this->getSetValueOrNull($ldapUser, 'mail'),
    'title'       => $this->getSetValueOrNull($ldapUser, 'title'),
    'first_name'  => $this->getSetValueOrNull($ldapUser, 'givenname'),
    'last_name'   => $this->getSetValueOrNull($ldapUser, 'sn'),
    'displayname' => $this->getSetValueOrNull($ldapUser, 'displayname'),
    'emplid'      => (int)$this->getSetValueOrNull($ldapUser, 'employeenumber'),
    'studentid'   => (int)$this->getSetValueOrNull($ldapUser, 'nustudentnumber')
];