LLMS_Course_Data
Query data about a course
Source Source
File: includes/class.llms.course.data.php
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 | class LLMS_Course_Data extends LLMS_Abstract_Post_Data { /** * Constructor * * @since 3.15.0 * * @param int $course_id WP Post ID of the course */ public function __construct( $course_id ) { $this->course_id = $course_id; $this->course = llms_get_post( $this->course_id ); parent::__construct( $course_id ); } /** * Retrieve an array of all post ids in the course * * Includes course id, all section ids, all lesson ids, and all quiz ids. * * @since 3.15.0 * @since 3.31.0 Use $this->post_id instead of deprecated $this->course_id. * * @return array */ private function get_all_ids() { return array_merge( array( $this->post_id ), $this->post->get_sections( 'ids' ), $this->post->get_lessons( 'ids' ), $this->post->get_quizzes() ); } /** * Retrieve # of course completions within the period * * @since 3.15.0 * @since 3.31.0 Use $this->post_id instead of deprecated $this->course_id. * * @param string $period Optional. Date period [current|previous]. Default is 'current'. * @return int */ public function get_completions( $period = 'current' ) { global $wpdb; return $wpdb->get_var( $wpdb->prepare( " SELECT DISTINCT COUNT( user_id ) FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_value = 'yes' AND meta_key = '_is_complete' AND post_id = %d AND updated_date BETWEEN %s AND %s ", $this->post_id, $this->get_date( $period, 'start' ), $this->get_date( $period, 'end' ) ) );// db call ok; no-cache ok. } /** * Retrieve # of course enrollments within the period * * @since 3.15.0 * @since 3.31.0 Use $this->post_id instead of deprecated $this->course_id. * * @param string $period Optional. Date period [current|previous]. Default is 'current'. * @return int */ public function get_enrollments( $period = 'current' ) { global $wpdb; return $wpdb->get_var( $wpdb->prepare( " SELECT DISTINCT COUNT( user_id ) FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_value = 'yes' AND meta_key = '_start_date' AND post_id = %d AND updated_date BETWEEN %s AND %s ", $this->post_id, $this->get_date( $period, 'start' ), $this->get_date( $period, 'end' ) ) );// db call ok; no-cache ok. } /** * Retrieve # of engagements related to the course awarded within the period * * @since 3.15.0 * * @param string $type Engagement type [email|certificate|achievement]. * @param string $period Optional. Date period [current|previous]. Default is 'current'. * @return int */ public function get_engagements( $type, $period = 'current' ) { global $wpdb; $ids = implode( ',', $this->get_all_ids() ); // phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared return $wpdb->get_var( $wpdb->prepare( " SELECT DISTINCT COUNT( user_id ) FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_key = %s AND post_id IN ( {$ids} ) AND updated_date BETWEEN %s AND %s ", '_' . $type, $this->get_date( $period, 'start' ), $this->get_date( $period, 'end' ) ) );// db call ok; no-cache ok. // phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared } /** * Retrieves and returns the number of lessons completed within the period. * * @since 3.15.0 * @since 5.10.0 Fixed issue when the course has no lessons. * * @param string $period Optional. Date period [current|previous]. Default is 'current'. * @return int */ public function get_lesson_completions( $period = 'current' ) { global $wpdb; $lessons = implode( ',', $this->post->get_lessons( 'ids' ) ); // phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared // Return early for courses without any lessons. if ( empty( $lessons ) ) { return 0; } return $wpdb->get_var( $wpdb->prepare( " SELECT COUNT( * ) FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_value = 'yes' AND meta_key = '_is_complete' AND post_id IN ( {$lessons} ) AND updated_date BETWEEN %s AND %s ", $this->get_date( $period, 'start' ), $this->get_date( $period, 'end' ) ) );// db call ok; no-cache ok. // phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared } /** * Retrieve # of orders placed for the course within the period * * @since 3.15.0 * @since 4.21.0 Fixed order params passed to the `$this->orders_query()` method. * * @param string $period Optional. Date period [current|previous]. Default is 'current'. * @return int */ public function get_orders( $period = 'current' ) { $query = $this->orders_query( 1, array( array( 'after' => $this->get_date( $period, 'start' ), 'before' => $this->get_date( $period, 'end' ), 'inclusive' => true, ), ) ); return $query->found_posts; } /** * Retrieve total amount of transactions related to orders for the course completed within the period * * @since 3.15.0 * * @param string $period Date period [current|previous]. * @return float */ public function get_revenue( $period ) { $query = $this->orders_query( -1 ); $order_ids = wp_list_pluck( $query->posts, 'ID' ); $revenue = 0; if ( $order_ids ) { $order_ids = implode( ',', $order_ids ); global $wpdb; // phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared $revenue = $wpdb->get_var( $wpdb->prepare( "SELECT SUM( m2.meta_value ) FROM $wpdb->posts AS p LEFT JOIN $wpdb->postmeta AS m1 ON m1.post_id = p.ID AND m1.meta_key = '_llms_order_id' -- join for the ID LEFT JOIN $wpdb->postmeta AS m2 ON m2.post_id = p.ID AND m2.meta_key = '_llms_amount'-- get the actual amounts WHERE p.post_type = 'llms_transaction' AND p.post_status = 'llms-txn-succeeded' AND m1.meta_value IN ({$order_ids}) AND p.post_modified BETWEEN %s AND %s ;", $this->get_date( $period, 'start' ), $this->get_date( $period, 'end' ) ) );// db call ok; no-cache ok. // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared if ( is_null( $revenue ) ) { $revenue = 0; } } return apply_filters( 'llms_course_data_get_revenue', $revenue, $period, $this ); } /** * Retrieve the number of unenrollments on a given date. * * @since 3.15.0 * * @param tring $period Optional. Date period [current|previous]. Default 'current'. * @return int */ public function get_unenrollments( $period = 'current' ) { global $wpdb; return $wpdb->get_var( $wpdb->prepare( " SELECT DISTINCT COUNT( user_id ) FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_value != 'enrolled' AND meta_key = '_status' AND post_id = %d AND updated_date BETWEEN %s AND %s ", $this->post_id, $this->get_date( $period, 'start' ), $this->get_date( $period, 'end' ) ) );// db call ok; no-cache ok. } /** * Execute a WP Query to retrieve orders within the given date range * * @since 3.15.0 * @since 4.21.0 Fixed the post status for completed orders. * * @param int $num_orders Optional. Number of orders to retrieve. Default is `1`. * @param array $dates Optional. Date range (passed to WP_Query['date_query']). Default is empty array. * @return WP_Query */ private function orders_query( $num_orders = 1, $dates = array() ) { $args = array( 'post_type' => 'llms_order', 'post_status' => array( 'llms-active', 'llms-completed' ), 'posts_per_page' => $num_orders, 'meta_key' => '_llms_product_id', 'meta_value' => $this->post_id, ); if ( ! empty( $dates ) ) { $args['date_query'] = $dates; } return new WP_Query( $args ); }} |
Expand full source code Collapse full source code View on GitHub
Methods Methods
- __construct — Constructor
- get_all_ids — Retrieve an array of all post ids in the course
- get_completions — Retrieve # of course completions within the period
- get_date — Retrieve a start or end date based on the period
- get_engagements — Retrieve # of engagements related to the course awarded within the period
- get_enrollments — Retrieve # of course enrollments within the period
- get_lesson_completions — Retrieves and returns the number of lessons completed within the period.
- get_orders — Retrieve # of orders placed for the course within the period
- get_revenue — Retrieve total amount of transactions related to orders for the course completed within the period
- get_unenrollments — Retrieve the number of unenrollments on a given date.
- orders_query — Execute a WP Query to retrieve orders within the given date range
- recent_events — Retrieve recent LLMS_User_Postmeta for the course
- set_period — Set the dates pased on a date range period
- strtotime — Allow dates and timestamps to be passed into various data functions
Changelog Changelog
| Version | Description |
|---|---|
| 4.0.0 | Remove previously deprecated class properties $course and $course_id. |
| 3.31.0 | Extends LLMS_Abstract_Post_Data. |
| 3.30.3 | Explicitly define class properties. |
| 3.15.0 | Introduced. |