class-learndash-transaction-meta-dto.php
2.51 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<?php
/**
* This class provides the easy way to operate transaction meta.
*
* @since 4.5.0
*
* @package LearnDash
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
if ( ! class_exists( 'Learndash_Transaction_Meta_DTO' ) && class_exists( 'Learndash_DTO' ) ) {
/**
* Transaction meta DTO class. Used to map the transaction metadata.
*
* @since 4.5.0
*/
class Learndash_Transaction_Meta_DTO extends Learndash_DTO {
private const VALID_PRICE_TYPES = array( LEARNDASH_PRICE_TYPE_PAYNOW, LEARNDASH_PRICE_TYPE_SUBSCRIBE );
/**
* Properties are being cast to the specified type on construction.
*
* @since 4.5.0
*
* @var array<string, string>
*/
protected $cast = array(
'ld_payment_processor' => 'string',
'price_type' => 'string',
'pricing_info' => Learndash_Pricing_DTO::class,
'gateway_transaction' => Learndash_Transaction_Gateway_Transaction_DTO::class,
'has_trial' => 'bool',
'has_free_trial' => 'bool',
);
/**
* Payment gateway name.
*
* @since 4.5.0
*
* @var string
*/
public $ld_payment_processor = '';
/**
* Type. Valid values are LEARNDASH_PRICE_TYPE_PAYNOW and LEARNDASH_PRICE_TYPE_SUBSCRIBE.
*
* @since 4.5.0
*
* @var string
*/
public $price_type = '';
/**
* Pricing DTO.
*
* @since 4.5.0
*
* @var Learndash_Pricing_DTO
*/
public $pricing_info;
/**
* Gateway transaction DTO.
*
* @since 4.5.0
*
* @var Learndash_Transaction_Gateway_Transaction_DTO
*/
public $gateway_transaction;
/**
* If it has a trial or not.
*
* @since 4.5.0
*
* @var bool
*/
public $has_trial = false;
/**
* If it has a free trial or not.
*
* @since 4.5.0
*
* @var bool
*/
public $has_free_trial = false;
/**
* Validates properties on construction based on validators.
* Key is a property name, value is an array of validator objects.
*
* @since 4.5.0
*
* @return array<string,mixed>
*/
protected function get_validators(): array {
$validators = parent::get_validators();
if ( ! empty( $this->ld_payment_processor ) ) {
$validators['ld_payment_processor'] = array(
new Learndash_DTO_Property_Validator_Possible_Values(
array_keys( Learndash_Payment_Gateway::get_select_list() )
),
);
}
if ( ! empty( $this->price_type ) ) {
$validators['price_type'] = array(
new Learndash_DTO_Property_Validator_Possible_Values( self::VALID_PRICE_TYPES ),
);
}
return $validators;
}
}
}