From 5aec0838314936e4b01262749b82bddda61e5742 Mon Sep 17 00:00:00 2001
From: osaajani <pierre.lin@free.fr>
Date: Mon, 11 Nov 2019 21:01:40 +0100
Subject: [PATCH] create adapter

---
 adapters/AdapterInterface.php | 72 +++++++++++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)
 create mode 100644 adapters/AdapterInterface.php

diff --git a/adapters/AdapterInterface.php b/adapters/AdapterInterface.php
new file mode 100644
index 0000000..45eff82
--- /dev/null
+++ b/adapters/AdapterInterface.php
@@ -0,0 +1,72 @@
+<?php
+    namespace \adapters;
+
+    /**
+     * Interface for phones adapters
+     * Phone's adapters allow RaspiSMS to use a platform to communicate with a phone number.
+     * Its an adapter between internal and external code, as an API, command line software, physical modem, etc.
+     *
+     * All Phone Adapters must implement this interface
+     */
+    interface AdapterInterface
+    {
+        /**
+         * Name of the adapter.
+         * It should probably be the name of the service it adapt (e.g : Gammu SMSD, OVH SMS, SIM800L, etc.)
+         */
+        public const $name;
+
+        /**
+         * Description of the adapter.
+         * A short description of the service the adapter implements.
+         */
+        public const $description;
+        
+        /**
+         * Description of the datas expected by the adapter to help the user. (e.g : A list of expecteds Api credentials fields, with name and value)
+         */
+        public const $datas_help;
+
+        /**
+         * Does the implemented service support flash smss
+         */
+        public const $support_flash;
+
+
+        /**
+         * Phone number using the adapter
+         */
+        private $number;
+
+        /**
+         * Datas used to configure interaction with the implemented service. (e.g : Api credentials, ports numbers, etc.).
+         */
+        private $datas;
+
+        
+        /**
+         * Adapter constructor, called when instanciated by RaspiSMS
+         * @param string $number : Phone number the adapter is used for
+         * @param json string $datas : JSON string of the datas to configure interaction with the implemented service
+         * @return bool : True on successfull creation and connection, False on error
+         */
+        public function __construct (string $number, string $datas) : boolean;
+    
+    
+        /**
+         * Method called to send a SMS to a number
+         * @param string $destination : Phone number to send the sms to
+         * @param string $text : Text of the SMS to send
+         * @param bool $flash : Is the SMS a Flash SMS
+         * @return bool : True if send, False else
+         */
+        public function send (string $destination, string $text, boolean $flash) : boolean;
+
+
+        /**
+         * Method called to read SMSs of the number
+         * @param float $since : Unix microtime representation of the date from wich we want to read the SMSs
+         * @return array : Array of the sms reads
+         */
+        public function read (float $since) : array;
+    }