upgrade

main/inc/lib/SmsPluginLibraryInterface.php

@@ -0,0 +1,46 @@
+<?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 $plugin       ClockworksmsPlugin object
+     * @param object $tpl          Template object
+     * @param string $templateName Template file name
+     * @param string $messageKey   Text key from lang file
+     * @param array  $parameters   Data to fill message variables (if any)
+     *
+     * @return object Template object with message property updated
+     */
+    public function buildSms($plugin, $tpl, $templateName, $messageKey, $parameters = null);
+}