Bitrix-D7  20.0.0
Класс Result
Граф наследования:Result:
Result MessageStatus SendMessage Result Response Response Pack Unpack AddResult DeleteResult UpdateResult DataResult Result Result Result Result ResponseFacebook ResponseGoogle ResponseVkontakte ResponseYandex

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

 __construct ()
 
 isSuccess ()
 Returns the result status. Подробнее...
 
 addError (Error $error)
 Adds the error. Подробнее...
 
 getErrors ()
 Returns an array of Error objects. Подробнее...
 
 getErrorCollection ()
 Returns the error collection. Подробнее...
 
 getErrorMessages ()
 Returns array of strings with error messages. Подробнее...
 
 addErrors (array $errors)
 Adds array of Error objects. Подробнее...
 
 setData (array $data)
 Sets data of the result. Подробнее...
 
 getData ()
 Returns data array saved into the result. Подробнее...
 

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

 $isSuccess = true
 
 $errors
 
 $data = array()
 

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

См. определение в файле main/lib/result.php строка 13

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

◆ __construct()

__construct ( )

Переопределяется в Response, Result, Response, UpdateResult, Result, Result, AddResult и DeleteResult.

См. определение в файле main/lib/result.php строка 24

25  {
26  $this->errors = new ErrorCollection();
27  }

Методы

◆ addError()

addError ( Error  $error)

Adds the error.

Аргументы
Error$error
Возвращает
$this

См. определение в файле main/lib/result.php строка 45

46  {
47  $this->isSuccess = false;
48  $this->errors[] = $error;
49  return $this;
50  }

◆ addErrors()

addErrors ( array  $errors)

Adds array of Error objects.

Аргументы
Error[]$errors
Возвращает
$this

См. определение в файле main/lib/result.php строка 93

94  {
95  $this->isSuccess = false;
96  $this->errors->add($errors);
97  return $this;
98  }

◆ getData()

getData ( )

Returns data array saved into the result.

Возвращает
array

См. определение в файле main/lib/result.php строка 125

126  {
127  return $this->data;
128  }

◆ getErrorCollection()

getErrorCollection ( )

Returns the error collection.

Возвращает
ErrorCollection

См. определение в файле main/lib/result.php строка 67

68  {
69  return $this->errors;
70  }

◆ getErrorMessages()

getErrorMessages ( )

Returns array of strings with error messages.

Возвращает
array

Переопределяется в Result.

См. определение в файле main/lib/result.php строка 77

78  {
79  $messages = array();
80 
81  foreach($this->getErrors() as $error)
82  $messages[] = $error->getMessage();
83 
84  return $messages;
85  }

◆ getErrors()

getErrors ( )

Returns an array of Error objects.

Возвращает
Error[]

Переопределяется в Result.

См. определение в файле main/lib/result.php строка 57

58  {
59  return $this->errors->toArray();
60  }

◆ isSuccess()

isSuccess ( )

Returns the result status.

Возвращает
bool

См. определение в файле main/lib/result.php строка 34

35  {
36  return $this->isSuccess;
37  }

◆ setData()

setData ( array  $data)

Sets data of the result.

Аргументы
array$data
Возвращает
$this

Переопределяется в Response, Response и Result.

См. определение в файле main/lib/result.php строка 105

106  {
107  // do not save sql expressions
108  foreach ($data as $k => $v)
109  {
110  if ($v instanceof SqlExpression)
111  {
112  unset($data[$k]);
113  }
114  }
115 
116  $this->data = $data;
117 
118  return $this;
119  }

Поля

◆ $data

$data = array()
protected

См. определение в файле main/lib/result.php строка 22

◆ $errors

$errors
protected

См. определение в файле main/lib/result.php строка 19

◆ $isSuccess

$isSuccess = true
protected

См. определение в файле main/lib/result.php строка 16


Объявления и описания членов класса находятся в файле:
Bitrix\Main\Result\$isSuccess
$isSuccess
Definition: main/lib/result.php:16
Bitrix\Main\Result\$errors
$errors
Definition: main/lib/result.php:19
Bitrix\Main\Result\isSuccess
isSuccess()
Returns the result status.
Definition: main/lib/result.php:34
Bitrix\Main\ORM\Data\Result\getErrors
getErrors()
Returns an array of Error objects.
Definition: main/lib/orm/data/result.php:67
Bitrix\Main\Result\$data
$data
Definition: main/lib/result.php:22