Класс Result

Для чего нужен класс \Bxmaker\AuthUserPhone\Result?

Используется для возвращения результат  выполнения того или иного действия.$oResult = new \Bxmaker\AuthUserPhone\Result('Здесь какой то результат, например true');

/* или в случае наличия ошибки, можно указать только текст ошибки, а можно и код ошибки, дополнительную информацию по ошибке */
$oResult = new \Bxmaker\AuthUserPhone\Result(new \Bxmaker\AuthUserPhone\Error('текст ошибки'));

Какие есть методы для работы над результатом?

1. В экземпляре объекта  можно установить значение результирующее как сразу, при инициализации, так и после используя метод  setResult();$oResult->setResult('результат, например код статуса отправки смс');
2. Также помимо установки результат, можно  отметить в любой момент что появилась ошибка, используя метод setError();$oResult->setError(new \Bxmaker\AuthUserPhone\Error('текст', 'код', array('больше' => 'информации')));
3. Также к результату можно добавить дополнительную информацию, используя метод setMore();$oResult->setMore('ключ', 'значение');
4. Для проверки наличия ошибок используется метод isSuccess();if($oResult->isSuccess())
{
   /* ошибок нет */
}
else
{
   /* ошибки есть */
}

5. Для получения результата используется метод getResult();$oResult->getResult();
6. Для получения дополнительной информации - getMore();/* по умолчанию возвращается весь массив */
$oResult->getMore();

/* также можно запросить только значение с нужным ключом, при
этом если значение не найдено, будет возвращено значение == null */
$oResult->getMore('phone');

7. Для получения ошибок используется метод getErrors();/* данный метод возвращает массив экземпляров объекта \Bxmaker\AuthUserPhone\Error */
$arErrors = $oResult->getErrors();
foreach($arErrors as $error)
{
   $error->getMessage();
}

8. Также можно поучить сразу массив с сообщениями об ошибках - getErrorMessages();echo implode(', <br> ', $oResult->getErrorMessages());