first-time-configuration-route.php
9.19 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
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
<?php
namespace Yoast\WP\SEO\Routes;
use WP_REST_Request;
use WP_REST_Response;
use Yoast\WP\SEO\Actions\Configuration\First_Time_Configuration_Action;
use Yoast\WP\SEO\Conditionals\No_Conditionals;
use Yoast\WP\SEO\Main;
/**
* First_Time_Configuration_Route class.
*/
class First_Time_Configuration_Route implements Route_Interface {
use No_Conditionals;
/**
* Represents the first time configuration route.
*
* @var string
*/
const CONFIGURATION_ROUTE = '/configuration';
/**
* Represents a site representation route.
*
* @var string
*/
const SITE_REPRESENTATION_ROUTE = '/site_representation';
/**
* Represents a social profiles route.
*
* @var string
*/
const SOCIAL_PROFILES_ROUTE = '/social_profiles';
/**
* Represents a person's social profiles route.
*
* @deprecated 20.2
* @var string
*/
const PERSON_SOCIAL_PROFILES_ROUTE = '/person_social_profiles';
/**
* Represents a route to enable/disable tracking.
*
* @var string
*/
const ENABLE_TRACKING_ROUTE = '/enable_tracking';
/**
* Represents a route to check if current user has the correct capabilities to edit another user's profile.
*
* @var string
*/
const CHECK_CAPABILITY_ROUTE = '/check_capability';
/**
* Represents a route to save the first time configuration state.
*
* @var string
*/
const SAVE_CONFIGURATION_STATE_ROUTE = '/save_configuration_state';
/**
* Represents a route to save the first time configuration state.
*
* @var string
*/
const GET_CONFIGURATION_STATE_ROUTE = '/get_configuration_state';
/**
* The first tinme configuration action.
*
* @var First_Time_Configuration_Action
*/
private $first_time_configuration_action;
/**
* First_Time_Configuration_Route constructor.
*
* @param First_Time_Configuration_Action $first_time_configuration_action The first-time configuration action.
*/
public function __construct(
First_Time_Configuration_Action $first_time_configuration_action
) {
$this->first_time_configuration_action = $first_time_configuration_action;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
$site_representation_route = [
'methods' => 'POST',
'callback' => [ $this, 'set_site_representation' ],
'permission_callback' => [ $this, 'can_manage_options' ],
'args' => [
'company_or_person' => [
'type' => 'string',
'enum' => [
'company',
'person',
],
'required' => true,
],
'company_name' => [
'type' => 'string',
],
'company_logo' => [
'type' => 'string',
],
'company_logo_id' => [
'type' => 'integer',
],
'person_logo' => [
'type' => 'string',
],
'person_logo_id' => [
'type' => 'integer',
],
'company_or_person_user_id' => [
'type' => 'integer',
],
'description' => [
'type' => 'string',
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::CONFIGURATION_ROUTE . self::SITE_REPRESENTATION_ROUTE, $site_representation_route );
$social_profiles_route = [
'methods' => 'POST',
'callback' => [ $this, 'set_social_profiles' ],
'permission_callback' => [ $this, 'can_manage_options' ],
'args' => [
'facebook_site' => [
'type' => 'string',
],
'twitter_site' => [
'type' => 'string',
],
'other_social_urls' => [
'type' => 'array',
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::CONFIGURATION_ROUTE . self::SOCIAL_PROFILES_ROUTE, $social_profiles_route );
$check_capability_route = [
'methods' => 'GET',
'callback' => [ $this, 'check_capability' ],
'permission_callback' => [ $this, 'can_manage_options' ],
'args' => [
'user_id' => [
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::CONFIGURATION_ROUTE . self::CHECK_CAPABILITY_ROUTE, $check_capability_route );
$enable_tracking_route = [
'methods' => 'POST',
'callback' => [ $this, 'set_enable_tracking' ],
'permission_callback' => [ $this, 'can_manage_options' ],
'args' => [
'tracking' => [
'type' => 'boolean',
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::CONFIGURATION_ROUTE . self::ENABLE_TRACKING_ROUTE, $enable_tracking_route );
$save_configuration_state_route = [
'methods' => 'POST',
'callback' => [ $this, 'save_configuration_state' ],
'permission_callback' => [ $this, 'can_manage_options' ],
'args' => [
'finishedSteps' => [
'type' => 'array',
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::CONFIGURATION_ROUTE . self::SAVE_CONFIGURATION_STATE_ROUTE, $save_configuration_state_route );
$get_configuration_state_route = [
[
'methods' => 'GET',
'callback' => [ $this, 'get_configuration_state' ],
'permission_callback' => [ $this, 'can_manage_options' ],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::CONFIGURATION_ROUTE . self::GET_CONFIGURATION_STATE_ROUTE, $get_configuration_state_route );
}
/**
* Sets the site representation values.
*
* @param WP_REST_Request $request The request.
*
* @return WP_REST_Response
*/
public function set_site_representation( WP_REST_Request $request ) {
$data = $this
->first_time_configuration_action
->set_site_representation( $request->get_json_params() );
return new WP_REST_Response( $data, $data->status );
}
/**
* Sets the social profiles values.
*
* @param WP_REST_Request $request The request.
*
* @return WP_REST_Response
*/
public function set_social_profiles( WP_REST_Request $request ) {
$data = $this
->first_time_configuration_action
->set_social_profiles( $request->get_json_params() );
return new WP_REST_Response(
[ 'json' => $data ]
);
}
/**
* Checks if the current user has the correct capability to edit a specific user.
*
* @param WP_REST_Request $request The request.
*
* @return WP_REST_Response
*/
public function check_capability( WP_REST_Request $request ) {
$data = $this
->first_time_configuration_action
->check_capability( $request->get_param( 'user_id' ) );
return new WP_REST_Response( $data );
}
/**
* Enables or disables tracking.
*
* @param WP_REST_Request $request The request.
*
* @return WP_REST_Response
*/
public function set_enable_tracking( WP_REST_Request $request ) {
$data = $this
->first_time_configuration_action
->set_enable_tracking( $request->get_json_params() );
return new WP_REST_Response( $data, $data->status );
}
/**
* Checks if the current user has the right capability.
*
* @return bool
*/
public function can_manage_options() {
return \current_user_can( 'wpseo_manage_options' );
}
/**
* Checks if the current user has the capability to edit a specific user.
*
* @param WP_REST_Request $request The request.
*
* @return bool
*/
public function can_edit_user( WP_REST_Request $request ) {
$response = $this->first_time_configuration_action->check_capability( $request->get_param( 'user_id' ) );
return $response->success;
}
/**
* Checks if the current user has the capability to edit posts of other users.
*
* @return bool
*/
public function can_edit_other_posts() {
return \current_user_can( 'edit_others_posts' );
}
/**
* Saves the first time configuration state.
*
* @param WP_REST_Request $request The request.
*
* @return WP_REST_Response
*/
public function save_configuration_state( WP_REST_Request $request ) {
$data = $this
->first_time_configuration_action
->save_configuration_state( $request->get_json_params() );
return new WP_REST_Response( $data, $data->status );
}
/**
* Returns the first time configuration state.
*
* @return WP_REST_Response the state of the configuration.
*/
public function get_configuration_state() {
$data = $this
->first_time_configuration_action
->get_configuration_state();
return new WP_REST_Response( $data, $data->status );
}
/*** DEPRECATED METHODS ***/
/**
* Gets a person's social profiles values.
*
* @deprecated 20.2
* @codeCoverageIgnore
*
* @param WP_REST_Request $request The request.
*
* @return WP_REST_Response
*/
public function get_person_social_profiles( WP_REST_Request $request ) {
\_deprecated_function( __METHOD__, 'Yoast SEO 20.2' );
$data = $this
->first_time_configuration_action
->get_person_social_profiles( $request->get_param( 'user_id' ) );
return new WP_REST_Response( $data, $data->status );
}
/**
* Sets a person's social profiles values.
*
* @deprecated 20.2
* @codeCoverageIgnore
*
* @param WP_REST_Request $request The request.
*
* @return WP_REST_Response
*/
public function set_person_social_profiles( WP_REST_Request $request ) {
\_deprecated_function( __METHOD__, 'Yoast SEO 20.2' );
$data = $this
->first_time_configuration_action
->set_person_social_profiles( $request->get_json_params() );
return new WP_REST_Response(
[ 'json' => $data ]
);
}
}