diff options
Diffstat (limited to 'plugins/MobileMessaging/API.php')
| -rw-r--r-- | plugins/MobileMessaging/API.php | 69 |
1 files changed, 37 insertions, 32 deletions
diff --git a/plugins/MobileMessaging/API.php b/plugins/MobileMessaging/API.php index 491bb46f86..bb2664ffff 100644 --- a/plugins/MobileMessaging/API.php +++ b/plugins/MobileMessaging/API.php @@ -6,10 +6,15 @@ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later * * @category Piwik_Plugins - * @package Piwik_MobileMessaging + * @package MobileMessaging */ +namespace Piwik\Plugins\MobileMessaging; + use Piwik\Piwik; use Piwik\Common; +use Piwik\Plugins\MobileMessaging\MobileMessaging; +use Piwik\Plugins\MobileMessaging\SMSProvider; +use Piwik\Plugins\PDFReports\API as PDFReportsAPI; /** * The MobileMessaging API lets you manage and access all the MobileMessaging plugin features including : @@ -17,9 +22,9 @@ use Piwik\Common; * - activate phone numbers * - check remaining credits * - send SMS - * @package Piwik_MobileMessaging + * @package MobileMessaging */ -class Piwik_MobileMessaging_API +class API { const VERIFICATION_CODE_LENGTH = 5; const SMS_FROM = 'Piwik'; @@ -27,7 +32,7 @@ class Piwik_MobileMessaging_API static private $instance = null; /** - * @return Piwik_MobileMessaging_API + * @return \Piwik\Plugins\MobileMessaging\API */ static public function getInstance() { @@ -39,11 +44,11 @@ class Piwik_MobileMessaging_API /** * @param string $provider - * @return Piwik_MobileMessaging_SMSProvider + * @return SMSProvider */ static private function getSMSProviderInstance($provider) { - return Piwik_MobileMessaging_SMSProvider::factory($provider); + return SMSProvider::factory($provider); } /** @@ -56,17 +61,17 @@ class Piwik_MobileMessaging_API Piwik::checkUserHasSomeViewAccess(); $credential = $this->getSMSAPICredential(); - return isset($credential[Piwik_MobileMessaging::API_KEY_OPTION]); + return isset($credential[MobileMessaging::API_KEY_OPTION]); } private function getSMSAPICredential() { $settings = $this->getCredentialManagerSettings(); return array( - Piwik_MobileMessaging::PROVIDER_OPTION => - isset($settings[Piwik_MobileMessaging::PROVIDER_OPTION]) ? $settings[Piwik_MobileMessaging::PROVIDER_OPTION] : null, - Piwik_MobileMessaging::API_KEY_OPTION => - isset($settings[Piwik_MobileMessaging::API_KEY_OPTION]) ? $settings[Piwik_MobileMessaging::API_KEY_OPTION] : null, + MobileMessaging::PROVIDER_OPTION => + isset($settings[MobileMessaging::PROVIDER_OPTION]) ? $settings[MobileMessaging::PROVIDER_OPTION] : null, + MobileMessaging::API_KEY_OPTION => + isset($settings[MobileMessaging::API_KEY_OPTION]) ? $settings[MobileMessaging::API_KEY_OPTION] : null, ); } @@ -79,7 +84,7 @@ class Piwik_MobileMessaging_API { $this->checkCredentialManagementRights(); $credential = $this->getSMSAPICredential(); - return $credential[Piwik_MobileMessaging::PROVIDER_OPTION]; + return $credential[MobileMessaging::PROVIDER_OPTION]; } /** @@ -99,8 +104,8 @@ class Piwik_MobileMessaging_API $settings = $this->getCredentialManagerSettings(); - $settings[Piwik_MobileMessaging::PROVIDER_OPTION] = $provider; - $settings[Piwik_MobileMessaging::API_KEY_OPTION] = $apiKey; + $settings[MobileMessaging::PROVIDER_OPTION] = $provider; + $settings[MobileMessaging::API_KEY_OPTION] = $apiKey; $this->setCredentialManagerSettings($settings); @@ -140,7 +145,7 @@ class Piwik_MobileMessaging_API $phoneNumbers[$phoneNumber] = $verificationCode; $this->savePhoneNumbers($phoneNumbers); - $this->increaseCount(Piwik_MobileMessaging::PHONE_NUMBER_VALIDATION_REQUEST_COUNT_OPTION, $phoneNumber); + $this->increaseCount(MobileMessaging::PHONE_NUMBER_VALIDATION_REQUEST_COUNT_OPTION, $phoneNumber); return true; } @@ -171,15 +176,15 @@ class Piwik_MobileMessaging_API Piwik::checkUserIsNotAnonymous(); $credential = $this->getSMSAPICredential(); - $SMSProvider = self::getSMSProviderInstance($credential[Piwik_MobileMessaging::PROVIDER_OPTION]); + $SMSProvider = self::getSMSProviderInstance($credential[MobileMessaging::PROVIDER_OPTION]); $SMSProvider->sendSMS( - $credential[Piwik_MobileMessaging::API_KEY_OPTION], + $credential[MobileMessaging::API_KEY_OPTION], $content, $phoneNumber, $from ); - $this->increaseCount(Piwik_MobileMessaging::SMS_SENT_COUNT_OPTION, $phoneNumber); + $this->increaseCount(MobileMessaging::SMS_SENT_COUNT_OPTION, $phoneNumber); return true; } @@ -194,9 +199,9 @@ class Piwik_MobileMessaging_API $this->checkCredentialManagementRights(); $credential = $this->getSMSAPICredential(); - $SMSProvider = self::getSMSProviderInstance($credential[Piwik_MobileMessaging::PROVIDER_OPTION]); + $SMSProvider = self::getSMSProviderInstance($credential[MobileMessaging::PROVIDER_OPTION]); return $SMSProvider->getCreditLeft( - $credential[Piwik_MobileMessaging::API_KEY_OPTION] + $credential[MobileMessaging::API_KEY_OPTION] ); } @@ -216,7 +221,7 @@ class Piwik_MobileMessaging_API $this->savePhoneNumbers($phoneNumbers); // remove phone number from reports - $pdfReportsAPIInstance = Piwik_PDFReports_API::getInstance(); + $pdfReportsAPIInstance = PDFReportsAPI::getInstance(); $reports = $pdfReportsAPIInstance->getReports( $idSite = false, $period = false, @@ -225,9 +230,9 @@ class Piwik_MobileMessaging_API ); foreach ($reports as $report) { - if ($report['type'] == Piwik_MobileMessaging::MOBILE_TYPE) { + if ($report['type'] == MobileMessaging::MOBILE_TYPE) { $reportParameters = $report['parameters']; - $reportPhoneNumbers = $reportParameters[Piwik_MobileMessaging::PHONE_NUMBERS_PARAMETER]; + $reportPhoneNumbers = $reportParameters[MobileMessaging::PHONE_NUMBERS_PARAMETER]; $updatedPhoneNumbers = array(); foreach ($reportPhoneNumbers as $reportPhoneNumber) { if ($reportPhoneNumber != $phoneNumber) { @@ -236,7 +241,7 @@ class Piwik_MobileMessaging_API } if (count($updatedPhoneNumbers) != count($reportPhoneNumbers)) { - $reportParameters[Piwik_MobileMessaging::PHONE_NUMBERS_PARAMETER] = $updatedPhoneNumbers; + $reportParameters[MobileMessaging::PHONE_NUMBERS_PARAMETER] = $updatedPhoneNumbers; // note: reports can end up without any recipients $pdfReportsAPIInstance->updateReport( @@ -262,8 +267,8 @@ class Piwik_MobileMessaging_API $settings = $this->getCurrentUserSettings(); $phoneNumbers = array(); - if (isset($settings[Piwik_MobileMessaging::PHONE_NUMBERS_OPTION])) { - $phoneNumbers = $settings[Piwik_MobileMessaging::PHONE_NUMBERS_OPTION]; + if (isset($settings[MobileMessaging::PHONE_NUMBERS_OPTION])) { + $phoneNumbers = $settings[MobileMessaging::PHONE_NUMBERS_OPTION]; } return $phoneNumbers; @@ -273,7 +278,7 @@ class Piwik_MobileMessaging_API { $settings = $this->getCurrentUserSettings(); - $settings[Piwik_MobileMessaging::PHONE_NUMBERS_OPTION] = $phoneNumbers; + $settings[MobileMessaging::PHONE_NUMBERS_OPTION] = $phoneNumbers; $this->setCurrentUserSettings($settings); } @@ -383,7 +388,7 @@ class Piwik_MobileMessaging_API $settings = $this->getCredentialManagerSettings(); - $settings[Piwik_MobileMessaging::API_KEY_OPTION] = null; + $settings[MobileMessaging::API_KEY_OPTION] = null; $this->setCredentialManagerSettings($settings); @@ -398,7 +403,7 @@ class Piwik_MobileMessaging_API private function setUserSettings($user, $settings) { Piwik_SetOption( - $user . Piwik_MobileMessaging::USER_SETTINGS_POSTFIX_OPTION, + $user . MobileMessaging::USER_SETTINGS_POSTFIX_OPTION, Common::json_encode($settings) ); } @@ -420,7 +425,7 @@ class Piwik_MobileMessaging_API private function getUserSettings($user) { - $optionIndex = $user . Piwik_MobileMessaging::USER_SETTINGS_POSTFIX_OPTION; + $optionIndex = $user . MobileMessaging::USER_SETTINGS_POSTFIX_OPTION; $userSettings = Piwik_GetOption($optionIndex); if (empty($userSettings)) { @@ -450,7 +455,7 @@ class Piwik_MobileMessaging_API public function setDelegatedManagement($delegatedManagement) { Piwik::checkUserIsSuperUser(); - Piwik_SetOption(Piwik_MobileMessaging::DELEGATED_MANAGEMENT_OPTION, $delegatedManagement); + Piwik_SetOption(MobileMessaging::DELEGATED_MANAGEMENT_OPTION, $delegatedManagement); } /** @@ -461,6 +466,6 @@ class Piwik_MobileMessaging_API public function getDelegatedManagement() { Piwik::checkUserHasSomeViewAccess(); - return Piwik_GetOption(Piwik_MobileMessaging::DELEGATED_MANAGEMENT_OPTION) == 'true'; + return Piwik_GetOption(MobileMessaging::DELEGATED_MANAGEMENT_OPTION) == 'true'; } } |