Overview

Packages

  • None
  • Shout

Classes

  • AccountDetailsForm
  • ConferenceDetailsForm
  • DeviceDetailsForm
  • ExtensionDetailsForm
  • MenuForm
  • NumberDetailsForm
  • RecordingDetailsForm
  • Shout
  • Shout_Ajax_Application
  • Shout_Driver
  • Shout_Driver_Ldap
  • Shout_Driver_Sql
  • Overview
  • Package
  • Class
  • Tree

Class Shout

Shout:: defines an set of utility methods for the Shout application.

Copyright 2005-2010 Alkaloid Networks LLC (http://projects.alkaloid.net)

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.

Package: Shout
Author: Ben Klang ben@alkaloid.net
Located at Shout.php
Methods summary
public static
# getMenu( mixed $returnType = 'object' )

Build Shout's list of menu items.

Build Shout's list of menu items.

public static boolean
# checkRights( string $permname, optional $permmask = null, options $numparents = 0 )

Checks for the given permissions for the current user on the given permission. Optionally check for higher-level permissions and ultimately test for superadmin priveleges.

Checks for the given permissions for the current user on the given permission. Optionally check for higher-level permissions and ultimately test for superadmin priveleges.

Parameters

$permname
Name of the permission to check
$permmask
$permmask Bitfield of permissions to check for
$numparents
<p>$numparents Check for the same permissions this many levels up the tree</p>

Returns

boolean
the effective permissions for the user.
public static array
# genDeviceAuth( string $account )

Generate new device authentication tokens.

Generate new device authentication tokens.

This method is designed to generate random strings for the authentication ID and password. The result is intended to be used for automatically generated device information. The user is prevented from specifying usernames and passwords for these reasons: 1) If a username and/or password can be easily guessed, monetary loss is likely through the fraudulent placing of telephone calls. This has been observed in the wild far too many times already.

2) The username and password are only needed to be programmed into the device once, and then stored semi-permanently. In some cases, the provisioning can be done automatically. For these reasons, having user-friendly usernames and passswords is not terribly important.

Parameters

$account
Account for this credential pair

Returns

array
Array of (string $deviceID, string $devicePassword)
public static
# getMenuActions( )
public static
# getNames( mixed $array )
public static
# getAdminTabs( )
Constants summary
string MAIN_MENU

default menu, used for creating initial menu

default menu, used for creating initial menu

# 'Main Menu'
string MAIN_RECORDING

default recording, used for creating initial menu

default recording, used for creating initial menu

# 'main_menu'
Properties summary
public array $applist
# array()
public string $_applist_curapp
# ''
public string $_applist_curfield
# ''
API documentation generated by ApiGen