LLMS_Processor_Course_Data::dispatch_calc( int $course_id )

Action triggered to queue queries needed to make the calculation

Contents

Parameters Parameters

$course_id

(int) (Required) WP Post ID of the course.

Top ↑

Return Return

(void|null)

Top ↑

Source Source

File: includes/processors/class.llms.processor.course.data.php

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
public function dispatch_calc( $course_id ) {
 
    $this->log( sprintf( 'Course data calculation dispatched for course %d.', $course_id ) );
 
    // Make sure we have a course.
    $course = llms_get_post( $course_id );
    if ( ! $course instanceof LLMS_Course ) {
        return null;
    }
 
    // Return early if we're already processing data for the given course.
    if ( $this->is_already_processing_course( $course_id ) ) {
        return $this->dispatch_calc_throttled( $course_id );
    }
 
    // Retrieve args.
    $args = $this->get_student_query_args( $course_id );
 
    // Get total number of pages.
    $query = new LLMS_Student_Query( $args );
 
    // No students in the course, run task completion.
    if ( ! $query->get_found_results() ) {
        return $this->task_complete( $course, $this->get_task_data(), true );
    }
 
    // Store the total number of students right away.
    $course->set( 'enrolled_students', $query->get_found_results() );
 
    // Throttle processing.
    if ( $this->maybe_throttle( $query->get_found_results(), $course_id ) ) {
        return $this->dispatch_calc_throttled( $course_id );
    }
 
    // Add each page to the queue.
    while ( $args['page'] <= $query->get_max_pages() ) {
        $this->push_to_queue( $args );
        $args['page']++;
    }
 
    // Save queue and dispatch the process.
    $this->save()->dispatch();
 
}

Expand full source code Collapse full source code View on GitHub

Top ↑

Uses Uses

Uses
Uses Description
includes/processors/class.llms.processor.course.data.php: LLMS_Processor_Course_Data::get_task_data()

Retrieve structured task data array.
includes/processors/class.llms.processor.course.data.php: LLMS_Processor_Course_Data::task_complete()

Complete a task
includes/processors/class.llms.processor.course.data.php: LLMS_Processor_Course_Data::is_already_processing_course()

Determines if the supplied course is already being processed.
includes/processors/class.llms.processor.course.data.php: LLMS_Processor_Course_Data::dispatch_calc_throttled()

Schedule data calculation for the future
includes/processors/class.llms.processor.course.data.php: LLMS_Processor_Course_Data::get_student_query_args()

Retrieve arguments used to perform an LLMS_Student_Query for background data processing
includes/processors/class.llms.processor.course.data.php: LLMS_Processor_Course_Data::maybe_throttle()

For large courses, only recalculate once every 4 hours
includes/llms.functions.core.php: llms_get_post()

Retrieve the LLMS Post Model for a give post by ID or WP_Post Object
Show 2 more uses Hide more uses

Top ↑

Changelog Changelog

Changelog
Version Description
6.0.0 Don't access LLMS_Student_Query properties directly.
4.21.0 When there's no students found in the course, run the task_complete() method to ensure data from a previous calculation is cleared.
4.12.0 Add throttling by course in progress and adjust last_run calculation to be specific to the course. Improve performance of the student query by removing unneeded sort columns.
3.15.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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