\BXmaker\AuthUserPhone\Service\Base

\BXmaker\AuthUserPhone\Service\Base - Базовый класс который расширяют классы под конкретные сервисы

namespace BXmaker\AuthUserPhone\Service;
class Base
{
    //...
}

Константы

CONTENT_TYPE_JSON

\BXmaker\AuthUserPhone\Service\Base::CONTENT_TYPE_JSON = 'CONTENT_TYPE_JSON'

CONTENT_TYPE_XML

\BXmaker\AuthUserPhone\Service\Base::CONTENT_TYPE_XML = 'CONTENT_TYPE_XML'

CONTENT_TYPE_JSON_CHARSET_UTF

\BXmaker\AuthUserPhone\Service\Base::CONTENT_TYPE_JSON_CHARSET_UTF = 'CONTENT_TYPE_JSON_CHARSET_UTF'

CONTENT_TYPE_XML_CHARSET_UTF

\BXmaker\AuthUserPhone\Service\Base::CONTENT_TYPE_XML_CHARSET_UTF = 'CONTENT_TYPE_XML_CHARSET_UTF'

CONTENT_TYPE_FORM_URLENCODED

\BXmaker\AuthUserPhone\Service\Base::CONTENT_TYPE_FORM_URLENCODED = 'CONTENT_TYPE_FORM_URLENCODED'

CONTENT_TYPE_FORM_URLENCODED_CHARSET_UTF

\BXmaker\AuthUserPhone\Service\Base::CONTENT_TYPE_FORM_URLENCODED_CHARSET_UTF = 'CONTENT_TYPE_FORM_URLENCODED_CHARSET_UTF'

Методы

__construct

public function __construct($serviceItem);

callback

Обработчик оповещений от сервиса

public function callback();

fromJson

Преобразует данные массив из json формата, при необходимости автоматически конвертирует кодировку

/**
 * @param string $jsonString
 * @return array|null
 */
protected function fromJson($jsonString);

fromUtf

Конвертирует данные из кодировки UTF-8 в кодировку сайта

/**
 * @param $data
 * @return mixed
 */
protected function fromUtf($data);

fromWindows1251

Конвертирует данные из кодировки windows-1251 в кодировку сайта

/**
 * @param $data
 * @return mixed
 */
protected function fromWindows1251($data);

getCallbackUrl

Возвращает URL дял callback оповещений от сервиса

public function getCallbackUrl();

getConfig

Набор параметров для работы с сервисом, логин, пароль и тп

/**
 * @return array
 */
public static function getConfig();

getDescription

Описание сервиса для админки

/**
 * @return string
 */
public static function getDescription();

getHttpClient

Вернет объект для запросов к внешнему сервису

/**
 * @return \Bitrix\Main\Web\HttpClient
 */
public function getHttpClient($type = null);

getId

Возвращает идентификатор записи настроек текущего сервиса в базе данных ServiceTable необходим для проверки действий, используется в HistoryTable

/**
 * @return int|null
 */
public function getId();

getMessage

Вернет языкозависимое сообщение

/**
 * @param $name
 * @param array $arReplace
 * @return string|null
 */
public static function getMessage($name, $arReplace = []);

getName

Название сервиса для админки

/**
 * @return string
 */
public static function getName();

getParam

Возвращает значение параметра

/**
 * @param $name
 * @return mixed|null
 */
public function getParam($name);

getSiteId

Возвращает идентификатор сайта, для которого этот сервис настроен

public function getSiteId();

hasCallback

Проверка наличия у сервиса колбэка (оповещений с их сервиса), если есть, то будет использоваться обработчик, если нет колбэка, то при проверке статуса будет происходить тут же запрос к сервису

/**
 * @return bool
 */
public function hasCallback();

importUserCallStatuses

Импорт статусов по звонкам с сервиса

/**
 * @param array[] $arHistoryItems
 * @return array
 */
public function importUserCallStatuses($arHistoryItems);

isAvailableBotCall

Проверка поддерживает ли сервис звонок от робота

/**
 * @return bool
 */
public static function isAvailableBotCall();

isAvailableSms

Проверка поддерживает ли сервис смс

/**
 * @return bool
 */
public static function isAvailableSms();

isAvailableUserCall

Проверка поддерживает ли сервис звонок от пользователя

/**
 * @return bool
 */
public static function isAvailableUserCall();

manager

/**
 * @return \BXmaker\AuthUserPhone\Manager|null
 */
public function manager();

sendSms

Отправка смс сообщения Должен вернуться объект с полем EXT_ID (например идентификатор сообщения) - до 50 символов или null, либо содержащий ошибку

/**
 * @param $phone
 * @param $text
 * @return \BXmaker\AuthUserPhone\Result
 */
public function sendSms($phone, $text);

setUserCallConfirmed

Установка в истории отметки, что звонок от пользователя поступил на указанный номер, и можно считать телефон подтвержденным

/**
 * @param int $historyItemId
 * @return bool
 * @throws \Exception
 */
protected function setUserCallConfirmed($historyItemId);

startBotCall

Старт получения номера телефона на который нужно позвонить пользователю должен вернуться объект результата с доп. информацией

public function startBotCall($phone);

startUserCall

Старт получения номера телефона на который нужно позвонить пользователю

public function startUserCall($phone);

toJson

Преобразует данные в json формат, при необходимости автоматически конвертирует кодировку

/**
 * @param $arData
 * @return mixed
 */
protected function toJson($arData);

toUtf

Конвертирует данные в кодировку UTF-8, если кодировка сайта иная

/**
 * @param $data
 * @return mixed
 */
protected function toUtf($data);

toWindows1251

Конвертирует данные в кодировку windows-1251, если кодировка сайта иная

/**
 * @param $data
 * @return mixed
 */
protected function toWindows1251($data);

xmlText

Подготовка xml сущностей

/**
 * @return string
 */
protected function xmlText($text, $replaceNl = false);

xmlToArray

Распарсит xml и вернет массив

/**
 * @param $xml
 * @return array|null
 */
protected function xmlToArray($xml);