commercetools-sdk-php-v2
The commercetools platform, import-api and PHP sdks generated from our api reference.
Loading...
Searching...
No Matches
lib
commercetools-api
src
Models
Payment
TransactionDraftModel.php
1
<?php
2
3
declare(strict_types=1);
9
namespace
Commercetools\Api\Models\Payment
;
10
11
use
Commercetools\Api\Models\Common\Money
;
12
use
Commercetools\Api\Models\Common\MoneyModel
;
13
use
Commercetools\Api\Models\Type\CustomFieldsDraft
;
14
use
Commercetools\Api\Models\Type\CustomFieldsDraftModel
;
15
use
Commercetools\Base\DateTimeImmutableCollection
;
16
use
Commercetools\Base\JsonObject
;
17
use
Commercetools\Base\JsonObjectModel
;
18
use
Commercetools\Base\MapperFactory
;
19
use DateTimeImmutable;
20
use stdClass;
21
25
final
class
TransactionDraftModel
extends
JsonObjectModel
implements
TransactionDraft
26
{
31
protected
$timestamp
;
32
37
protected
$type
;
38
43
protected
$amount
;
44
49
protected
$interactionId
;
50
55
protected
$state
;
56
61
protected
$custom
;
62
67
protected
$interfaceId
;
68
69
73
public
function
__construct
(
74
?DateTimeImmutable
$timestamp
=
null
,
75
?
string
$type
=
null
,
76
?
Money
$amount
=
null
,
77
?
string
$interactionId
=
null
,
78
?
string
$state
=
null
,
79
?
CustomFieldsDraft
$custom
=
null
,
80
?
string
$interfaceId
=
null
81
) {
82
$this->timestamp =
$timestamp
;
83
$this->type =
$type
;
84
$this->amount =
$amount
;
85
$this->interactionId =
$interactionId
;
86
$this->state =
$state
;
87
$this->custom =
$custom
;
88
$this->interfaceId =
$interfaceId
;
89
}
90
97
public
function
getTimestamp
()
98
{
99
if
(is_null($this->timestamp)) {
101
$data = $this->
raw
(self::FIELD_TIMESTAMP);
102
if
(is_null($data)) {
103
return
null
;
104
}
105
$data = DateTimeImmutable::createFromFormat(MapperFactory::DATETIME_FORMAT, $data);
106
if
(
false
=== $data) {
107
return
null
;
108
}
109
$this->timestamp = $data;
110
}
111
112
return
$this->timestamp
;
113
}
114
121
public
function
getType
()
122
{
123
if
(is_null($this->type)) {
125
$data = $this->
raw
(self::FIELD_TYPE);
126
if
(is_null($data)) {
127
return
null
;
128
}
129
$this->type = (string) $data;
130
}
131
132
return
$this->type
;
133
}
134
141
public
function
getAmount
()
142
{
143
if
(is_null($this->amount)) {
145
$data = $this->
raw
(self::FIELD_AMOUNT);
146
if
(is_null($data)) {
147
return
null
;
148
}
149
150
$this->amount = MoneyModel::of($data);
151
}
152
153
return
$this->amount
;
154
}
155
163
public
function
getInteractionId
()
164
{
165
if
(is_null($this->interactionId)) {
167
$data = $this->
raw
(self::FIELD_INTERACTION_ID);
168
if
(is_null($data)) {
169
return
null
;
170
}
171
$this->interactionId = (string) $data;
172
}
173
174
return
$this->interactionId
;
175
}
176
183
public
function
getState
()
184
{
185
if
(is_null($this->state)) {
187
$data = $this->
raw
(self::FIELD_STATE);
188
if
(is_null($data)) {
189
return
null
;
190
}
191
$this->state = (string) $data;
192
}
193
194
return
$this->state
;
195
}
196
203
public
function
getCustom
()
204
{
205
if
(is_null($this->custom)) {
207
$data = $this->
raw
(self::FIELD_CUSTOM);
208
if
(is_null($data)) {
209
return
null
;
210
}
211
212
$this->custom = CustomFieldsDraftModel::of($data);
213
}
214
215
return
$this->custom
;
216
}
217
224
public
function
getInterfaceId
()
225
{
226
if
(is_null($this->interfaceId)) {
228
$data = $this->
raw
(self::FIELD_INTERFACE_ID);
229
if
(is_null($data)) {
230
return
null
;
231
}
232
$this->interfaceId = (string) $data;
233
}
234
235
return
$this->interfaceId
;
236
}
237
238
242
public
function
setTimestamp
(?DateTimeImmutable
$timestamp
): void
243
{
244
$this->timestamp =
$timestamp
;
245
}
246
250
public
function
setType
(?
string
$type
): void
251
{
252
$this->type =
$type
;
253
}
254
258
public
function
setAmount
(?
Money
$amount
): void
259
{
260
$this->amount =
$amount
;
261
}
262
266
public
function
setInteractionId
(?
string
$interactionId
): void
267
{
268
$this->interactionId =
$interactionId
;
269
}
270
274
public
function
setState
(?
string
$state
): void
275
{
276
$this->state =
$state
;
277
}
278
282
public
function
setCustom
(?
CustomFieldsDraft
$custom
): void
283
{
284
$this->custom =
$custom
;
285
}
286
290
public
function
setInterfaceId
(?
string
$interfaceId
): void
291
{
292
$this->interfaceId =
$interfaceId
;
293
}
294
295
296
#[\ReturnTypeWillChange]
297
public
function
jsonSerialize
()
298
{
299
$data = $this->
toArray
();
300
if
(isset($data[
TransactionDraft::FIELD_TIMESTAMP
]) && $data[
TransactionDraft::FIELD_TIMESTAMP
] instanceof \DateTimeImmutable) {
301
$data[
TransactionDraft::FIELD_TIMESTAMP
] = $data[
TransactionDraft::FIELD_TIMESTAMP
]->setTimeZone(
new
\DateTimeZone(
'UTC'
))->format(
'c'
);
302
}
303
return
(
object
) $data;
304
}
305
}
Commercetools\Api\Models\Common\MoneyModel
Definition
MoneyModel.php:21
Commercetools\Api\Models\Payment\TransactionDraftModel
Definition
TransactionDraftModel.php:26
Commercetools\Api\Models\Payment\TransactionDraftModel\setCustom
setCustom(?CustomFieldsDraft $custom)
Definition
TransactionDraftModel.php:282
Commercetools\Api\Models\Payment\TransactionDraftModel\$type
$type
Definition
TransactionDraftModel.php:37
Commercetools\Api\Models\Payment\TransactionDraftModel\$custom
$custom
Definition
TransactionDraftModel.php:61
Commercetools\Api\Models\Payment\TransactionDraftModel\getTimestamp
getTimestamp()
Definition
TransactionDraftModel.php:97
Commercetools\Api\Models\Payment\TransactionDraftModel\getAmount
getAmount()
Definition
TransactionDraftModel.php:141
Commercetools\Api\Models\Payment\TransactionDraftModel\setInteractionId
setInteractionId(?string $interactionId)
Definition
TransactionDraftModel.php:266
Commercetools\Api\Models\Payment\TransactionDraftModel\jsonSerialize
jsonSerialize()
Definition
TransactionDraftModel.php:297
Commercetools\Api\Models\Payment\TransactionDraftModel\getType
getType()
Definition
TransactionDraftModel.php:121
Commercetools\Api\Models\Payment\TransactionDraftModel\$interfaceId
$interfaceId
Definition
TransactionDraftModel.php:67
Commercetools\Api\Models\Payment\TransactionDraftModel\getInterfaceId
getInterfaceId()
Definition
TransactionDraftModel.php:224
Commercetools\Api\Models\Payment\TransactionDraftModel\getInteractionId
getInteractionId()
Definition
TransactionDraftModel.php:163
Commercetools\Api\Models\Payment\TransactionDraftModel\setState
setState(?string $state)
Definition
TransactionDraftModel.php:274
Commercetools\Api\Models\Payment\TransactionDraftModel\setAmount
setAmount(?Money $amount)
Definition
TransactionDraftModel.php:258
Commercetools\Api\Models\Payment\TransactionDraftModel\getCustom
getCustom()
Definition
TransactionDraftModel.php:203
Commercetools\Api\Models\Payment\TransactionDraftModel\getState
getState()
Definition
TransactionDraftModel.php:183
Commercetools\Api\Models\Payment\TransactionDraftModel\setInterfaceId
setInterfaceId(?string $interfaceId)
Definition
TransactionDraftModel.php:290
Commercetools\Api\Models\Payment\TransactionDraftModel\setTimestamp
setTimestamp(?DateTimeImmutable $timestamp)
Definition
TransactionDraftModel.php:242
Commercetools\Api\Models\Payment\TransactionDraftModel\$amount
$amount
Definition
TransactionDraftModel.php:43
Commercetools\Api\Models\Payment\TransactionDraftModel\__construct
__construct(?DateTimeImmutable $timestamp=null, ?string $type=null, ?Money $amount=null, ?string $interactionId=null, ?string $state=null, ?CustomFieldsDraft $custom=null, ?string $interfaceId=null)
Definition
TransactionDraftModel.php:73
Commercetools\Api\Models\Payment\TransactionDraftModel\$timestamp
$timestamp
Definition
TransactionDraftModel.php:31
Commercetools\Api\Models\Payment\TransactionDraftModel\setType
setType(?string $type)
Definition
TransactionDraftModel.php:250
Commercetools\Api\Models\Payment\TransactionDraftModel\$state
$state
Definition
TransactionDraftModel.php:55
Commercetools\Api\Models\Payment\TransactionDraftModel\$interactionId
$interactionId
Definition
TransactionDraftModel.php:49
Commercetools\Api\Models\Type\CustomFieldsDraftModel
Definition
CustomFieldsDraftModel.php:21
Commercetools\Base\BaseJsonObject\raw
raw(string $field)
Definition
BaseJsonObject.php:57
Commercetools\Base\DateTimeImmutableCollection
Definition
DateTimeImmutableCollection.php:21
Commercetools\Base\JsonObjectModel
Definition
JsonObjectModel.php:15
Commercetools\Base\JsonObjectModel\toArray
toArray()
Definition
JsonObjectModel.php:32
Commercetools\Base\MapperFactory
Definition
MapperFactory.php:16
Commercetools\Api\Models\Common\Money
Definition
Money.php:15
Commercetools\Api\Models\Payment\TransactionDraft
Definition
TransactionDraft.php:18
Commercetools\Api\Models\Payment\TransactionDraft\FIELD_TIMESTAMP
const FIELD_TIMESTAMP
Definition
TransactionDraft.php:19
Commercetools\Api\Models\Type\CustomFieldsDraft
Definition
CustomFieldsDraft.php:15
Commercetools\Base\JsonObject
Definition
JsonObject.php:15
Commercetools\Api\Models\Payment
Definition
Payment.php:9
Generated by
1.9.8