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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
<?php
namespace Automattic\WooCommerce\Blueprint;
use InvalidArgumentException;
/**
* A class returned by StepProcessor classes containing result of the process and messages.
*/
class StepProcessorResult {
const MESSAGE_TYPES = array( 'error', 'info', 'debug', 'warn' );
/**
* Messages
*
* @var array $messages
*/
private array $messages = array();
/**
* Indicate whether the process was success or not
*
* @var bool $success
*/
private bool $success;
/**
* Step name
*
* @var string $step_name
*/
private string $step_name;
/**
* Construct.
*
* @param bool $success Indicate whether the process was success or not.
* @param string $step_name The name of the step.
*/
public function __construct( bool $success, string $step_name ) {
$this->success = $success;
$this->step_name = $step_name;
}
/**
* Get messages.
*
* @param string $step_name The name of the step.
*
* @return void
*/
public function set_step_name( $step_name ) {
$this->step_name = $step_name;
}
/**
* Create a new instance with $success = true.
*
* @param string $stp_name The name of the step.
*
* @return StepProcessorResult
*/
public static function success( string $stp_name ): self {
return ( new self( true, $stp_name ) );
}
/**
* Add a new message.
*
* @param string $message message.
* @param string $type one of error, info.
*
* @throws InvalidArgumentException When incorrect type is given.
* @return void
*/
public function add_message( string $message, string $type = 'error' ) {
if ( ! in_array( $type, self::MESSAGE_TYPES, true ) ) {
// phpcs:ignore
throw new InvalidArgumentException( "{$type} is not allowed. Type must be one of " . implode( ',', self::MESSAGE_TYPES ) );
}
$this->messages[] = compact( 'message', 'type' );
}
/**
* Merge messages from another StepProcessorResult instance.
*
* @param StepProcessorResult $other The other StepProcessorResult instance.
*
* @return void
*/
public function merge_messages( StepProcessorResult $other ) {
$this->messages = array_merge( $this->messages, $other->get_messages() );
}
/**
* Add a new error message.
*
* @param string $message message.
*
* @return void
*/
public function add_error( string $message ) {
$this->add_message( $message );
}
/**
* Add a new debug message.
*
* @param string $message message.
*
* @return void
*/
public function add_debug( string $message ) {
$this->add_message( $message, 'debug' );
}
/**
* Add a new info message.
*
* @param string $message message.
*
* @return void
*/
public function add_info( string $message ) {
$this->add_message( $message, 'info' );
}
/**
* Add a new warn message.
*
* @param string $message message.
*
* @return void
*/
public function add_warn( string $message ) {
$this->add_message( $message, 'warn' );
}
/**
* Filter messages.
*
* @param string $type one of all, error, and info.
*
* @return array
*/
public function get_messages( string $type = 'all' ): array {
if ( 'all' === $type ) {
return $this->messages;
}
return array_filter(
$this->messages,
function ( $message ) use ( $type ) {
return $type === $message['type'];
}
);
}
/**
* Check to see if the result was success.
*
* @return bool
*/
public function is_success(): bool {
return true === $this->success && 0 === count( $this->get_messages( 'error' ) );
}
/**
* Get the name of the step.
*
* @return string The name of the step.
*/
public function get_step_name() {
return $this->step_name;
}
}
|