PHP Класс Piwik\Plugins\MobileMessaging\API

Наследование: extends Piwik\Plugin\API
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
addPhoneNumber ( string $phoneNumber ) : boolean add phone number
areSMSAPICredentialProvided ( ) : boolean determine if SMS API credential are available for the current user
deleteSMSAPICredential ( ) : boolean delete the SMS API credential
getActivatedPhoneNumbers ( ) : array get activated phone number list
getCreditLeft ( ) : string get remaining credit
getDelegatedManagement ( ) : boolean Determine if normal users can manage their own SMS API credential
getPhoneNumbers ( ) : array get phone number list
getSMSProvider ( ) : string return the SMS API Provider for the current user
removePhoneNumber ( string $phoneNumber ) : boolean remove phone number
sanitizePhoneNumber ( string $phoneNumber ) : string sanitize phone number
sendSMS ( string $content, string $phoneNumber, string $from ) : boolean send a SMS
setDelegatedManagement ( boolean $delegatedManagement ) Specify if normal users can manage their own SMS API credential
setSMSAPICredential ( string $provider, string $apiKey ) : boolean set the SMS API credential
validatePhoneNumber ( string $phoneNumber, string $verificationCode ) : boolean validate phone number

Приватные методы

Метод Описание
checkCredentialManagementRights ( )
getCredentialManagerLogin ( )
getCredentialManagerSettings ( )
getCurrentUserSettings ( )
getSMSAPICredential ( )
getUserSettings ( $user )
increaseCount ( $option, $phoneNumber )
isActivated ( $verificationCode )
retrievePhoneNumbers ( )
savePhoneNumbers ( $phoneNumbers )
setCredentialManagerSettings ( $settings )
setCurrentUserSettings ( $settings )
setUserSettings ( $user, $settings )

Описание методов

addPhoneNumber() публичный Метод

add phone number
public addPhoneNumber ( string $phoneNumber ) : boolean
$phoneNumber string
Результат boolean true

areSMSAPICredentialProvided() публичный Метод

determine if SMS API credential are available for the current user
public areSMSAPICredentialProvided ( ) : boolean
Результат boolean true if SMS API credential are available for the current user

deleteSMSAPICredential() публичный Метод

delete the SMS API credential
public deleteSMSAPICredential ( ) : boolean
Результат boolean true

getActivatedPhoneNumbers() публичный Метод

get activated phone number list
public getActivatedPhoneNumbers ( ) : array
Результат array $phoneNumber

getCreditLeft() публичный Метод

get remaining credit
public getCreditLeft ( ) : string
Результат string remaining credit

getDelegatedManagement() публичный Метод

Determine if normal users can manage their own SMS API credential
public getDelegatedManagement ( ) : boolean
Результат boolean false if SMS API credential only manageable by super admin, true otherwise

getPhoneNumbers() публичный Метод

get phone number list
public getPhoneNumbers ( ) : array
Результат array $phoneNumber => $isValidated

getSMSProvider() публичный Метод

return the SMS API Provider for the current user
public getSMSProvider ( ) : string
Результат string SMS API Provider

removePhoneNumber() публичный Метод

remove phone number
public removePhoneNumber ( string $phoneNumber ) : boolean
$phoneNumber string
Результат boolean true

sanitizePhoneNumber() публичный статический Метод

sanitize phone number
public static sanitizePhoneNumber ( string $phoneNumber ) : string
$phoneNumber string
Результат string sanitized phone number

sendSMS() публичный Метод

send a SMS
public sendSMS ( string $content, string $phoneNumber, string $from ) : boolean
$content string
$phoneNumber string
$from string
Результат boolean true

setDelegatedManagement() публичный Метод

Specify if normal users can manage their own SMS API credential
public setDelegatedManagement ( boolean $delegatedManagement )
$delegatedManagement boolean false if SMS API credential only manageable by super admin, true otherwise

setSMSAPICredential() публичный Метод

set the SMS API credential
public setSMSAPICredential ( string $provider, string $apiKey ) : boolean
$provider string SMS API provider
$apiKey string API Key
Результат boolean true if SMS API credential were validated and saved, false otherwise

validatePhoneNumber() публичный Метод

validate phone number
public validatePhoneNumber ( string $phoneNumber, string $verificationCode ) : boolean
$phoneNumber string
$verificationCode string
Результат boolean true if validation code is correct, false otherwise