class-ldlms-model-course.php
14.8 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
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
<?php
/**
* Class to extend LDLMS_Model_Post to LDLMS_Model_Course.
*
* @since 2.5.0
* @package LearnDash\Course
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
if ( ( ! class_exists( 'LDLMS_Model_Course' ) ) && ( class_exists( 'LDLMS_Model_Post' ) ) ) {
/**
* Class for LearnDash Model Course.
*
* @since 2.5.0
* @uses LDLMS_Model_Post
*/
class LDLMS_Model_Course extends LDLMS_Model_Post {
/**
* Steps Page Results.
*
* @since 3.4.0
*
* @var array pager Array of pagination results for steps;
*/
protected $pager = array();
/**
* Class constructor.
*
* @since 3.2.0
*
* @param int $post_id Course Post ID to load.
*
* @throws LDLMS_Exception_NotFound When post not loaded.
*
* @return mixed instance of class or exception.
*/
public function __construct( $post_id = 0 ) {
$this->post_type = learndash_get_post_type_slug( 'course' );
if ( ! $this->init( $post_id ) ) {
throw new LDLMS_Exception_NotFound();
} else {
return $this;
}
}
/**
* Initialize post.
*
* @since 3.2.0
*
* @param int $post_id Course Post ID to load.
*
* @return bool True if post was loaded. False otherwise.
*/
private function init( $post_id = 0 ) {
$post_id = absint( $post_id );
if ( ! empty( $post_id ) ) {
$post = get_post( $post_id );
if ( ( is_a( $post, 'WP_Post' ) ) && ( $post->post_type === $this->post_type ) ) {
$this->post_id = $post_id;
$this->post = $post;
$this->load_settings();
return true;
}
}
return false;
}
/**
* Load the Post Settings.
*
* @since 2.5.0
*
* @param bool $force Force reload of settings.
*
* @return bool settings loaded.
*/
public function load_settings( $force = false ) {
parent::load_settings( $force );
return $this->settings_loaded;
}
/**
* Get Lessons order/orderby setting
*/
public function get_settings_order() {
$course_lessons_args = array(
'order' => '',
'orderby' => '',
);
if ( 'yes' === LearnDash_Settings_Section::get_section_setting( 'LearnDash_Settings_Courses_Builder', 'shared_steps' ) ) {
$course_lessons_args['orderby'] = 'post__in';
return $course_lessons_args;
} else {
$lessons_options = learndash_get_option( 'sfwd-lessons' );
if ( ( isset( $lessons_options['order'] ) ) && ( ! empty( $lessons_options['order'] ) ) ) {
$course_lessons_args['order'] = $lessons_options['order'];
}
if ( ( isset( $lessons_options['orderby'] ) ) && ( ! empty( $lessons_options['orderby'] ) ) ) {
$course_lessons_args['orderby'] = $lessons_options['orderby'];
}
}
if ( ! empty( $this->post_id ) ) {
if ( ( isset( $this->settings['course_lesson_order'] ) ) && ( ! empty( $this->settings['course_lesson_order'] ) ) ) {
$course_lessons_args['order'] = $this->settings['course_lesson_order'];
}
if ( ( isset( $course_settings['course_lesson_orderby'] ) ) && ( ! empty( $course_settings['course_lesson_orderby'] ) ) ) {
$course_lessons_args['orderby'] = $this->settings['course_lesson_orderby'];
}
}
/**
* Filters course lessons order query arguments.
*
* @param array $course_lesson_args An array of course lesson order arguments.
* @param int $course_id Course ID.
*/
return apply_filters( 'learndash_course_lessons_order', $course_lessons_args, $this->post_id );
}
/**
* Get Lessons per page setting
*/
public function get_settings_lessons_per_page() {
$course_lessons_per_page = learndash_get_course_lessons_per_page( $this->post_id );
return $course_lessons_per_page;
}
/**
* Get Topics per page setting
*/
public function get_settings_topics_per_page() {
$course_topics_per_page = learndash_get_course_topics_per_page( $this->post_id );
return $course_topics_per_page;
}
/**
* Get Post Setting.
*
* @since 2.5.0
*
* @param string $setting_key Setting key to return.
* @param string $setting_default_value Setting default value.
* @param bool $force Control reloading of setting.
*/
public function get_setting( $setting_key = '', $setting_default_value = null, $force = false ) {
if ( $this->load_settings() ) {
if ( ! empty( $setting_key ) ) {
switch ( $setting_key ) {
case 'course_lesson_orderby':
case 'orderby':
$setting_ordering = $this->get_settings_order();
if ( isset( $setting_ordering['orderby'] ) ) {
return $setting_ordering['orderby'];
} else {
return null;
}
break;
case 'course_lesson_order':
case 'order':
$setting_ordering = $this->get_settings_order();
if ( isset( $setting_ordering['order'] ) ) {
return $setting_ordering['order'];
} else {
return null;
}
break;
case 'course_lesson_per_page':
case 'per_page':
return $this->get_settings_lessons_per_page();
case 'course_topic_per_page':
return $this->get_settings_topics_per_page();
default:
return parent::get_setting( $setting_key, $setting_default_value = null, $force = false );
}
} else {
return $this->settings;
}
}
}
/**
* Get Course Steps.
*
* @since 2.5.0
*
* @param string $steps_type Steps type.
*/
public function get_steps( $steps_type = 'h' ) {
if ( ! empty( $this->post_id ) ) {
return learndash_course_get_steps_by_type( $this->post_id, $steps_type );
}
}
/**
* Get Course Steps Count.
*/
public function get_steps_count() {
if ( ! empty( $this->post_id ) ) {
learndash_course_get_steps_count( $this->post_id );
}
}
/**
* General function to check if user can view/read step post.
*
* @since 3.4.0
*
* @param integer $step_post_id Step Post ID.
*
* @return boolean True if user can view/read post.
*/
protected function can_user_read_step( $step_post_id = 0 ) {
$user_can_read_post = true;
if ( ( defined( 'LEARNDASH_COURSE_STEP_READ_CHECK' ) ) && ( true === LEARNDASH_COURSE_STEP_READ_CHECK ) ) {
if ( ! empty( $step_post_id ) ) {
if ( is_user_logged_in() ) {
if ( ! current_user_can( 'read_post', $step_post_id ) ) {
$step_post = get_post( $step_post_id );
if ( ( $step_post ) && ( is_a( $step_post, 'WP_Post' ) ) ) {
if ( ! in_array( $step_post->post_status, array( 'publish' ), true ) ) {
$user_can_read_post = false;
}
}
}
} else {
$step_post = get_post( $step_post_id );
if ( ( $step_post ) && ( is_a( $step_post, 'WP_Post' ) ) ) {
if ( ! in_array( $step_post->post_status, array( 'publish' ), true ) ) {
$user_can_read_post = false;
}
}
}
}
}
/**
* Filters user can view/read course step.
*
* @since 3.4.0
*
* @param boolean $user_can_read_post True if user can read step post.
* @param integer $step_post_id Step Post ID.
* @param integer $course_id Course ID.
*/
return apply_filters( 'learndash_can_user_read_step', $user_can_read_post, $step_post_id, $this->post_id );
}
/**
* Get Course Sections
*
* @since 3.4.0
*
* @param array $query_args Array of query args to filter sections.
*/
public function get_sections( $query_args = array() ) {
$query_args_defaults = array(
'paged' => 1,
'per_page' => -1,
'return_type' => 'ID',
);
$query_args = wp_parse_args( $query_args, $query_args_defaults );
$course_sections = $this->get_steps( 'sections' );
$pager_key = $this->post_id . ':sections';
$this->pager[ $pager_key ]['per_page'] = $query_args['per_page'];
$this->pager[ $pager_key ]['paged'] = $query_args['paged'];
$this->pager[ $pager_key ]['total_items'] = count( $course_sections );
$this->pager[ $pager_key ]['total_pages'] = 1;
if ( ! empty( $course_sections ) ) {
$this->pager[ $pager_key ]['total_items'] = count( $course_sections );
if ( $query_args['per_page'] > 0 ) {
$this->pager[ $pager_key ]['total_pages'] = ceil( $this->pager[ $pager_key ]['total_items'] / $query_args['per_page'] );
$course_sections = array_slice( $course_sections, ( $query_args['paged'] - 1 ) * $query_args['per_page'], $query_args['per_page'] );
}
foreach ( $course_sections as $section_idx => &$section ) {
if ( ( property_exists( $section, 'steps' ) ) && ( ! empty( $section->steps ) ) ) {
foreach ( $section->steps as $step_idx => $step_id ) {
if ( ! $this->can_user_read_step( $step_id ) ) {
unset( $section->steps[ $step_idx ] );
}
}
$section->steps = array_values( $section->steps );
}
}
}
return $course_sections;
}
/**
* Get Course Lessons
*
* @since 3.4.0
*
* @param array $query_args Array of query args to filter lessons.
*/
public function get_lessons( $query_args = array() ) {
$query_args_defaults = array(
'paged' => 1,
'per_page' => $this->get_setting( 'course_lesson_per_page' ),
'return_type' => 'WP_Post',
'nopaging' => false,
);
$query_args = wp_parse_args( $query_args, $query_args_defaults );
$lessons = learndash_course_get_children_of_step( $this->post_id, 0, learndash_get_post_type_slug( 'lesson' ), $query_args['return_type'] );
if ( ! empty( $lessons ) ) {
foreach ( $lessons as $lesson_id => $lesson_post ) {
if ( ! $this->can_user_read_step( $lesson_post->ID ) ) {
unset( $lessons[ $lesson_id ] );
}
}
}
$pager_key = $this->post_id . ':' . learndash_get_post_type_slug( 'lesson' );
$this->pager[ $pager_key ]['per_page'] = $query_args['per_page'];
$this->pager[ $pager_key ]['paged'] = $query_args['paged'];
$this->pager[ $pager_key ]['total_items'] = count( $lessons );
$this->pager[ $pager_key ]['total_pages'] = 1;
if ( ! empty( $lessons ) ) {
$this->pager[ $pager_key ]['total_items'] = count( $lessons );
if ( ( $query_args['per_page'] > 0 ) && ( false === $query_args['nopaging'] ) ) {
$this->pager[ $pager_key ]['total_pages'] = ceil( $this->pager[ $pager_key ]['total_items'] / $query_args['per_page'] );
$lessons = array_slice( $lessons, ( $query_args['paged'] - 1 ) * $query_args['per_page'], $query_args['per_page'] );
}
if ( 'ids' === $query_args['return_type'] ) {
$lessons = wp_list_pluck( $lessons, 'ID' );
}
}
return $lessons;
}
/**
* Get Course Lesson Topics
*
* @since 3.4.0
*
* @param integer $lesson_id Lesson ID parent.
* @param array $query_args Array of query args to filter lessons.
*/
public function get_topics( $lesson_id = 0, $query_args = array() ) {
$topics = array();
$lesson_id = absint( $lesson_id );
if ( empty( $lesson_id ) ) {
return $topics;
}
// check the user can read/view the parent lesson.
if ( ! $this->can_user_read_step( $lesson_id ) ) {
return $topics;
}
$query_args_defaults = array(
'paged' => 1,
'per_page' => -1,
'return_type' => 'WP_Post',
);
$query_args = wp_parse_args( $query_args, $query_args_defaults );
$topics = learndash_course_get_children_of_step( $this->post_id, $lesson_id, learndash_get_post_type_slug( 'topic' ), $query_args['return_type'] );
if ( ! empty( $topics ) ) {
foreach ( $topics as $topic_id => $topic_post ) {
if ( ! $this->can_user_read_step( $topic_post->ID ) ) {
unset( $topics[ $topic_id ] );
}
}
}
$pager_key = $lesson_id . ':' . learndash_get_post_type_slug( 'topic' );
$this->pager[ $pager_key ]['paged'] = $query_args['paged'];
$this->pager[ $pager_key ]['total_items'] = count( $topics );
$this->pager[ $pager_key ]['total_pages'] = 1;
if ( ! empty( $topics ) ) {
if ( $query_args['per_page'] > 0 ) {
$this->pager[ $pager_key ]['total_pages'] = ceil( $this->pager[ $pager_key ]['total_items'] / $query_args['per_page'] );
$topics = array_slice( $topics, ( $query_args['paged'] - 1 ) * $query_args['per_page'], $query_args['per_page'] );
}
if ( 'ids' === $query_args['return_type'] ) {
$topics = wp_list_pluck( $topics, 'ID' );
}
}
return $topics;
}
/**
* Get Quizzes
*
* @since 3.4.0
*
* @param integer $parent_id Course/Lesson/Topic ID parent.
* @param array $query_args Array of query args to filter quizzes.
*/
public function get_quizzes( $parent_id = 0, $query_args = array() ) {
$quizzes = array();
$parent_id = absint( $parent_id );
if ( empty( $parent_id ) ) {
return $quizzes;
}
/**
* Check if the user can access the parent steps.
*/
$parent_steps = learndash_course_get_all_parent_step_ids( $this->post_id, $parent_id );
if ( ! empty( $parent_steps ) ) {
foreach ( $parent_steps as $parent_step_post_id ) {
$parent_step_post_id = absint( $parent_step_post_id );
if ( ! empty( $parent_step_post_id ) ) {
if ( ! $this->can_user_read_step( $parent_step_post_id ) ) {
return $quizzes;
}
}
}
}
$query_args_defaults = array(
'paged' => 1,
'per_page' => -1,
'return_type' => 'WP_Post',
);
$query_args = wp_parse_args( $query_args, $query_args_defaults );
$quizzes = learndash_course_get_children_of_step( $this->post_id, $parent_id, learndash_get_post_type_slug( 'quiz' ), $query_args['return_type'] );
if ( ! empty( $quizzes ) ) {
foreach ( $quizzes as $quiz_id => $quiz_post ) {
if ( ! $this->can_user_read_step( $quiz_post->ID ) ) {
unset( $quizzes[ $quiz_id ] );
}
}
}
$pager_key = $parent_id . ':' . get_post_type( $parent_id );
$this->pager[ $pager_key ]['paged'] = $query_args['paged'];
$this->pager[ $pager_key ]['total_items'] = count( $quizzes );
$this->pager[ $pager_key ]['total_pages'] = 1;
if ( ! empty( $quizzes ) ) {
if ( $query_args['per_page'] > 0 ) {
$this->pager[ $pager_key ]['total_pages'] = ceil( $this->pager[ $pager_key ]['total_items'] / $query_args['per_page'] );
$quizzes = array_slice( $quizzes, ( $query_args['paged'] - 1 ) * $query_args['per_page'], $query_args['per_page'] );
}
if ( 'ids' === $query_args['return_type'] ) {
$quizzes = wp_list_pluck( $quizzes, 'ID' );
}
}
return $quizzes;
}
/**
* Get Course Pager.
*
* @since 3.4.0
*
* @param int $parent_id Parent ID. This may be the Course, Lesson, Topic or Quiz.
* @param string $post_type Post Type of Parent ID.
*/
public function get_pager( $parent_id = 0, $post_type = '' ) {
$pager = array();
$parent_id = absint( $parent_id );
$post_type = esc_attr( $post_type );
if ( ( ! empty( $parent_id ) ) && ( ! empty( $post_type ) ) ) {
$pager_key = $parent_id . ':' . $post_type;
if ( isset( $this->pager[ $pager_key ] ) ) {
$pager = $this->pager[ $pager_key ];
}
}
return $pager;
}
// End of functions.
}
}