class-ld-rest-topics-controller.php
10.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
<?php
/**
* LearnDash V2 REST API Topics Post Controller.
*
* This Controller class is used to GET/UPDATE/DELETE the LearnDash
* custom post type Topics (sfwd-topic).
*
* This class extends the LD_REST_Posts_Controller_V2 class.
*
* @since 3.3.0
* @package LearnDash\REST\V2
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
if ( ( ! class_exists( 'LD_REST_Topics_Controller_V2' ) ) && ( class_exists( 'LD_REST_Posts_Controller_V2' ) ) ) {
/**
* Class LearnDash V2 REST API Topics Post Controller.
*
* @since 3.3.0
* @uses LD_REST_Posts_Controller_V2
*/
class LD_REST_Topics_Controller_V2 extends LD_REST_Posts_Controller_V2 /* phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedClassFound */ {
/**
* LearnDash course steps object
*
* @var object
*/
protected $ld_course_steps_object = null;
/**
* Public constructor for class
*
* @since 3.3.0
*
* @param string $post_type Post type.
*/
public function __construct( $post_type = '' ) {
if ( empty( $post_type ) ) {
$post_type = learndash_get_post_type_slug( 'topic' );
}
$this->post_type = $post_type;
$this->metaboxes = array();
parent::__construct( $this->post_type );
/**
* Set the rest_base after the parent __constructor
* as it will set these var with WP specific details.
*/
$this->rest_base = $this->get_rest_base( 'topics' );
}
/**
* Prepare the LearnDash Post Type Settings.
*
* @since 3.3.0
*/
protected function register_fields() {
$this->register_fields_metabox();
do_action( 'learndash_rest_register_fields', $this->post_type, $this );
}
/**
* Register the Settings Fields from the Post Metaboxes.
*
* @since 3.3.0
*/
protected function register_fields_metabox() {
require_once LEARNDASH_LMS_PLUGIN_DIR . 'includes/settings/settings-metaboxes/class-ld-settings-metabox-topic-display-content.php';
$this->metaboxes['LearnDash_Settings_Metabox_Topic_Display_Content'] = LearnDash_Settings_Metabox_Topic_Display_Content::add_metabox_instance();
require_once LEARNDASH_LMS_PLUGIN_DIR . '/includes/settings/settings-metaboxes/class-ld-settings-metabox-topic-access-settings.php';
$this->metaboxes['LearnDash_Settings_Metabox_Topic_Access_Settings'] = LearnDash_Settings_Metabox_Topic_Access_Settings::add_metabox_instance();
if ( ! empty( $this->metaboxes ) ) {
foreach ( $this->metaboxes as $metabox ) {
$metabox->load_settings_values();
$metabox->load_settings_fields();
$this->register_rest_fields( $metabox->get_settings_metabox_fields(), $metabox );
}
}
}
/**
* Gets public schema.
*
* @since 3.3.0
*
* @return array
*/
public function get_public_item_schema() {
$schema = parent::get_public_item_schema();
$schema['title'] = 'topic';
return $schema;
}
/**
* For LearnDash post type we override the default order/orderby
* to ASC/title instead of the WP default DESC/date.
*
* @since 3.3.0
*
* @param array $query_params Quest params array.
* @param WP_Post_Type $post_type Post type string.
*/
public function rest_collection_params_filter( array $query_params, WP_Post_Type $post_type ) {
$query_params = parent::rest_collection_params_filter( $query_params, $post_type );
if ( ! isset( $query_params['lesson'] ) ) {
$lesson_required = false;
$query_params['lesson'] = array(
'description' => sprintf(
// translators: placeholder: lesson.
esc_html_x(
'Limit results to be within a specific %s.',
'placeholder: lesson',
'learndash'
),
LearnDash_Custom_Label::get_label( 'lesson' )
),
'type' => 'integer',
'required' => $lesson_required,
);
}
return $query_params;
}
/**
* Check user permission to get/access single Topic.
*
* @since 3.3.0
*
* @param object $request WP_REST_Request instance.
*
* @return bool True is used can get item.
*/
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 ( ! empty( $course_id ) ) {
// phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedVariableFound
$GLOBALS['course_id'] = $course_id;
}
$topic_id = (int) $request['id'];
if ( ( $topic_id ) && ( sfwd_lms_has_access( $topic_id ) ) ) {
return true;
}
// 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' )
) . ' ' . __CLASS__,
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 user permission to get/access Lessons.
*
* @since 3.3.0
*
* @param WP_REST_Request $request WP_REST_Request instance.
*
* @return bool True is used can get item.
*/
public function get_items_permissions_check( $request ) {
$return = parent::get_items_permissions_check( $request );
$this->rest_init_request_posts( $request );
if ( ( true === $return ) && ( 'view' === $request['context'] ) && ( ! learndash_is_admin_user() ) ) {
// If the archive setting is enabled we allow full listing.
if ( ! $this->rest_post_type_has_archive( $this->post_type ) ) {
if ( is_null( $this->course_post ) ) {
return new WP_Error(
'rest_post_invalid_id',
sprintf(
// translators: placeholder: Course.
esc_html_x(
'Missing %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() ) );
}
}
}
return $return;
}
/**
* Filter query args.
*
* @since 3.3.0
*
* @param array $query_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( $query_args, $request ) {
if ( ! $this->is_rest_request( $request ) ) {
return $query_args;
}
$query_args = parent::rest_query_filter( $query_args, $request );
// The course_post should be set in the local method get_items_permissions_check().
if ( ! is_null( $this->course_post ) ) {
$step_ids = array();
if ( $this->topic_post ) {
$step_ids = learndash_course_get_children_of_step( $this->course_post->ID, $this->topic_post->ID, $this->post_type );
} elseif ( $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 ) ) {
$query_args['post__in'] = $query_args['post__in'] ? array_intersect( $step_ids, $query_args['post__in'] ) : $step_ids;
$course_lessons_args = learndash_get_course_lessons_order( $this->course_post->ID );
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( ! isset( $_GET['orderby'] ) ) {
if ( isset( $course_lessons_args['orderby'] ) ) {
$query_args['orderby'] = $course_lessons_args['orderby'];
} else {
$query_args['orderby'] = 'title';
}
}
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( ! isset( $_GET['order'] ) ) {
if ( isset( $course_lessons_args['order'] ) ) {
$query_args['order'] = $course_lessons_args['order'];
} else {
$query_args['order'] = 'ASC';
}
}
} else {
$query_args['post__in'] = array( 0 );
}
}
return $query_args;
}
// End of functions.
}
}