\BXmaker\AuthUserPhone\Result

\BXmaker\AuthUserPhone\Result

namespace BXmaker\AuthUserPhone;
class Result
{
    //...
}

Методы

__construct

public function __construct($result = null);

createError

Создает объект ошибки и помещает в массив ошибок полученных в процессе выполнения, сокращения записи для setError(new \BXmaker\AuthUserPhone\Error(...))

/**
 * @param $errMessage
 * @param int $errCode
 * @param array $errMore
 * @return $this
 */
public function createError($errMessage, $errCode = 0, $errMore = array());

createErrorFromBitrixError

Создание ошибки из объекта \Bitrix\Main\Error

/**
 * @param \Bitrix\Main\Error $error
 * @return $this
 */
public function createErrorFromBitrixError($error);

createErrorFromException

Создание ошибки из объект \Exception

/**
 * @param \Exception $exception
 * @return $this
 */
public function createErrorFromException(\Exception $exception);

getErrorMessages

Вернет массив текстов ошибок

/**
 * @return array
 */
public function getErrorMessages();

getErrors

Получение массива ошибок

/**
 * @return array
 */
public function getErrors();

getFirstError

Возвращает первую ошибку из полученный в ходе выполнения операции

/**
 * @return \BXmaker\AuthUserPhone\Error
 */
public function getFirstError();

getJsonAnswerError

Массив с описанием ошибок, для отдачи в ответе на ajax запрос

/**
 * @return array
 */
public function getJsonAnswerError();

getMore

Возвращает массив дополнительных данных или конкретного именованного элемента если он существует иначе null

/**
 * @param null $name
 * @return array|mixed|null
 */
public function getMore($name = null);

getResult

Возвращает результат выполнения операции

/**
 * @return null
 */
public function getResult();

isSuccess

Проверка успешности операции

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

replaceMore

Замена дополнительных данных

/**
 * @param $name
 * @param $value
 * @return $this
 */
public function replaceMore($arData);

setError

Фиксирование ошибки в процессе выполнения операции

/**
 * @param \BXmaker\AuthUserPhone\Error $error
 * @return $this
 */
public function setError(\BXmaker\AuthUserPhone\Error $error);

setMore

Передача дополнительных данных

/**
 * @param $name
 * @param $value
 * @return $this
 */
public function setMore($name, $value);

setResult

Установка результата выполнения операции

/**
 * @param $result
 * @return $this
 */
public function setResult($result);

throwException

выбросить исключение на основе первой ошибки из списка ошибок

/**
 * @return mixed
 * @throws \BXmaker\AuthUserPhone\Exception\BaseException
 */
public function throwException();