Bitrix-D7  20.0.0
Класс Result
Граф наследования:Result:

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

 __construct ()
 
 setId ($id)
 
 getId ()
 Returns id of added record. Подробнее...
 
 __destruct ()
 
 addData (array $data)
 
 get ($offset)
 
 set ($offset, $value)
 
 addWarnings (array $errors)
 
 addWarning (Error $error)
 Adds the error. Подробнее...
 
 addError (Error $error)
 Adds the error. Подробнее...
 
 getWarnings ()
 Returns an array of Error objects. Подробнее...
 
 getWarningMessages ()
 Returns array of strings with warning messages. Подробнее...
 
 hasWarnings ()
 

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

 $id
 
 $warnings = array()
 
 $isSuccess = true
 

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

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

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

◆ __construct()

__construct ( )

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

19  {
20  $this->warnings = new ErrorCollection();
22  }

◆ __destruct()

__destruct ( )

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

39  {
40  //just quietly die in contrast Entity\Result either checked errors or not.
41  }

Методы

◆ addData()

addData ( array  $data)

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

44  {
45  if (is_array($this->data))
46  {
47  $this->data = $this->data + $data;
48  }
49  else
50  {
51  $this->data = $data;
52  }
53  }

◆ addError()

addError ( Error  $error)

Adds the error.

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

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

108  {
109  if ($error instanceof ResultWarning)
110  {
111  static::addWarning($error);
112  }
113  else
114  {
115  $this->isSuccess = false;
116  $this->errors[] = $error;
117  }
118 
119  return $this;
120  }

◆ addWarning()

addWarning ( Error  $error)

Adds the error.

Аргументы
Error$error

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

97  {
98  $this->warnings[] = $error;
99  }

◆ addWarnings()

addWarnings ( array  $errors)
Аргументы
Error[]$errors
Возвращает
void

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

83  {
84  /** @var Error $error */
85  foreach ($errors as $error)
86  {
87  $this->addWarning(ResultWarning::create($error));
88  }
89  }

◆ get()

get (   $offset)

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

56  {
57  if (isset($this->data[$offset]) || array_key_exists($offset, $this->data))
58  {
59  return $this->data[$offset];
60  }
61 
62  return null;
63  }

◆ getId()

getId ( )

Returns id of added record.

Возвращает
int

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

34  {
35  return $this->id;
36  }

◆ getWarningMessages()

getWarningMessages ( )

Returns array of strings with warning messages.

Возвращает
array

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

138  {
139  $messages = array();
140 
141  foreach($this->getWarnings() as $warning)
142  $messages[] = $warning->getMessage();
143 
144  return $messages;
145  }

◆ getWarnings()

getWarnings ( )

Returns an array of Error objects.

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

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

128  {
129  return $this->warnings->toArray();
130  }

◆ hasWarnings()

hasWarnings ( )
Возвращает
bool

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

152  {
153  return (count($this->warnings));
154  }

◆ set()

set (   $offset,
  $value 
)

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

66  {
67  if ($offset === null)
68  {
69  $this->data[] = $value;
70  }
71  else
72  {
73  $this->data[$offset] = $value;
74  }
75  }

◆ setId()

setId (   $id)

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

25  {
26  $this->id = $id;
27  }

Поля

◆ $id

$id
protected

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

◆ $isSuccess

$isSuccess = true
protected

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

◆ $warnings

$warnings = array()
protected

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


Объявления и описания членов класса находятся в файле:
Bitrix\Sale\Result\getWarnings
getWarnings()
Returns an array of Error objects.
Definition: sale/lib/result.php:127
Bitrix\Sale\Result\addWarning
addWarning(Error $error)
Adds the error.
Definition: sale/lib/result.php:96
Bitrix\Sale\Result\$id
$id
Definition: sale/lib/result.php:11
Bitrix\Sender\Connector\__construct
__construct(Base $connector)
Constructor.
Definition: resultview.php:40
Bitrix\Sale\ResultError\create
static create(Error $error)
Definition: sale/lib/result.php:167