LLMS_REST_Lessons_Controller::prepare_object_for_response( LLMS_Lesson $lesson, WP_REST_Request $request )

Prepare a single object output for response.

Contents

Parameters Parameters

$lesson

(LLMS_Lesson) (Required) Lesson object.

$request

(WP_REST_Request) (Required) Full details about the request.

Top ↑

Return Return

(array)

Top ↑

Source Source

File: libraries/lifterlms-rest/includes/server/class-llms-rest-lessons-controller.php

527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
*                      public, points, quiz, drip_method, drip_days, drip_date, prerequisite, audio_embed, video_embed.
 *                      Added `llms_rest_prepare_lesson_object_response` filter hook.
 *
 * @param LLMS_Lesson     $lesson  Lesson object.
 * @param WP_REST_Request $request Full details about the request.
 * @return array
 */
protected function prepare_object_for_response( $lesson, $request ) {
 
    $data = parent::prepare_object_for_response( $lesson, $request );
 
    // Audio Embed.
    $data['audio_embed'] = $lesson->get( 'audio_embed' );
 
    // Video Embed.
    $data['video_embed'] = $lesson->get( 'video_embed' );
 
    // Parent section.
    $data['parent_id'] = $lesson->get_parent_section();
 
    // Parent course.
    $data['course_id'] = $lesson->get( 'parent_course' );
 
    // Order.
    $data['order'] = $lesson->get( 'order' );
 
    // Public.
    $data['public'] = $lesson->is_free();
 
    // Points.
    $data['points'] = $lesson->get( 'points' );
 
    // Quiz.
    $data['quiz']['enabled']     = llms_parse_bool( $lesson->get( 'quiz_enabled' ) );
    $data['quiz']['id']          = absint( $lesson->get( 'quiz' ) );
    $data['quiz']['progression'] = llms_parse_bool( $lesson->get( 'require_passing_grade' ) ) ? 'pass' : 'completed';
 
    // Drip method.
    $data['drip_method'] = $lesson->get( 'drip_method' );
    $data['drip_method'] = $data['drip_method'] ? $data['drip_method'] : 'none';
 
    // Drip days.
    $data['drip_days'] = absint( $lesson->get( 'days_before_available' ) );
 
    // Drip date.
    $date = $lesson->get( 'date_available' );
    if ( $date ) {
        $time = $lesson->get( 'time_available' );
 
        if ( ! $time ) {
            $time = '12:00 AM';
        }
 
        $drip_date = date_i18n( 'Y-m-d H:i:s', strtotime( $date . ' ' . $time ) );
    } else {
        $drip_date = '';
    }
 
    $data['drip_date'] = $drip_date;
 
    // Prerequisite.
    $data['prerequisite'] = absint( $lesson->get_prerequisite() );
 
    /**
     * Filters the lesson data for a response.
     *
     * @since 1.0.0-beta.7
     *

Expand full source code Collapse full source code View on GitHub

Top ↑

Top ↑

Changelog Changelog

Changelog
Version Description
1.0.0-beta.7 Added following properties to the response object: public, points, quiz, drip_method, drip_days, drip_date, prerequisite, audio_embed, video_embed. Added llms_rest_prepare_lesson_object_response filter hook.
1.0.0-beta.23 Replaced the call to the deprecated LLMS_Lesson::get_parent_course() method with LLMS_Lesson::get( 'parent_course' ).
1.0.0-beta.1 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.