class-ld-rest-topics-controller.php
12.6 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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
<?php
/**
* LearnDash REST API V1 Topics Post Controller.
*
* @since 2.5.8
* @package LearnDash\REST\V1
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
if ( ( ! class_exists( 'LD_REST_Topics_Controller_V1' ) ) && ( class_exists( 'LD_REST_Posts_Controller_V1' ) ) ) {
/**
* Class LearnDash REST API V1 Topics Post Controller.
*
* @since 2.5.8
*/
class LD_REST_Topics_Controller_V1 extends LD_REST_Posts_Controller_V1 /* phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedClassFound */ {
/**
* LearnDash course steps object
*
* @var object
*/
protected $ld_course_steps_object = null;
/**
* Public constructor for class
*
* @since 2.5.8
*
* @param string $post_type Post type.
*/
public function __construct( $post_type = '' ) {
$this->post_type = 'sfwd-topic';
parent::__construct( $this->post_type );
$this->namespace = LEARNDASH_REST_API_NAMESPACE . '/' . $this->version;
$this->rest_base = LearnDash_Settings_Section::get_section_setting( 'LearnDash_Settings_Section_General_REST_API', $this->post_type );
}
/**
* Registers the routes for the objects of the controller.
*
* @since 2.5.8
*
* @see register_rest_route() in WordPress core.
*/
public function register_routes() {
parent::register_routes_wpv2();
$this->register_fields();
$collection_params = $this->get_collection_params();
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ),
'permission_callback' => array( $this, 'get_items_permissions_check' ),
'args' => $this->get_collection_params(),
),
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => array( $this, 'create_item' ),
'permission_callback' => array( $this, 'create_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
),
'schema' => array( $this, 'get_schema' ),
)
);
$schema = $this->get_item_schema();
$get_item_args = array(
'context' => $this->get_context_param( array( 'default' => 'view' ) ),
);
if ( isset( $schema['properties']['password'] ) ) {
$get_item_args['password'] = array(
'description' => esc_html__( 'The password for the post if it is password protected.', 'learndash' ),
'type' => 'string',
);
}
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P<id>[\d]+)',
array(
'args' => array(
'id' => array(
'description' => esc_html__( 'Unique identifier for the object.', 'learndash' ),
'type' => 'integer',
),
),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
'args' => $get_item_args,
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'update_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
array(
'methods' => WP_REST_Server::DELETABLE,
'callback' => array( $this, 'delete_item' ),
'permission_callback' => array( $this, 'delete_item_permissions_check' ),
'args' => array(
'force' => array(
'type' => 'boolean',
'default' => false,
'description' => esc_html__( 'Whether to bypass trash and force deletion.', 'learndash' ),
),
),
),
'schema' => array( $this, 'get_schema' ),
)
);
}
/**
* Gets sfwd-topics schema.
*
* @since 2.5.8
*
* @return array
*/
public function get_schema() {
$schema = $this->get_public_item_schema();
$schema['title'] = 'topic';
return $schema;
}
/**
* Filters collection parameters for the posts controller.
*
* @since 2.5.8
*
* @param array $query_params Quest params array.
* @param WP_Post_Type $post_type Post type object.
*/
public function rest_collection_params_filter( $query_params, $post_type ) {
$query_params = parent::rest_collection_params_filter( $query_params, $post_type );
if ( ! isset( $query_params['course'] ) ) {
$query_params['course'] = array(
'description' => sprintf(
// translators: placeholder: course.
esc_html_x(
'Limit results to be within a specific %s. Required for non-admin users.',
'placeholder: course',
'learndash'
),
LearnDash_Custom_Label::get_label( 'course' )
),
'type' => 'integer',
);
}
if ( ! isset( $query_params['lesson'] ) ) {
$query_params['lesson'] = array(
'description' => sprintf(
// translators: placeholder: lesson, course.
esc_html_x(
'Limit results to be within a specific %1$s. Must be used with %2$s parameter.',
'placeholder: lesson, course',
'learndash'
),
LearnDash_Custom_Label::get_label( 'lesson' ),
LearnDash_Custom_Label::get_label( 'course' )
),
'type' => 'integer',
);
}
return $query_params;
}
/**
* Check Single Topic Read Permissions.
*
* @since 2.5.8
*
* @param object $request WP_REST_Request instance.
*/
public function get_item_permissions_check( $request ) {
$return = parent::get_item_permissions_check( $request );
if ( ( true === $return ) && ( ! learndash_is_admin_user() ) ) {
$course_id = (int) $request['course'];
// If we don't have a course parameter we need to get all the courses the user has access to and all
// the courses the lesson is available in and compare.
if ( empty( $course_id ) ) {
$user_enrolled_courses = learndash_user_get_enrolled_courses( get_current_user_id() );
if ( empty( $user_enrolled_courses ) ) {
return new WP_Error( 'ld_rest_cannot_view', esc_html__( 'Sorry, you are not allowed to view this item.', 'learndash' ), array( 'status' => rest_authorization_required_code() ) );
}
$step_courses = learndash_get_courses_for_step( $request['id'], true );
if ( empty( $step_courses ) ) {
return new WP_Error( 'ld_rest_cannot_view', esc_html__( 'Sorry, you are not allowed to view this item.', 'learndash' ), array( 'status' => rest_authorization_required_code() ) );
}
$user_enrolled_courses = array_intersect( $user_enrolled_courses, array_keys( $step_courses ) );
if ( empty( $user_enrolled_courses ) ) {
return new WP_Error( 'ld_rest_cannot_view', esc_html__( 'Sorry, you are not allowed to view this item.', 'learndash' ), array( 'status' => rest_authorization_required_code() ) );
}
} else {
// But if the course parameter is provided we need to check the user has access and also
// check the step is part of that course.
$this->course_post = get_post( $course_id );
if ( ( ! $this->course_post ) || ( ! is_a( $this->course_post, 'WP_Post' ) ) || ( 'sfwd-courses' !== $this->course_post->post_type ) ) {
return new WP_Error(
'rest_post_invalid_id',
sprintf(
// translators: placeholder: course.
esc_html_x(
'Invalid %s ID.',
'placeholder: course',
'learndash'
),
LearnDash_Custom_Label::get_label( 'course' )
),
array( 'status' => 404 )
);
}
if ( ! sfwd_lms_has_access( $this->course_post->ID ) ) {
return new WP_Error( 'ld_rest_cannot_view', esc_html__( 'Sorry, you are not allowed to view this item.', 'learndash' ), array( 'status' => rest_authorization_required_code() ) );
}
$this->ld_course_steps_object = LDLMS_Factory_Post::course_steps( $this->course_post->ID );
$this->ld_course_steps_object->load_steps();
$lesson_ids = $this->ld_course_steps_object->get_children_steps( $this->course_post->ID, $this->post_type );
if ( empty( $lesson_ids ) ) {
return new WP_Error( 'ld_rest_cannot_view', esc_html__( 'Sorry, you are not allowed to view this item.', 'learndash' ), array( 'status' => rest_authorization_required_code() ) );
}
if ( ! in_array( $request['id'], $lesson_ids, true ) ) {
return new WP_Error( 'ld_rest_cannot_view', esc_html__( 'Sorry, you are not allowed to view this item.', 'learndash' ), array( 'status' => rest_authorization_required_code() ) );
}
}
}
return $return;
}
/**
* Check Topics Read Permissions.
*
* @since 2.5.8
*
* @param object $request WP_REST_Request instance.
*/
public function get_items_permissions_check( $request ) {
$return = parent::get_items_permissions_check( $request );
if ( ( true === $return ) && ( 'view' === $request['context'] ) ) {
$course_id = (int) $request['course'];
if ( ! empty( $course_id ) ) {
$this->course_post = get_post( $course_id );
if ( ( ! $this->course_post ) || ( ! is_a( $this->course_post, 'WP_Post' ) ) || ( 'sfwd-courses' !== $this->course_post->post_type ) ) {
return new WP_Error(
'rest_post_invalid_id',
sprintf(
// translators: placeholder: course.
esc_html_x(
'Invalid %s ID.',
'placeholder: course',
'learndash'
),
LearnDash_Custom_Label::get_label( 'course' )
),
array( 'status' => 404 )
);
}
}
$lesson_id = (int) $request['lesson'];
if ( ! empty( $lesson_id ) ) {
$this->lesson_post = get_post( $lesson_id );
if ( ( ! $this->lesson_post ) || ( ! is_a( $this->lesson_post, 'WP_Post' ) ) || ( 'sfwd-lessons' !== $this->lesson_post->post_type ) ) {
return new WP_Error(
'rest_post_invalid_id',
sprintf(
// translators: placeholder: Lesson.
esc_html_x(
'Invalid %s ID.',
'placeholder: Lesson',
'learndash'
),
LearnDash_Custom_Label::get_label( 'lesson' )
),
array( 'status' => 404 )
);
}
}
if ( ! learndash_is_admin_user() ) {
if ( ! $this->course_post ) {
return new WP_Error(
'rest_post_invalid_id',
sprintf(
// translators: placeholder: course.
esc_html_x(
'Invalid %s ID.',
'placeholder: course',
'learndash'
),
LearnDash_Custom_Label::get_label( 'course' )
),
array( 'status' => 404 )
);
} elseif ( ! sfwd_lms_has_access( $this->course_post->ID ) ) {
return new WP_Error( 'ld_rest_cannot_view', esc_html__( 'Sorry, you are not allowed to view this item.', 'learndash' ), array( 'status' => rest_authorization_required_code() ) );
}
}
}
return $return;
}
/**
* Filter query args.
*
* @since 2.5.8
*
* @param array $args Key value array of query var to query value.
* @param WP_REST_Request $request The request used.
*
* @return array Key value array of query var to query value.
*/
public function rest_query_filter( $args, $request ) {
if ( ! $this->is_rest_request( $request ) ) {
return $args;
}
// The course_post should be set in the local method get_items_permissions_check().
if ( ( $this->course_post ) && ( is_a( $this->course_post, 'WP_Post' ) ) && ( 'sfwd-courses' === $this->course_post->post_type ) ) {
$step_ids = array();
$step_ids = array();
if ( $this->lesson_post ) {
$step_ids = learndash_course_get_children_of_step( $this->course_post->ID, $this->lesson_post->ID, $this->post_type );
} elseif ( $this->course_post ) {
$step_ids = learndash_course_get_steps_by_type( $this->course_post->ID, $this->post_type );
}
if ( ! empty( $step_ids ) ) {
$args['post__in'] = $args['post__in'] ? array_intersect( $step_ids, $args['post__in'] ) : $step_ids;
$course_lessons_args = learndash_get_course_lessons_order( $this->course_post->ID );
if ( ! isset( $_GET['orderby'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $course_lessons_args['orderby'] ) ) {
$args['orderby'] = $course_lessons_args['orderby'];
} else {
$args['orderby'] = 'title';
}
}
if ( ! isset( $_GET['order'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $course_lessons_args['order'] ) ) {
$args['order'] = $course_lessons_args['order'];
} else {
$args['order'] = 'ASC';
}
}
} else {
$args['post__in'] = array( 0 );
}
}
return $args;
}
// End of functions.
}
}