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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
<?php
namespace AutomateWoo\Rest_Api\Controllers;
use AutomateWoo\Permissions;
use AutomateWoo\Workflows\Presets\PresetInterface;
use WP_Error;
use WP_REST_Request;
use WP_REST_Response;
use WP_REST_Server;
defined( 'ABSPATH' ) || exit;
/**
* Presets Rest API controller.
*
* @since 5.1.0
*/
class WorkflowPresets extends AbstractController {
/**
* Route base.
*
* @var string
*/
protected $rest_base = 'presets';
/**
* Register the routes.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
"/{$this->rest_base}/",
[
[
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'get_items' ],
'permission_callback' => [ Permissions::class, 'can_manage' ],
],
'schema' => [ $this, 'get_public_item_schema' ],
]
);
register_rest_route(
$this->namespace,
"/{$this->rest_base}/create-workflow",
[
[
'methods' => WP_REST_Server::CREATABLE,
'callback' => [ $this, 'create_workflow' ],
'permission_callback' => [ Permissions::class, 'can_manage' ],
],
'args' => [
'preset_name' => [
'description' => __( 'The name of the preset.', 'automatewoo' ),
'type' => 'string',
'validate_callback' => 'rest_validate_request_arg',
],
],
]
);
}
/**
* Retrieves workflow presets and guides.
*
* This endpoint returns "workflow presets" and "workflow guides" where guides are just links to docs.
* Eventually these guides will be converted to full presets.
*
* @param WP_REST_Request $request
*
* @return WP_Error|WP_REST_Response
*/
public function get_items( $request ) {
$array_presets = AW()->preset_service()->get_presets();
$presets = [];
$guides = [];
foreach ( $array_presets as $array_preset ) {
$preset = $this->prepare_item_for_response( $array_preset, $request );
$preset = $this->prepare_response_for_collection( $preset );
if ( PresetInterface::PRESET_TYPE_GUIDE === $array_preset['type'] ) {
$guides[] = $preset;
} else {
$presets[] = $preset;
}
}
if ( empty( $presets ) && empty( $guides ) ) {
return new WP_Error( 'aw_preset_missing', __( 'Unable to load preset workflows. Please check the logs for more info.', 'automatewoo' ) );
}
return rest_ensure_response( array_merge( $presets, $guides ) );
}
/**
* Handle creating a workflow from a preset.
*
* @param WP_REST_Request $request
*
* @return WP_Error|WP_REST_Response
*/
public function create_workflow( $request ) {
$workflow = AW()->preset_service()->save_as_workflow_by_id( $request->get_param( 'preset_name' ) );
if ( is_wp_error( $workflow ) ) {
return $workflow;
}
return rest_ensure_response(
[
'workflow_id' => $workflow->id,
]
);
}
/**
* Prepares the item for the REST response.
*
* @param PresetInterface $preset Preset object.
* @param \WP_REST_Request $request Request object.
*
* @return \WP_REST_Response|\WP_Error Response object on success, or WP_Error object on failure.
*/
public function prepare_item_for_response( $preset, $request ) {
$fields = $this->get_fields_for_response( $request );
$data = [];
if ( in_array( 'name', $fields, true ) ) {
$data['name'] = $preset->get( 'name' );
}
if ( in_array( 'type', $fields, true ) ) {
$data['type'] = $preset->get( 'type' );
if ( PresetInterface::PRESET_TYPE_GUIDE === $data['type'] && in_array( 'link', $fields, true ) ) {
$data['link'] = $preset->get( 'link' );
}
}
if ( in_array( 'title', $fields, true ) ) {
$data['title'] = $preset->get( 'title' );
}
if ( in_array( 'description', $fields, true ) ) {
$data['description'] = $preset->get( 'description' );
}
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
$data = $this->add_additional_fields_to_object( $data, $request );
$data = $this->filter_response_by_context( $data, $context );
return rest_ensure_response( $data );
}
/**
* Get the Preset schema, conforming to JSON Schema.
*
* @return array
*/
public function get_item_schema() {
$schema = [
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'preset',
'type' => 'object',
'properties' => [
'name' => [
'description' => __( 'Unique name for the preset.', 'automatewoo' ),
'type' => 'string',
'context' => [ 'view', 'edit' ],
'readonly' => true,
],
'type' => [
'description' => __( 'A string defining the type of the preset workflow.', 'automatewoo' ),
'type' => 'string',
'context' => [ 'view' ],
'readonly' => true,
],
'title' => [
'description' => __( 'A short title indicating the purpose of this preset workflow.', 'automatewoo' ),
'type' => 'string',
'context' => [ 'view' ],
'readonly' => true,
],
'description' => [
'description' => __( 'A short description about this preset.', 'automatewoo' ),
'type' => 'string',
'context' => [ 'view' ],
'readonly' => true,
],
'link' => [
'description' => __( 'Link to the documentation page for the preset.', 'automatewoo' ),
'type' => 'string',
'context' => [ 'view' ],
'readonly' => true,
],
],
];
return $this->add_additional_fields_schema( $schema );
}
}
|