Class Shout_Driver_Sql

Provides the SQL 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_Sql

Package: Shout
Author: Ben Klang ben@alkaloid.net
Located at Driver/Sql.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`	# `getAccounts( )` Get a list of accounts from the instantiated driver and filter the returned accounts for those which the current user can see/edit Get a list of accounts from the instantiated driver and filter the returned accounts for those which the current user can see/edit Returns `array` Accounts valid for this user Overrides `Shout_Driver::getAccounts()`
`public`	# `saveAccount( mixed $code, mixed $name, mixed $adminpin )`
`public`	# `getMenus( mixed $account )`
`public`	# `saveMenuInfo( mixed $account, mixed $details )`
`public`	# `deleteMenu( mixed $account, mixed $menu )`
`public`	# `getMenuActions( mixed $account, mixed $menu )`
`public`	# `deleteMenuAction( mixed $account, mixed $menu, mixed $digit )`
`public`	# `saveMenuAction( mixed $account, mixed $menu, mixed $digit, mixed $action, mixed $args )`
`public array`	# `getDevices( string $account )` Get a list of devices for a given account Get a list of devices for a given account Parameters `$account` Account in which to search for devicess Returns `array` Array of devices within this account with their information
`public true`	# `saveDevice( string $account, string $devid, array & $details )` Save a device (add or edit) to the backend. Save a device (add or edit) to the backend. Parameters `$account` The account in which this device is valid `$devid` Device ID to save `$details` Array of device details Returns `true` on success, PEAR::Error object on error Throws `Shout_Exception` Overrides `Shout_Driver::saveDevice()`
`public`	# `deleteDevice( <type> $account, <type> $devid )` Delete a device from the backend. Delete a device from the backend. This method is intended to be overridden by a child class. However it also implements some basic checks, so a typical backend will still call this method via parent:: Parameters `$account` `$devid` Overrides `Shout_Driver::deleteDevice()`
`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 on which to search Returns `array` User information indexed by voice mailbox number
`public true`	# `saveExtension( string $account, string $extension, array $userdetails )` Save a user to the LDAP tree Save a user to the LDAP tree Parameters `$account` Account to which the user should be added `$extension` Extension to be saved `$userdetails` 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 a user from the LDAP tree Deletes a user 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()`
`public`	# `getConferences( mixed $account )`
`public`	# `saveConference( mixed $account, mixed $roomno, mixed $details )`
`public`	# `getRecordings( mixed $account )`
`public`	# `getRecordingByName( mixed $account, mixed $filename )`
`public`	# `addRecording( mixed $account, mixed $name )`
`public`	# `deleteRecording( mixed $account, mixed $name )`
`public`	# `getNumbers( mixed $account = null )`
`public`	# `deleteNumber( mixed $number )`
`public`	# `saveNumber( mixed $number, mixed $account, mixed $menu )`

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

Properties inherited from Shout_Driver
`$_params`

Packages

Classes

Class Shout_Driver_Sql

Parameters

Overrides

Returns

Overrides

Parameters

Returns

Parameters

Returns

Throws

Overrides

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Throws

Overrides

Parameters

Returns

Overrides