| [ Index ] |
|
Code source de Horde 3.1.3 |
[Code source] [Imprimer] [Statistiques]
(pas de description)
| Poids: | 333 lignes (11 kb) |
| Inclus ou requis: | 0 fois |
| Référencé: | 0 fois |
| Nécessite: | 0 fichiers |
Net_SMS:: (11 méthodes):
Net_SMS()
getDrivers()
getGatewayInfo()
getGatewayParams()
getDefaultSendParams()
hasCapability()
authenticate()
send()
getBalance()
factory()
singleton()
| Net_SMS($params = null) X-Ref |
| Constructor param: array $params Any parameters needed for this gateway driver. |
| getDrivers() X-Ref |
| Returns a list of available gateway drivers. return: array An array of available drivers. |
| getGatewayInfo($gateway) X-Ref |
| Returns information on a gateway, such as name and a brief description, from the driver subclass getInfo() function. return: array An array of extra information. |
| getGatewayParams($gateway) X-Ref |
| Returns parameters for a gateway from the driver subclass getParams() function. param: string The name of the gateway driver for which to return the return: array An array of extra information. |
| getDefaultSendParams($gateway) X-Ref |
| Returns send parameters for a gateway from the driver subclass getDefaultSendParams()function. These are parameters which are available to the user during sending, such as setting a time for delivery, or type of SMS (normal text or flash), or source address, etc. param: string The name of the gateway driver for which to return the return: array An array of available send parameters. |
| hasCapability($capability) X-Ref |
| Query the current Gateway object to find out if it supports the given capability. param: string $capability The capability to test for. return: mixed Whether or not the capability is supported or any other |
| authenticate() X-Ref |
| Authenticates against the gateway if required. return: mixed True on success or PEAR Error on failure. |
| send(&$message) X-Ref |
| Sends a message to one or more recipients. Hands off the actual sending to the gateway driver. param: array $message The message to be sent, which is composed of: return: mixed True on success or PEAR Error on failure. |
| getBalance() X-Ref |
| If the current driver has a credit capability, queries the gateway for a credit balance and returns the value. return: integer Value indicating available credit or null if not |
| factory($driver, $params = array() X-Ref |
| Attempts to return a concrete Gateway instance based on $driver. param: string $driver The type of concrete Gateway subclass to return. param: array $params A hash containing any additional configuration or return: Net_SMS The newly created concrete Gateway instance or false on |
| singleton($driver, $params = array() X-Ref |
| Attempts to return a reference to a concrete Net_SMS instance based on $driver. It will only create a new instance if no Net_SMS instance with the same parameters currently exists. This method must be invoked as: $var = &Net_SMS::singleton() param: string $driver The type of concrete Net_SMS subclass to return. param: array $params A hash containing any additional configuration or return: mixed The created concrete Net_SMS instance, or false on error. |
| Généré le : Sun Feb 25 18:01:28 2007 | par Balluche grâce à PHPXref 0.7 |