Версия: 6.x
burger close
Класс GoogleFCM
Граф наследования:GoogleFCM:
AbstractProvider

Подробное описание

Осуществляет отправку Push уведомлений напрямую через Firebase Cloud Messenging. Применяется для мобильных приложений

Открытые члены

 __construct ()
 
 setApiUrl ($url)
 
 getApiUrl ()
 
 transfer ($push)
 
 sendQuery ($server_key, $platform, $push, $data)
 
 sendQueryLegacy ($server_key, $data)
 
 sendQueryApi ($data)
 
 prepareRequestList ($data)
 
 getResponse ()
 
 getError ()
 
- Открытые члены унаследованные от AbstractProvider
 __construct ()
 
 transfer ($push)
 
 getResponse ()
 
 getError ()
 

Поля данных

const API_URL = 'https://fcm.googleapis.com/fcm/send'
 
const API_URL_FIREBASE = 'https://fcm.googleapis.com/v1/projects/PROJECT_ID/messages:send'
 
 $last_response
 
 $targets = []
 
 $api_url
 
 $config
 

Защищенные члены

 fillTarget ($tokens)
 
 fillNotification ($platform, $data, $push)
 
 fillOptions ($platform, $data, $push)
 
 getServerKey ()
 
 checkApiSettings ()
 
- Защищенные члены унаследованные от AbstractProvider
 writeLog ($line)
 

Защищенные данные

 $last_error
 
- Защищенные данные унаследованные от AbstractProvider
 $log
 

Конструктор(ы)

__construct ( )

Методы

checkApiSettings ( )
protected

Проверяет указаны ли Project ID и файл с настройками Service Account в настройках модуля

Возвращает
void
Исключения
Exception
fillNotification (   $platform,
  $data,
  $push 
)
protected

Заполняет сведения уведомления

Аргументы
string$platformплатформа для которой отправляются уведомления
array$dataмассив с параметрами, которые пойдут в запрос к API
\PushSender\Model\Firebase\Push\RsPushNotice$push
Возвращает
array
fillOptions (   $platform,
  $data,
  $push 
)
protected

Заполняет секцию настроек

Аргументы
string$platformплатформа для которой отправляются уведомления
array$dataмассив с параметрами, которые пойдут в запрос к API
\PushSender\Model\Firebase\Push\RsPushNotice$push
Возвращает
array
fillTarget (   $tokens)
protected

Заполняет поля получателя уведомлений

Аргументы
array$tokens- Массив с токенами или один токен со сведениями
Возвращает
array
getApiUrl ( )

Возвращает URL для API запросов

Возвращает
string
getError ( )

Возвращает ошибку отправки уведомления. Возникает в случае, если не было попытки отправки, например, нет получателей.

Возвращает
string
getResponse ( )

Возвращает последний ответ от сервера после отправки уведомления

Возвращает
array
getServerKey ( )
protected

Возвращает ключ сервера Google FireBase Cloud Messaging

Исключения
Exception
Возвращает
string
prepareRequestList (   $data)

Возвращает массив данных для отправки уведомления по API (V1)

Аргументы
$data
Возвращает
array[]
sendQuery (   $server_key,
  $platform,
  $push,
  $data 
)

Отправка запроса в Google Firebase Google Cloud

Аргументы
string$server_key- ключ сервера от ЛК в Google FCM
string$platform- платформа для которой отправляются уведомления
\PushSender\Model\Firebase\Push\RsPushNotice$push- объект PUSH уведомления
array$data- массив данных
sendQueryApi (   $data)

Отправка запроса Firebase Cloud Messaging API (V1)

Аргументы
array$data- массив данных
sendQueryLegacy (   $server_key,
  $data 
)

Отправка запроса Cloud Messaging API (Legacy)

Аргументы
string$server_key- ключ сервера от ЛК в Google FCM
array$data- массив данных
setApiUrl (   $url)

Устанвливает URL для API запросов

Аргументы
mixed$url
transfer (   $push)

Выполняет отправку Push уведомления

Аргументы
RsPushNotice$push
Возвращает
bool

Поля

$api_url
$config
$last_error
protected
$last_response
$targets = []
const API_URL = 'https://fcm.googleapis.com/fcm/send'
const API_URL_FIREBASE = 'https://fcm.googleapis.com/v1/projects/PROJECT_ID/messages:send'