You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
44 lines
1.1 KiB
44 lines
1.1 KiB
11 years ago
|
<?php
|
||
|
|
/* For licensing terms, see /license.txt */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Class SmsPluginLibraryInterface
|
||
|
|
*
|
||
|
|
* @author Julio Montoya
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
interface SmsPluginLibraryInterface
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* getMobilePhoneNumberById (retrieves a user mobile phone number by user id)
|
||
|
|
*
|
||
|
|
* @param int $userId
|
||
|
|
*
|
||
|
|
* @return int User's mobile phone number
|
||
|
|
*/
|
||
|
|
public function getMobilePhoneNumberById($userId);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param array $additionalParameters
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function send($additionalParameters);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param array $additionalParameters
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function getSms($additionalParameters);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* buildSms (builds an SMS from a template and data)
|
||
|
|
* @param object ClockworksmsPlugin object
|
||
|
|
* @param object Template object
|
||
|
|
* @param string Template file name
|
||
|
|
* @param string Text key from lang file
|
||
|
|
* @param array Data to fill message variables (if any)
|
||
|
|
* @return object Template object with message property updated
|
||
|
|
*/
|
||
|
|
public function buildSms($plugin, $tpl, $templateName, $messageKey, $parameters = null);
|
||
|
|
}
|