From 1c984b30ff1830a7d92fdcdc29cbc6d38a07de18 Mon Sep 17 00:00:00 2001 From: TimZ99 Date: Fri, 6 Jul 2018 00:28:10 +0200 Subject: [PATCH] Updated documentation, added some small changes --- src/includes/functions.inc.php | 8 ++++---- src/psm/Module/Server/Controller/ServerController.php | 2 +- src/psm/Service/Database.php | 8 ++++---- src/psm/Txtmsg/CMBulkSMS.php | 5 +++-- src/psm/Txtmsg/Callr.php | 2 +- src/psm/Txtmsg/ClickSend.php | 2 +- src/psm/Txtmsg/Clickatell.php | 2 +- src/psm/Txtmsg/FreeMobileSMS.php | 2 +- src/psm/Txtmsg/FreeVoipDeal.php | 2 +- src/psm/Txtmsg/GatewayAPI.php | 2 +- src/psm/Txtmsg/Inetworx.php | 2 +- src/psm/Txtmsg/Messagebird.php | 3 ++- src/psm/Txtmsg/Mosms.php | 3 ++- src/psm/Txtmsg/Nexmo.php | 2 +- src/psm/Txtmsg/Octopush.php | 2 +- src/psm/Txtmsg/Plivo.php | 2 +- src/psm/Txtmsg/Smsglobal.php | 2 +- src/psm/Txtmsg/Smsgw.php | 2 +- src/psm/Txtmsg/Smsit.php | 2 +- src/psm/Txtmsg/SolutionsInfini.php | 2 +- src/psm/Txtmsg/Spryng.php | 2 +- src/psm/Txtmsg/Textmarketer.php | 2 +- src/psm/Txtmsg/Twilio.php | 2 +- src/psm/Util/Server/ArchiveManager.php | 2 +- src/psm/Util/Server/Updater/StatusUpdater.php | 1 - 25 files changed, 34 insertions(+), 32 deletions(-) diff --git a/src/includes/functions.inc.php b/src/includes/functions.inc.php index 2157ccdc..d54fc9a6 100644 --- a/src/includes/functions.inc.php +++ b/src/includes/functions.inc.php @@ -317,7 +317,7 @@ function psm_log_uptime($server_id, $status, $latency) { * @return string parsed message */ function psm_parse_msg($status, $type, $vars) { - $status = ($status == true) ? 'on' : 'off'; + $status = ($status === true) ? 'on' : 'off'; $message = psm_get_lang('notifications', $status.'_'.$type); @@ -339,7 +339,7 @@ function psm_parse_msg($status, $type, $vars) { * @param string $href * @param boolean $header return headers? * @param boolean $body return body? - * @param int $timeout connection timeout in seconds. defaults to PSM_CURL_TIMEOUT (10 secs). + * @param int|null $timeout connection timeout in seconds. defaults to PSM_CURL_TIMEOUT (10 secs). * @param boolean $add_agent add user agent? * @param string|bool $website_username Username website * @param string|bool $website_password Password website @@ -459,7 +459,7 @@ function psm_update_available() { $latest = psm_get_conf('version_update_check'); } - if ($latest != false) { + if ($latest !== false) { $current = psm_get_conf('version'); return version_compare($latest, $current, '>'); } else { @@ -523,7 +523,7 @@ function psm_build_pushover() { /** * - * @return \psm\Txtmsg\TxtmsgInterface + * @return \Telegram */ function psm_build_telegram() { $telegram = new \Telegram(); diff --git a/src/psm/Module/Server/Controller/ServerController.php b/src/psm/Module/Server/Controller/ServerController.php index fd2aa8c1..886094a9 100644 --- a/src/psm/Module/Server/Controller/ServerController.php +++ b/src/psm/Module/Server/Controller/ServerController.php @@ -35,7 +35,7 @@ class ServerController extends AbstractServerController { /** * Current server id - * @var int $server_id + * @var int|\PDOStatement $server_id */ protected $server_id; diff --git a/src/psm/Service/Database.php b/src/psm/Service/Database.php index c16dc87d..07beabfc 100644 --- a/src/psm/Service/Database.php +++ b/src/psm/Service/Database.php @@ -61,7 +61,7 @@ class Database { /** * PDOStatement of last query - * @var \PDOStatement $last + * @var int|bool|\PDOStatement $last */ protected $last; @@ -140,7 +140,7 @@ class Database { /** * Execute SQL statement and return number of affected rows * @param string $query - * @return int + * @return int|\PDOStatement */ public function exec($query) { try { @@ -155,9 +155,9 @@ class Database { /** * Prepare and execute SQL statement with parameters * @param string $query SQL statement - * @param Array $parameters An array of values with as many elements as there are bound parameters in the SQL statement + * @param array $parameters An array of values with as many elements as there are bound parameters in the SQL statement * @param boolean $fetch automatically fetch results, or return PDOStatement? - * @return @return array|\PDOStatement if $fetch = true, array, otherwise \PDOStatement + * @return array|\PDOStatement if $fetch = true, array, otherwise \PDOStatement */ public function execute($query, $parameters, $fetch = true) { try { diff --git a/src/psm/Txtmsg/CMBulkSMS.php b/src/psm/Txtmsg/CMBulkSMS.php index b9a665c5..a57b7658 100644 --- a/src/psm/Txtmsg/CMBulkSMS.php +++ b/src/psm/Txtmsg/CMBulkSMS.php @@ -189,8 +189,9 @@ class CMBulkSMS extends Core { /** * Create and execute the curl request * - * @return boolean True if message is sent + * @return boolean|string boolean if message is sent, else string */ + protected function executeCurlRequest() { $cr = curl_init(); curl_setopt_array($cr, array( @@ -209,7 +210,7 @@ class CMBulkSMS extends Core { $cErrorCode = curl_errno($cr); curl_close($cr); - $this->result = 1; + $this->result = true; // set result and log error if needed if ($cError) { $this->error = 'Response: CM SMS API:'.$cResponse.' cURL Error Code: '.$cErrorCode.'"'.$cError.'"'; diff --git a/src/psm/Txtmsg/Callr.php b/src/psm/Txtmsg/Callr.php index 8928cca6..71311e48 100644 --- a/src/psm/Txtmsg/Callr.php +++ b/src/psm/Txtmsg/Callr.php @@ -49,7 +49,7 @@ class Callr extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/ClickSend.php b/src/psm/Txtmsg/ClickSend.php index b797805b..fe116a30 100644 --- a/src/psm/Txtmsg/ClickSend.php +++ b/src/psm/Txtmsg/ClickSend.php @@ -46,7 +46,7 @@ class ClickSend extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/Clickatell.php b/src/psm/Txtmsg/Clickatell.php index 6eeab218..8d26ca8f 100644 --- a/src/psm/Txtmsg/Clickatell.php +++ b/src/psm/Txtmsg/Clickatell.php @@ -41,7 +41,7 @@ class Clickatell extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/FreeMobileSMS.php b/src/psm/Txtmsg/FreeMobileSMS.php index ff283428..1afc4b3b 100644 --- a/src/psm/Txtmsg/FreeMobileSMS.php +++ b/src/psm/Txtmsg/FreeMobileSMS.php @@ -42,7 +42,7 @@ class FreeMobileSMS extends Core { * @var string $error * @var string $http_code * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/FreeVoipDeal.php b/src/psm/Txtmsg/FreeVoipDeal.php index 7fef4192..1bd6e559 100755 --- a/src/psm/Txtmsg/FreeVoipDeal.php +++ b/src/psm/Txtmsg/FreeVoipDeal.php @@ -45,7 +45,7 @@ class FreeVoipDeal extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/GatewayAPI.php b/src/psm/Txtmsg/GatewayAPI.php index b73936f9..a07a527d 100644 --- a/src/psm/Txtmsg/GatewayAPI.php +++ b/src/psm/Txtmsg/GatewayAPI.php @@ -46,7 +46,7 @@ class GatewayAPI extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/Inetworx.php b/src/psm/Txtmsg/Inetworx.php index 92aff4d2..7a09a921 100644 --- a/src/psm/Txtmsg/Inetworx.php +++ b/src/psm/Txtmsg/Inetworx.php @@ -46,7 +46,7 @@ class Inetworx extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/Messagebird.php b/src/psm/Txtmsg/Messagebird.php index 33415b5a..3463c7d2 100644 --- a/src/psm/Txtmsg/Messagebird.php +++ b/src/psm/Txtmsg/Messagebird.php @@ -45,8 +45,9 @@ class Messagebird extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ + public function sendSMS($message) { $success = 1; $error = ''; diff --git a/src/psm/Txtmsg/Mosms.php b/src/psm/Txtmsg/Mosms.php index cdac5cbc..28420d5d 100644 --- a/src/psm/Txtmsg/Mosms.php +++ b/src/psm/Txtmsg/Mosms.php @@ -45,8 +45,9 @@ class Mosms extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ + public function sendSMS($message) { $error = ""; $success = 1; diff --git a/src/psm/Txtmsg/Nexmo.php b/src/psm/Txtmsg/Nexmo.php index 79986415..f7cb7ee7 100644 --- a/src/psm/Txtmsg/Nexmo.php +++ b/src/psm/Txtmsg/Nexmo.php @@ -47,7 +47,7 @@ class Nexmo extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/Octopush.php b/src/psm/Txtmsg/Octopush.php index 721ef338..b515f7c2 100644 --- a/src/psm/Txtmsg/Octopush.php +++ b/src/psm/Txtmsg/Octopush.php @@ -50,7 +50,7 @@ class Octopush extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/Plivo.php b/src/psm/Txtmsg/Plivo.php index 2e70b40f..f4790cf1 100644 --- a/src/psm/Txtmsg/Plivo.php +++ b/src/psm/Txtmsg/Plivo.php @@ -45,7 +45,7 @@ class Plivo extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/Smsglobal.php b/src/psm/Txtmsg/Smsglobal.php index b0e4c9de..da9a6276 100644 --- a/src/psm/Txtmsg/Smsglobal.php +++ b/src/psm/Txtmsg/Smsglobal.php @@ -46,7 +46,7 @@ class Smsglobal extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/Smsgw.php b/src/psm/Txtmsg/Smsgw.php index 77f1ab14..67fb22d9 100644 --- a/src/psm/Txtmsg/Smsgw.php +++ b/src/psm/Txtmsg/Smsgw.php @@ -45,7 +45,7 @@ class Smsgw extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/Smsit.php b/src/psm/Txtmsg/Smsit.php index 8ff5cb99..5b8f61b8 100644 --- a/src/psm/Txtmsg/Smsit.php +++ b/src/psm/Txtmsg/Smsit.php @@ -46,7 +46,7 @@ class Smsit extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/SolutionsInfini.php b/src/psm/Txtmsg/SolutionsInfini.php index 10291704..46091dd8 100644 --- a/src/psm/Txtmsg/SolutionsInfini.php +++ b/src/psm/Txtmsg/SolutionsInfini.php @@ -46,7 +46,7 @@ class SolutionsInfini extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/Spryng.php b/src/psm/Txtmsg/Spryng.php index bfea1470..df3eddb1 100644 --- a/src/psm/Txtmsg/Spryng.php +++ b/src/psm/Txtmsg/Spryng.php @@ -42,7 +42,7 @@ class Spryng extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/Textmarketer.php b/src/psm/Txtmsg/Textmarketer.php index f91415f3..5efbf621 100644 --- a/src/psm/Txtmsg/Textmarketer.php +++ b/src/psm/Txtmsg/Textmarketer.php @@ -44,7 +44,7 @@ class Textmarketer extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Txtmsg/Twilio.php b/src/psm/Txtmsg/Twilio.php index 54d5cf74..1d37c220 100644 --- a/src/psm/Txtmsg/Twilio.php +++ b/src/psm/Txtmsg/Twilio.php @@ -44,7 +44,7 @@ class Twilio extends Core { * @var int $success * @var string $error * - * @return int or string + * @return bool|string */ public function sendSMS($message) { diff --git a/src/psm/Util/Server/ArchiveManager.php b/src/psm/Util/Server/ArchiveManager.php index debe9c11..99b0b63f 100644 --- a/src/psm/Util/Server/ArchiveManager.php +++ b/src/psm/Util/Server/ArchiveManager.php @@ -47,7 +47,7 @@ class ArchiveManager { /** * Retention period - * @var \DateInterval $retention_period + * @var \DateInterval|bool $retention_period false if cleanup is disabled * @see setRetentionPeriod() */ protected $retention_period; diff --git a/src/psm/Util/Server/Updater/StatusUpdater.php b/src/psm/Util/Server/Updater/StatusUpdater.php index 9a395052..3879c57a 100644 --- a/src/psm/Util/Server/Updater/StatusUpdater.php +++ b/src/psm/Util/Server/Updater/StatusUpdater.php @@ -153,7 +153,6 @@ class StatusUpdater { * @return boolean */ protected function updatePing($max_runs, $run = 1) { - $errno = 0; // save response time $starttime = microtime(true); // set ping payload