Class Shout_Driver_Ldap

Provides the LDAP backend driver for the Shout application.

See the enclosed file COPYING for license information (BSD). If you did not receive this file, see http://www.opensource.org/licenses/bsd-license.php.

Shout_Driver

Shout_Driver_Ldap

Package: Shout
Author: Ben Klang ben@alkaloid.net
Located at Driver/Ldap.php

Methods summary
`public`	# `__construct( array $params = array() )` Constructs a new Shout LDAP driver object. Constructs a new Shout LDAP driver object. Parameters `$params` A hash containing connection parameters. Overrides `Shout_Driver::__construct()`
`public array`	# `getExtensions( string $account )` Get a list of users valid for the accounts Get a list of users valid for the accounts Parameters `$account` Account in which to search Returns `array` User information indexed by voice mailbox number
`public boolean`	# `addDestination( string $account, string $extension, string $type, string $destination )` Add a new destination valid for this extension. A destination is either a telephone number or a VoIP device. Add a new destination valid for this extension. A destination is either a telephone number or a VoIP device. Parameters `$account` Account for the extension `$extension` Extension for which to return destinations `$type` Destination type ("device" or "number") `$destination` The destination itself Returns `boolean` True on success.
`public`	# `getDestinations( string $account, string $extension )` Get a list of destinations valid for this extension. A destination is either a telephone number or a VoIP device. Get a list of destinations valid for this extension. A destination is either a telephone number or a VoIP device. Parameters `$account` Account for the extension `$extension` Extension for which to return destinations
`public`	# `deleteDestination( mixed $account, mixed $extension, mixed $type, mixed $destination )`
`public true`	# `saveExtension( string $account, string $extension, array $details )` Save an extension to the LDAP tree Save an extension to the LDAP tree Parameters `$account` Account to which the user should be added `$extension` Extension to be saved `$details` Phone numbers, PIN, options, etc to be saved Returns `true` on success, PEAR::Error object on error Throws `Shout_Exception` Overrides `Shout_Driver::saveExtension()`
`public boolean`	# `deleteExtension( string $account, string $extension )` Deletes an extension from the LDAP tree Deletes an extension from the LDAP tree Parameters `$account` Account to delete the user from `$extension` Extension of the user to be deleted Returns `boolean` True on success, PEAR::Error object on error Overrides `Shout_Driver::deleteExtension()`

Methods inherited from Shout_Driver
`checkAccountType(), deleteDevice(), factory(), getAccountProperties(), getAccounts(), getDialplan(), getHomeAccount(), getUsers(), saveDevice()`

Properties summary
`public mixed`	`$_ldapKey`	#
`public mixed`	`$_appKey`	#

Properties inherited from Shout_Driver
`$_params`

Packages

Classes

Class Shout_Driver_Ldap

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Throws

Overrides

Parameters

Returns

Overrides