mirror of
https://github.com/RaspbianFrance/raspisms.git
synced 2025-04-20 16:37:48 +02:00
fix codestyle
This commit is contained in:
osaajani
parent
350dbb5b59
commit
adef27f862
37 changed files with 556 additions and 488 deletions
|
|
@ -12,7 +12,7 @@
|
|||
namespace adapters;
|
||||
|
||||
/**
|
||||
* Octopush SMS service with a shortcode adapter
|
||||
* Octopush SMS service with a shortcode adapter.
|
||||
*/
|
||||
class OctopushShortcodeAdapter implements AdapterInterface
|
||||
{
|
||||
|
|
@ -27,25 +27,25 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
private $datas;
|
||||
|
||||
/**
|
||||
* Octopush login
|
||||
* Octopush login.
|
||||
*/
|
||||
private $login;
|
||||
|
||||
/**
|
||||
* Octopush api key
|
||||
* Octopush api key.
|
||||
*/
|
||||
private $api_key;
|
||||
|
||||
/**
|
||||
* Sender name to use instead of shortcode
|
||||
* Sender name to use instead of shortcode.
|
||||
*/
|
||||
private $sender;
|
||||
|
||||
/**
|
||||
* Octopush api baseurl
|
||||
* Octopush api baseurl.
|
||||
*/
|
||||
private $api_url = 'https://www.octopush-dm.com/api';
|
||||
|
||||
|
||||
/**
|
||||
* Adapter constructor, called when instanciated by RaspiSMS.
|
||||
*
|
||||
|
|
@ -69,12 +69,11 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
return __CLASS__;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Uniq name of the adapter
|
||||
* It should be the classname of the adapter un snakecase
|
||||
* It should be the classname of the adapter un snakecase.
|
||||
*/
|
||||
public static function meta_uid() : string
|
||||
public static function meta_uid(): string
|
||||
{
|
||||
return 'octopush_shortcode_adapter';
|
||||
}
|
||||
|
|
@ -95,6 +94,7 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
public static function meta_description(): string
|
||||
{
|
||||
$credentials_url = 'https://www.octopush-dm.com/api-logins';
|
||||
|
||||
return '
|
||||
Envoi de SMS avec un shortcode en utilisant <a target="_blank" href="https://www.octopush.com/">Octopush</a>. Pour trouver vos clés API Octopush <a target="_blank" href="' . $credentials_url . '">cliquez ici.</a>
|
||||
';
|
||||
|
|
@ -128,7 +128,6 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
<b>Si vous utilisez un expéditeur nommé, le destinataire ne pourra pas répondre.</b>',
|
||||
'required' => false,
|
||||
],
|
||||
|
||||
];
|
||||
}
|
||||
|
||||
|
|
@ -172,10 +171,10 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
* @param bool $flash : Is the SMS a Flash SMS
|
||||
*
|
||||
* @return array : [
|
||||
* bool 'error' => false if no error, true else
|
||||
* ?string 'error_message' => null if no error, else error message
|
||||
* array 'uid' => Uid of the sms created on success
|
||||
* ]
|
||||
* bool 'error' => false if no error, true else
|
||||
* ?string 'error_message' => null if no error, else error message
|
||||
* array 'uid' => Uid of the sms created on success
|
||||
* ]
|
||||
*/
|
||||
public function send(string $destination, string $text, bool $flash = false)
|
||||
{
|
||||
|
|
@ -196,7 +195,7 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
'sms_type' => self::SMS_TYPE_LOWCOST,
|
||||
];
|
||||
|
||||
if ($this->sender !== null)
|
||||
if (null !== $this->sender)
|
||||
{
|
||||
$datas['sms_sender'] = $this->sender;
|
||||
}
|
||||
|
|
@ -212,25 +211,28 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
$response = curl_exec($curl);
|
||||
curl_close($curl);
|
||||
|
||||
if ($response === false)
|
||||
if (false === $response)
|
||||
{
|
||||
$response['error'] = true;
|
||||
$response['error_message'] = 'HTTP query failed.';
|
||||
|
||||
return $response;
|
||||
}
|
||||
|
||||
$response_decode = json_decode($response, true);
|
||||
if ($response_decode === null)
|
||||
if (null === $response_decode)
|
||||
{
|
||||
$response['error'] = true;
|
||||
$response['error_message'] = 'Invalid JSON for response.';
|
||||
|
||||
return $response;
|
||||
}
|
||||
|
||||
if ($response_decode['error_code'] != self::ERROR_CODE_OK)
|
||||
if (self::ERROR_CODE_OK !== $response_decode['error_code'])
|
||||
{
|
||||
$response['error'] = true;
|
||||
$response['error_message'] = 'Response indicate error code : ' . $response_decode['error_code'];
|
||||
|
||||
return $response;
|
||||
}
|
||||
|
||||
|
|
@ -239,16 +241,19 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
{
|
||||
$response['error'] = true;
|
||||
$response['error_message'] = 'Cannot extract SMS uid';
|
||||
|
||||
return $response;
|
||||
}
|
||||
|
||||
$response['uid'] = $uid;
|
||||
|
||||
return $response;
|
||||
}
|
||||
catch (\Throwable $t)
|
||||
{
|
||||
$response['error'] = true;
|
||||
$response['error_message'] = $t->getMessage();
|
||||
|
||||
return $response;
|
||||
}
|
||||
}
|
||||
|
|
@ -257,10 +262,10 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
* Method called to read SMSs of the number.
|
||||
*
|
||||
* @return array : [
|
||||
* bool 'error' => false if no error, true else
|
||||
* ?string 'error_message' => null if no error, else error message
|
||||
* array 'sms' => Array of the sms reads
|
||||
* ]
|
||||
* bool 'error' => false if no error, true else
|
||||
* ?string 'error_message' => null if no error, else error message
|
||||
* array 'sms' => Array of the sms reads
|
||||
* ]
|
||||
*/
|
||||
public function read(): array
|
||||
{
|
||||
|
|
@ -283,7 +288,7 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
|
||||
$datas = [
|
||||
'user_login' => $this->login,
|
||||
'api_key' => $this->api_key,
|
||||
|
|
@ -300,18 +305,18 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
$response = curl_exec($curl);
|
||||
curl_close($curl);
|
||||
|
||||
if ($response === false)
|
||||
if (false === $response)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
$response_decode = json_decode($response, true);
|
||||
if ($response_decode === null)
|
||||
if (null === $response_decode)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if ($response_decode['error_code'] != self::ERROR_CODE_OK)
|
||||
if (self::ERROR_CODE_OK !== $response_decode['error_code'])
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
|
@ -338,7 +343,7 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
$uid = $_POST['message_id'] ?? false;
|
||||
$status = $_POST['status'] ?? false;
|
||||
|
||||
if ($uid === false || $status === false)
|
||||
if (false === $uid || false === $status)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
|
@ -347,40 +352,40 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
{
|
||||
case 'DELIVERED':
|
||||
$status = \models\Sended::STATUS_DELIVERED;
|
||||
|
||||
break;
|
||||
|
||||
case 'NOT_ALLOWED':
|
||||
case 'INVALID_DESTINATION_ADDRESS':
|
||||
case 'OUT_OF_DATE':
|
||||
case 'EXPIRED':
|
||||
case 'BLACKLISTED_NUMBER':
|
||||
$status = \models\Sended::STATUS_FAILED;
|
||||
break;
|
||||
|
||||
default :
|
||||
break;
|
||||
default:
|
||||
$status = \models\Sended::STATUS_UNKNOWN;
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
return ['uid' => $uid, 'status' => $status];
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Method called on reception of a sms notification.
|
||||
*
|
||||
* @return array : [
|
||||
* bool 'error' => false on success, true on error
|
||||
* ?string 'error_message' => null on success, error message else
|
||||
* array 'sms' => array [
|
||||
* string 'at' : Recepetion date format Y-m-d H:i:s,
|
||||
* string 'text' : SMS body,
|
||||
* string 'origin' : SMS sender,
|
||||
* ]
|
||||
* bool 'error' => false on success, true on error
|
||||
* ?string 'error_message' => null on success, error message else
|
||||
* array 'sms' => array [
|
||||
* string 'at' : Recepetion date format Y-m-d H:i:s,
|
||||
* string 'text' : SMS body,
|
||||
* string 'origin' : SMS sender,
|
||||
* ]
|
||||
*
|
||||
* ]
|
||||
*/
|
||||
public static function reception_callback() : array
|
||||
public static function reception_callback(): array
|
||||
{
|
||||
$response = [
|
||||
'error' => false,
|
||||
|
|
@ -400,6 +405,7 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
{
|
||||
$response['error'] = true;
|
||||
$response['error_message'] = 'One required data of the callback is missing.';
|
||||
|
||||
return $response;
|
||||
}
|
||||
|
||||
|
|
@ -408,6 +414,7 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
{
|
||||
$response['error'] = true;
|
||||
$response['error_message'] = 'Invalid origin number : ' . mb_substr($number, 2);
|
||||
|
||||
return $response;
|
||||
}
|
||||
|
||||
|
|
@ -416,6 +423,7 @@ class OctopushShortcodeAdapter implements AdapterInterface
|
|||
'text' => $text,
|
||||
'origin' => $origin,
|
||||
];
|
||||
|
||||
return $response;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue