<?php
/**
* Learndash Reports functions
*
* @since 2.3.0
*
* @package LearnDash\Reports
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Gets the list of user data.
*
* This function is a wrapper to the `WP_User_Query` function provided by WordPress.
*
* @since 2.3.0
*
* @param array $query_args Optional. The `WP_User_query` arguments. Default empty array.
*
* @return array An array of user query results.
*/
function learndash_get_users_query( $query_args = array() ) {
$default_args = array(
'fields' => 'ID',
);
$query_args = wp_parse_args( $query_args, $default_args );
/**
* Filters the query arguments for getting users.
*
* @param array $query_args An array of user query arguments.
*/
$query_args = apply_filters( 'learndash_get_users_query_args', $query_args );
if ( ! empty( $query_args ) ) {
$user_query = new WP_User_Query( $query_args );
return $user_query->get_results();
}
return array();
}
/**
* Gets the list of user IDs for the report.
*
* This function will determine the list of users the current user can see. For example for
* group leader, it will show the only user within the leader's groups. For admin, it will
* show all users.
*
* @since 2.3.0
*
* @param int $user_id Optional. User ID. Defaults to the current user ID. Default 0.
* @param array $query_args Optional. User query arguments. Default empty array.
*
* @return array An array of user IDs.
*/
function learndash_get_report_user_ids( $user_id = 0, $query_args = array() ) {
if ( empty( $user_id ) ) {
// If the current user is not able to be determined. Then abort.
if ( ! is_user_logged_in() ) {
return;
}
$user_id = get_current_user_id();
}
$default_args = array(
'fields' => 'ID',
'orderby' => 'display_name',
'order' => 'ASC',
);
$query_args = wp_parse_args( $query_args, $default_args );
if ( learndash_is_admin_user( $user_id ) ) {
if ( LearnDash_Settings_Section::get_section_setting( 'LearnDash_Settings_Section_General_Admin_User', 'reports_include_admin_users' ) != 'yes' ) {
$query_args['role__not_in'] = 'administrator';
}
} elseif ( learndash_is_group_leader_user( $user_id ) ) {
$include_user_ids = learndash_get_group_leader_groups_users( $user_id );
// Even though we have the users ids from the learndash_get_group_leader_groups_users() we need to validate them
// by running them against the WP_User_Query.
if ( ! empty( $include_user_ids ) ) {
$query_args['include'] = $include_user_ids;
}
} else {
$query_args['include'] = array( $user_id );
}
/**
* Filters the query arguments for getting users for the report.
*
* @param array $query_args Query arguments.
*/
$query_args = apply_filters( 'learndash_get_report_users_query_args', $query_args );
$report_user_ids = learndash_get_users_query( $query_args );
/**
* Filters list of get report user ids.
*
* @param array|null $report_user_ids An array of report user ids.
*/
return apply_filters( 'learndash_get_report_user_ids', $report_user_ids );
}
/**
* Gets the count of active/published courses.
*
* @since 2.3.0
*
* @param array $query_args Optional. The query arguments to get the course count. Default empty array.
* @param string $return_field Optional. The `WP_Query` field to return. Default 'found_posts'.
*
* @return mixed Returns the `WP_Query` object if the return_field is empty
* otherwise the specified `WP_Query` return field.
*/
function learndash_get_courses_count( $query_args = array(), $return_field = 'found_posts' ) {
$return = 0;
$default_args = array(
'post_type' => 'sfwd-courses',
'post_status' => 'publish',
'fields' => 'ids',
);
$query_args = wp_parse_args( $query_args, $default_args );
/**
* Filters courses count query arguments.
*
* @param array $query_args An array of course count query arguments.
*/
$query_args = apply_filters( 'learndash_courses_count_args', $query_args );
if ( 'found_posts' == $return_field ) {
$query_args['posts_per_page'] = 1;
$query_args['paged'] = 1;
}
if ( ( is_array( $query_args ) ) && ( ! empty( $query_args ) ) ) {
$query = new WP_Query( $query_args );
if ( $query instanceof WP_Query ) {
if ( ( ! empty( $return_field ) ) && ( property_exists( $query, $return_field ) ) ) {
$return = $query->$return_field;
} else {
$return = $query;
}
}
}
return $return;
}
/**
* Gets the count of pending sfwd-assignment posts.
*
* @since 2.3.0
*
* @param array $query_args Optional. The query arguments to get the pending assignments count. Default empty array.
* @param string $return_field Optional. The `WP_Query` field to return. Default 'found_posts'.
*
* @return mixed Returns the `WP_Query` object if the return_field is empty
* otherwise the specified `WP_Query` return field.
*/
function learndash_get_assignments_pending_count( $query_args = array(), $return_field = 'found_posts' ) {
$return = 0;
$default_args = array(
'post_type' => 'sfwd-assignment',
'post_status' => 'publish',
'fields' => 'ids',
'meta_query' => array(
array(
'key' => 'approval_status',
'compare' => 'NOT EXISTS',
),
),
);
// added logic for non-admin user like group leaders who will only see a sub-set of assignments.
$user_id = get_current_user_id();
if ( learndash_is_group_leader_user( $user_id ) ) {
$group_ids = learndash_get_administrators_group_ids( $user_id );
$user_ids = array();
$course_ids = array();
if ( ! empty( $group_ids ) && is_array( $group_ids ) ) {
foreach ( $group_ids as $group_id ) {
$group_users = learndash_get_groups_user_ids( $group_id );
if ( ! empty( $group_users ) && is_array( $group_users ) ) {
foreach ( $group_users as $group_user_id ) {
$user_ids[ $group_user_id ] = $group_user_id;
}
}
$group_course_ids = learndash_group_enrolled_courses( $group_id );
if ( ( ! empty( $group_course_ids ) ) && ( is_array( $group_course_ids ) ) ) {
$course_ids = array_merge( $course_ids, $group_course_ids );
}
}
} else {
return $return;
}
if ( ! empty( $course_ids ) && count( $course_ids ) ) {
$default_args['meta_query'][] = array(
'key' => 'course_id',
'value' => $course_ids,
'compare' => 'IN',
);
} else {
return $return;
}
if ( ! empty( $user_ids ) && count( $user_ids ) ) {
$default_args['author__in'] = $user_ids;
} else {
return $return;
}
}
$query_args = wp_parse_args( $query_args, $default_args );
/**
* Filters pending assignments count query arguments.
*
* @param array $query_args An array of pending assignment count query arguments.
*/
$query_args = apply_filters( 'learndash_get_assignments_pending_count_query_args', $query_args );
if ( 'found_posts' == $return_field ) {
$query_args['posts_per_page'] = 1;
$query_args['paged'] = 1;
}
if ( ( is_array( $query_args ) ) && ( ! empty( $query_args ) ) ) {
$query = new WP_Query( $query_args );
if ( ( ! empty( $return_field ) ) && ( property_exists( $query, $return_field ) ) ) {
$return = $query->$return_field;
} else {
$return = $query;
}
}
return $return;
}
/**
* Gets the link to admin assignments(sfwd-assignment) posts listing.
*
* @param array $link_args Optional. The query arguments to get the link. Default empty array.
*
* @since 2.3.0
*
* @return string The URL to assignment admin page with filters.
*/
function learndash_admin_get_assignments_listing_link( $link_args = array() ) {
$default_args = array(
'post_type' => 'sfwd-assignment',
'post_status' => 'all',
);
$link_args = wp_parse_args( $link_args, $default_args );
// Just in case someone tried to insert action/actions triggers. Remove them.
if ( isset( $link_args['action'] ) ) {
unset( $link_args['action'] );
}
if ( isset( $link_args['action2'] ) ) {
unset( $link_args['action2'] );
}
// Then remove any empty items. Less URL space.
foreach ( $link_args as $l_key => $l_val ) {
if ( '' == $l_val ) {
unset( $link_args[ $l_key ] );
}
}
if ( ! empty( $link_args ) ) {
return add_query_arg( $link_args, admin_url( 'edit.php' ) );
}
return '';
}
/**
* Gets the link to admin pending assignments(sfwd-assignment) posts listing.
*
* @since 2.3.0
*
* @return string The URL to pending assignments admin page with filters.
*/
function learndash_admin_get_assignments_pending_listing_link() {
return learndash_admin_get_assignments_listing_link( 'approval_status=0' );
}
/**
* Gets the count of pending Essays(sfwd-essays) posts.
*
* @since 2.3.0
*
* @param array $query_args Optional. The query arguments to get the pending essays count. Default empty array.
* @param string $return_field Optional. The `WP_Query` field to return. Default 'found_posts'.
*
* @return mixed Returns the `WP_Query` object if the return_field is empty
* otherwise the specified `WP_Query` return field.
*/
function learndash_get_essays_pending_count( $query_args = array(), $return_field = 'found_posts' ) {
$return = 0;
$default_args = array(
'post_type' => 'sfwd-essays',
'post_status' => 'not_graded',
'fields' => 'ids',
);
// added logic for non-admin user like group leaders who will only see a sub-set of assignments.
$user_id = get_current_user_id();
if ( learndash_is_group_leader_user( $user_id ) ) {
$group_ids = learndash_get_administrators_group_ids( $user_id );
$user_ids = array();
$course_ids = array();
if ( ! empty( $group_ids ) && is_array( $group_ids ) ) {
foreach ( $group_ids as $group_id ) {
$group_users = learndash_get_groups_user_ids( $group_id );
if ( ! empty( $group_users ) && is_array( $group_users ) ) {
foreach ( $group_users as $group_user_id ) {
$user_ids[ $group_user_id ] = $group_user_id;
}
}
$group_course_ids = learndash_group_enrolled_courses( $group_id );
if ( ( ! empty( $group_course_ids ) ) && ( is_array( $group_course_ids ) ) ) {
$course_ids = array_merge( $course_ids, $group_course_ids );
}
}
} else {
return $return;
}
if ( ! empty( $course_ids ) && count( $course_ids ) ) {
$default_args['meta_query'][] = array(
'key' => 'course_id',
'value' => $course_ids,
'compare' => 'IN',
);
} else {
return $return;
}
if ( ! empty( $user_ids ) && count( $user_ids ) ) {
$default_args['author__in'] = $user_ids;
} else {
return $return;
}
}
$query_args = wp_parse_args( $query_args, $default_args );
/**
* Filters pending essays count query arguments.
*
* @param array $query_args An array of pending essays count query arguments.
*/
$query_args = apply_filters( 'learndash_get_essays_pending_count_query_args', $query_args );
if ( 'found_posts' == $return_field ) {
$query_args['posts_per_page'] = 1;
$query_args['paged'] = 1;
}
if ( ( is_array( $query_args ) ) && ( ! empty( $query_args ) ) ) {
$query = new WP_Query( $query_args );
if ( ( ! empty( $return_field ) ) && ( property_exists( $query, $return_field ) ) ) {
$return = $query->$return_field;
} else {
$return = $query;
}
}
return $return;
}
/**
* Gets the link to admin Essays(sfwd-essays) posts listing.
*
* @param array $link_args An array of arguments to override or supplement query string. Default empty array.
*
* @since 2.3.0
*
* @return string The URL to essays admin page with filters.
*/
function learndash_admin_get_essays_listing_link( $link_args = array() ) {
$default_args = array(
'post_type' => 'sfwd-essays',
'post_status' => 'all',
);
$link_args = wp_parse_args( $link_args, $default_args );
// Just in case someone tried to insert action/actions triggers. Remove them.
if ( isset( $link_args['action'] ) ) {
unset( $link_args['action'] );
}
if ( isset( $link_args['action2'] ) ) {
unset( $link_args['action2'] );
}
// Then remove any empty items. Less URL space.
foreach ( $link_args as $l_key => $l_val ) {
if ( '' == $l_val ) {
unset( $link_args[ $l_key ] );
}
}
if ( ! empty( $link_args ) ) {
return add_query_arg( $link_args, admin_url( 'edit.php' ) );
}
return '';
}
/**
* Gets the link to admin pending Essays(sfwd-essays) posts listing.
*
* @since 2.3.0
*
* @return string The URL to essays admin page with filters.
*/
function learndash_admin_get_essays_pending_listing_link() {
return learndash_admin_get_essays_listing_link( 'post_status=not_graded' );
}
/**
* Gets the count of users in the system.
*
* This will automatically exclude the count of the 'administrator' role.
*
* @since 2.3.0
*
* @param array $user_query_args Optional. The `WP_User_Query` query arguments. Default empty array.
*
* @return int The count of users excluding admins.
*/
function learndash_students_enrolled_count( $user_query_args = array() ) {
$return_total_users = 0;
$default_args = array(
'role__not_in' => 'Administrator',
'count_total' => true,
'fields' => 'ID',
);
/**
* Filters students enrolled count query arguments.
*
* @param array $query_args An array of students enrolled count query arguments.
*/
$user_query_args = apply_filters(
'learndash_students_enrolled_count_qrgs', // cspell:disable-line.
wp_parse_args( $user_query_args, $default_args )
);
if ( ! empty( $user_query_args ) ) {
$user_query = new WP_User_Query( $user_query_args );
$return_total_users = $user_query->get_total();
}
return $return_total_users;
}
/**
* Returns the list of user IDs managed by the group leader.
*
* @since 2.1.0
*
* @param int $user_id The group leader user ID. Default current user ID.
* @param boolean $by_group If true, returns the user IDs by group. Default false.
* @param boolean $totals_only Whether to return only the count of users. Default false.
*
* @return int|array<int, int[]>|int[] It depends on the $by_group and $totals_only parameters.
* If $by_group is true, it returns an array of user IDs/count by group.
* If $totals_only is true, it returns the count of users.
* Otherwise, it returns an array of user IDs.
*
* @phpstan-return ($totals_only is true ? int : ($by_group is true ? array<int, array<int>> : array<int>))
*/
function learndash_get_group_leader_groups_users( $user_id = 0, $by_group = false, $totals_only = false ) {
if ( false == $by_group ) {
if ( true == $totals_only ) {
$user_ids = 0;
} else {
$user_ids = array();
}
} elseif ( true == $totals_only ) {
$user_ids = array();
} else {
$user_ids = 0;
}
if ( empty( $user_id ) ) {
// If the current user is not able to be determined. Then abort.
if ( ! is_user_logged_in() ) {
return;
}
$user_id = get_current_user_id();
}
if ( learndash_is_group_leader_user( $user_id ) ) {
$group_ids = learndash_get_administrators_group_ids( $user_id );
if ( ! empty( $group_ids ) ) {
foreach ( $group_ids as $group_id ) {
$group_user_ids = learndash_get_groups_user_ids( $group_id );
if ( true == $by_group ) {
if ( true == $totals_only ) {
$user_ids[ $group_id ] = count( $group_user_ids );
} else {
$user_ids[ $group_id ] = $group_user_ids;
}
} elseif ( true == $totals_only ) {
$user_ids += count( $group_user_ids );
} else {
$user_ids = array_merge( $user_ids, $group_user_ids );
}
}
}
}
if ( ! empty( $user_ids ) ) {
if ( false == $by_group ) {
$user_ids = array_unique( $user_ids );
}
}
return $user_ids;
}
/**
* Gets the list or count of group courses for a group leader.
*
* @param int $group_leader_user_id Optional. Group leader user ID. Defaults to the current user ID. Default 0.
* @param boolean $by_group Optional. Whether to get user IDs or count sorted by group. Default false.
* @param boolean $totals_only Optional. Whether to get the only count of courses. Default false.
*
* @return int|array An array of user IDs or user count.
*/
function learndash_get_group_leader_groups_courses( $group_leader_user_id = 0, $by_group = false, $totals_only = false ) {
if ( false == $by_group ) {
if ( true == $totals_only ) {
$course_ids = 0;
} else {
$course_ids = array();
}
} elseif ( true == $totals_only ) {
$course_ids = array();
} else {
$course_ids = 0;
}
if ( empty( $group_leader_user_id ) ) {
$group_leader_user_id = get_current_user_id();
}
if ( learndash_is_group_leader_user( $group_leader_user_id ) ) {
$group_ids = learndash_get_administrators_group_ids( $group_leader_user_id );
if ( ! empty( $group_ids ) ) {
foreach ( $group_ids as $group_id ) {
$group_course_ids = learndash_group_enrolled_courses( $group_id );
if ( true == $by_group ) {
if ( true == $totals_only ) {
$course_ids[ $group_id ] = count( $group_course_ids );
} else {
$course_ids[ $group_id ] = $group_course_ids;
}
} elseif ( true == $totals_only ) {
$course_ids += count( $group_course_ids );
} else {
$course_ids = array_merge( $course_ids, $group_course_ids );
}
}
}
}
if ( ! empty( $course_ids ) ) {
if ( false == $by_group ) {
$course_ids = array_unique( $course_ids );
}
}
return $course_ids;}
/**
* Queries the user activity for the report.
*
* This function will query the new learndash_course_user_activity table for user/course Activity.
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global array $learndash_post_types An array of learndash post types.
*
* @since 2.3.0
*
* @param array $query_args Optional. The query arguments to get user activity. Default empty array.
* @param int $current_user_id Optional. The user to run the query as. Defaults to the current user. Default 0.
*
* @return array Returns user activity query results.
*/
function learndash_reports_get_activity( $query_args = array(), $current_user_id = 0 ) {
global $wpdb, $learndash_post_types;
$activity_results = array();
$activity_status_has_null = false;
$defaults = array(
// array or comma lst of group ids to use in query. Default is all groups.
'group_ids' => '',
// array or comma list of course.
'course_ids' => '',
'course_ids_action' => 'IN',
// array or comma list of course, lesson, topic, etc. Default is all posts.
'post_ids' => '',
'post_ids_action' => 'IN',
// array or comma list of LD specific post types. See $learndash_post_types for possible values.
'post_types' => '',
// array or comma list of post statuses. See $learndash_post_types for possible values.
'post_status' => '',
// array or comma list of user ids. Defaults to all user ids.
'user_ids' => '',
'user_ids_action' => 'IN',
// An array of activity_type values to filter. Default is all types.
'activity_types' => '',
// An array of activity_status values to filter. Possible values 'NOT_STARTED' , 'IN_PROGRESS', 'COMPLETED'.
// This field is converted into a boolean value later (line 796).
'activity_status' => '',
// controls number of items to return for request. Pass 0 for ALL items.
'per_page' => 10,
// Used in combination with 'per_page' to set the page set of items to return.
'paged' => 1,
// order by fields AND order (DESC, ASC) combined to allow multiple fields and directions.
'orderby_order' => 'GREATEST(ld_user_activity.activity_started, ld_user_activity.activity_completed) DESC',
// Search value. See 'search_context' for specifying search fields.
's' => '',
// Limit search to 'post_title' OR 'display_name'. If empty will include both.
's_context' => '',
// start and/or end time filtering. Should be date format strings 'YYYY-MM-DD HH:mm:ss' or 'YYYY-MM-DD'.
'time_start' => 0,
'time_end' => 0,
// Indicators to tell the logic if the values passed via 'time_start' and 'time_end' are GMT or local (timezone offset).
'time_start_is_gmt' => false,
'time_end_is_gmt' => false,
// date values returned from the query will be a gmt timestamp int. If the 'date_format' value is provided
// a new field will be include 'activity_date_time_formatted' using the format specifiers provided in this field.
/** This filter is documented in includes/ld-misc-functions.php */
'date_format' => apply_filters( 'learndash_date_time_formats', get_option( 'date_format' ) . ' ' . get_option( 'time_format' ) ),
'include_meta' => true,
'meta_fields' => array(),
// controls if the queries are actually executed. You can pass in true or 1 to have the logic tested without running the actual query.
'dry_run' => 0,
// Suppress ALL filters. This include both the query_args and query_str filters.
'suppress_filters_all' => 0,
// If the 'suppress_filters_all' is NOT set you can set this to control just filters for the final query_args.
'suppress_filters_query_args' => 0,
// If the 'suppress_filters_all' is NOT set you can set this to control just filters for the final query_str.
'suppress_filters_query_str' => 0,
);
if ( empty( $current_user_id ) ) {
if ( ! is_user_logged_in() ) {
return $activity_results;
}
$current_user_id = get_current_user_id();
}
$query_args = wp_parse_args( $query_args, $defaults );
// We save a copy of the original query_args to compare after we have filled in some default values.
$query_args_org = $query_args;
// Clean the group_ids arg.
if ( '' !== $query_args['group_ids'] ) {
if ( ! is_array( $query_args['group_ids'] ) ) {
$query_args['group_ids'] = explode( ',', $query_args['group_ids'] );
}
$query_args['group_ids'] = array_map( 'trim', $query_args['group_ids'] );
} else {
$query_args['group_ids'] = array();
}
// Clean the course_ids arg.
if ( '' !== $query_args['course_ids'] ) {
if ( ! is_array( $query_args['course_ids'] ) ) {
$query_args['course_ids'] = explode( ',', $query_args['course_ids'] );
}
$query_args['course_ids'] = array_map( 'trim', $query_args['course_ids'] );
} else {
$query_args['course_ids'] = array();
}
// Clean the post_ids arg.
if ( '' !== $query_args['post_ids'] ) {
if ( ! is_array( $query_args['post_ids'] ) ) {
$query_args['post_ids'] = explode( ',', $query_args['post_ids'] );
}
$query_args['post_ids'] = array_map( 'trim', $query_args['post_ids'] );
} else {
$query_args['post_ids'] = array();
}
// Clean the post_types arg.
if ( '' !== $query_args['post_types'] ) {
if ( is_string( $query_args['post_types'] ) ) {
$query_args['post_types'] = explode( ',', $query_args['post_types'] );
}
$query_args['post_types'] = array_map( 'trim', $query_args['post_types'] );
$query_args['post_types'] = array_intersect( $query_args['post_types'], $learndash_post_types );
} else {
// If not provides we set this to our internal defined learndash_post_types.
$query_args['post_types'] = $learndash_post_types;
}
// Clean the post_status arg.
if ( '' !== $query_args['post_status'] ) {
if ( is_string( $query_args['post_status'] ) ) {
$query_args['post_status'] = explode( ',', $query_args['post_status'] );
}
$query_args['post_status'] = array_map( 'trim', $query_args['post_status'] );
} else {
$query_args['post_status'] = array();
}
// Clean the user_ids arg.
if ( '' !== $query_args['user_ids'] ) {
if ( ! is_array( $query_args['user_ids'] ) ) {
$query_args['user_ids'] = explode( ',', $query_args['user_ids'] );
}
$query_args['user_ids'] = array_map( 'trim', $query_args['user_ids'] );
} else {
$query_args['user_ids'] = array();
}
if ( '' !== $query_args['activity_types'] ) {
if ( is_string( $query_args['activity_types'] ) ) {
$query_args['activity_types'] = explode( ',', $query_args['activity_types'] );
}
$query_args['activity_types'] = array_map( 'trim', $query_args['activity_types'] );
} else {
$query_args['activity_types'] = array();
}
if ( '' !== $query_args['activity_status'] ) {
if ( is_string( $query_args['activity_status'] ) ) {
$query_args['activity_status'] = explode( ',', $query_args['activity_status'] );
}
$query_args['activity_status'] = array_map( 'trim', $query_args['activity_status'] );
$not_started_idx = array_search( 'NOT_STARTED', $query_args['activity_status'], true );
if ( false !== $not_started_idx ) {
$activity_status_has_null = true;
unset( $query_args['activity_status'][ $not_started_idx ] );
}
foreach ( $query_args['activity_status'] as $idx => $value ) {
if ( 'COMPLETED' == $value ) {
$query_args['activity_status'][ $idx ] = '1';
} else {
$query_args['activity_status'][ $idx ] = '0';
}
}
} else {
$query_args['activity_status'] = array();
}
// Sanitize values.
$query_args['user_ids'] = array_unique( LDLMS_DB::escape_numeric_array( $query_args['user_ids'] ) );
$query_args['post_ids'] = array_unique( LDLMS_DB::escape_numeric_array( $query_args['post_ids'] ) );
$query_args['group_ids'] = array_unique( LDLMS_DB::escape_numeric_array( $query_args['group_ids'] ) );
$query_args['course_ids'] = array_unique( LDLMS_DB::escape_numeric_array( $query_args['course_ids'] ) );
$query_args['post_status'] = array_unique( LDLMS_DB::escape_string_array( $query_args['post_status'] ) );
$query_args['post_types'] = array_unique( LDLMS_DB::escape_string_array( $query_args['post_types'] ) );
$query_args['activity_status'] = array_unique( LDLMS_DB::escape_numeric_array( $query_args['activity_status'] ) );
$query_args['activity_types'] = array_unique( LDLMS_DB::escape_string_array( $query_args['activity_types'] ) );
if ( empty( $query_args['group_ids'] ) && empty( $query_args['post_ids'] ) && empty( $query_args['user_ids'] ) ) {
// If no filters were provided.
// If the view user is a group leader we just return all the activity for all the managed users.
if ( learndash_is_group_leader_user( $current_user_id ) ) {
$query_args['user_ids'] = learndash_get_group_leader_groups_users( $current_user_id );
}
} elseif ( ! learndash_is_group_leader_user( $current_user_id ) ) {
if ( learndash_is_admin_user( $current_user_id ) ) {
// If the group_ids parameter is passed in we need to determine the course_ids contains in the group_ids.
if ( ! empty( $query_args['group_ids'] ) ) {
$query_args['post_ids'] = learndash_get_groups_courses_ids( $current_user_id, $query_args['group_ids'] );
}
} else {
/**
* If the user if not a group leader and not admin then abort until we have added support for those roles.
* return $activity_results;
*/
if ( empty( $query_args['user_ids'] ) ) {
$query_args['user_ids'] = array( get_current_user_id() );
}
if ( empty( $query_args['post_ids'] ) ) {
$query_args['post_ids'] = learndash_user_get_enrolled_courses( get_current_user_id() );
if ( empty( $query_args['post_ids'] ) ) {
return $activity_results;
}
}
}
}
// We need a timestamp (long int) for the query. Most likely there will be a date string passed to up.
$time_items = array( 'time_start', 'time_end' );
foreach ( $time_items as $time_item ) {
if ( ! empty( $query_args[ $time_item ] ) ) {
if ( ! is_string( $query_args[ $time_item ] ) ) {
// phpcs:ignore: WordPress.DateTime.RestrictedFunctions.date_date
$time_yymmdd = date( 'Y-m-d H:i:s', $query_args[ $time_item ] );
} else {
// phpcs:ignore: WordPress.DateTime.RestrictedFunctions.date_date
$time_yymmdd = date( 'Y-m-d H:i:s', strtotime( $query_args[ $time_item ] ) );
}
if ( true != $query_args[ $time_item . '_is_gmt' ] ) {
$time_yymmdd = get_gmt_from_date( $time_yymmdd );
}
$time_yymmdd = strtotime( $time_yymmdd );
if ( $time_yymmdd ) {
$query_args[ $time_item . '_gmt_timestamp' ] = $time_yymmdd;
}
}
}
// Check that the start and end dates are not backwards.
if ( ( isset( $query_args['time_start_gmt_timestamp'] ) ) && ( ! empty( $query_args['time_start_gmt_timestamp'] ) )
&& ( isset( $query_args['time_end_gmt_timestamp'] ) ) && ( ! empty( $query_args['time_end_gmt_timestamp'] ) ) ) {
if ( $query_args['time_start_gmt_timestamp'] > $query_args['time_end_gmt_timestamp'] ) {
$time_save = $query_args['time_start_gmt_timestamp'];
$query_args['time_start_gmt_timestamp'] = $query_args['time_end_gmt_timestamp'];
$query_args['time_end_gmt_timestamp'] = $time_save;
}
}
if ( ( true != $query_args['suppress_filters_all'] ) && ( true != $query_args['suppress_filters_query_args'] ) ) {
/**
* Filters query arguments for getting user activity.
*
* @param array $query_args An array query arguments for getting user activity.
*/
$query_args = apply_filters( 'learndash_get_activity_query_args', $query_args );
}
$sql_str_fields = '
users.ID as user_id,
users.display_name as user_display_name,
users.user_email as user_email,
posts.ID as post_id,
posts.post_title post_title,
posts.post_type as post_type,
ld_user_activity.activity_id as activity_id,
ld_user_activity.course_id as activity_course_id,
ld_user_activity.activity_type as activity_type,
ld_user_activity.activity_started as activity_started,
ld_user_activity.activity_completed as activity_completed,
ld_user_activity.activity_updated as activity_updated,
ld_user_activity.activity_status as activity_status';
$sql_str_tables = ' FROM ' . $wpdb->users . ' as users ';
// Some funky logic on the activity status. If the 'activity_status' is empty of the activity has NULL means we are looking for the
// 'NOT_STARTED'. In order to find users that have not started courses we need to do the INNER JOIN on the wp_posts table. This
// means for every combination of users AND posts (courses) we will fill out row. This can be expensive when you have thousands
// of users and courses.
if ( ( empty( $query_args['activity_status'] ) ) || ( true === $activity_status_has_null )
&& ( ( ! empty( $query_args['post_ids'] ) ) || ( ! empty( $query_args['user_ids'] ) ) ) ) {
$sql_str_joins = ' INNER JOIN ' . $wpdb->posts . ' as posts ';
$sql_str_joins .= ' LEFT JOIN ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' as ld_user_activity ON users.ID=ld_user_activity.user_id AND posts.ID=ld_user_activity.post_id ';
if ( ! empty( $query_args['activity_types'] ) ) {
$sql_str_joins .= ' AND (ld_user_activity.activity_type IS NULL OR ld_user_activity.activity_type IN (' . "'" . implode( "','", $query_args['activity_types'] ) . "'" . ') )';
}
} else {
$sql_str_joins = ' LEFT JOIN ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' as ld_user_activity ON users.ID=ld_user_activity.user_id ';
$sql_str_joins .= ' LEFT JOIN ' . $wpdb->posts . ' as posts ON posts.ID=ld_user_activity.post_id ';
}
$sql_str_where = ' WHERE 1=1 ';
if ( ! empty( $query_args['user_ids'] ) ) {
$sql_str_where .= ' AND users.ID ' . $query_args['user_ids_action'] . ' (' . implode( ',', $query_args['user_ids'] ) . ') ';
}
if ( ! empty( $query_args['post_ids'] ) ) {
$sql_str_where .= ' AND posts.ID ' . $query_args['post_ids_action'] . ' (' . implode( ',', $query_args['post_ids'] ) . ') ';
}
if ( ! empty( $query_args['post_status'] ) ) {
$sql_str_where .= ' AND posts.post_status IN (' . "'" . implode( "','", $query_args['post_status'] ) . "'" . ') ';
}
if ( ! empty( $query_args['post_types'] ) ) {
$sql_str_where .= ' AND posts.post_type IN (' . "'" . implode( "','", $query_args['post_types'] ) . "'" . ') ';
}
if ( true !== $activity_status_has_null ) {
if ( ! empty( $query_args['activity_types'] ) ) {
$sql_str_where .= ' AND ld_user_activity.activity_type IN (' . "'" . implode( "','", $query_args['activity_types'] ) . "'" . ') ';
}
if ( ! empty( $query_args['activity_status'] ) ) {
$sql_str_where .= ' AND ld_user_activity.activity_status IN (' . implode( ',', $query_args['activity_status'] ) . ') ';
}
} elseif ( ! empty( $query_args['activity_status'] ) ) {
$sql_str_where .= ' AND (ld_user_activity.activity_status IS NULL OR ld_user_activity.activity_status IN (' . "'" . implode( "','", $query_args['activity_status'] ) . "'" . ') ) ';
} else {
$sql_str_where .= ' AND ( ld_user_activity.activity_status IS NULL OR ld_user_activity.activity_started = 0 ) ';
}
if ( ! empty( $query_args['course_ids'] ) ) {
$sql_str_where .= ' AND ld_user_activity.course_id ' . $query_args['course_ids_action'] . ' (' . implode( ',', $query_args['course_ids'] ) . ') ';
}
if ( ( isset( $query_args['time_start_gmt_timestamp'] ) ) && ( ! empty( $query_args['time_start_gmt_timestamp'] ) ) && ( isset( $query_args['time_end_gmt_timestamp'] ) ) && ( ! empty( $query_args['time_end_gmt_timestamp'] ) ) ) {
$sql_str_where .= ' AND ( ';
// This is an old code. We will never get here. activity_status is converted to boolean before this. See line 795.
if ( array_intersect( array( 'NOT_STARTED', 'IN_PROGRESS' ), $query_args_org['activity_status'] ) || empty( $query_args_org['activity_status'] ) ) {
$sql_str_where .= '(ld_user_activity.activity_started BETWEEN ' . $query_args['time_start_gmt_timestamp'] . ' AND ' . $query_args['time_end_gmt_timestamp'] . ') ';
$sql_str_where .= ' OR ';
$sql_str_where .= '(ld_user_activity.activity_updated BETWEEN ' . $query_args['time_start_gmt_timestamp'] . ' AND ' . $query_args['time_end_gmt_timestamp'] . ') ';
}
if ( in_array( 'COMPLETED', $query_args_org['activity_status'] ) || empty( $query_args_org['activity_status'] ) ) {
if ( count( $query_args_org['activity_status'] ) > 1 || empty( $query_args_org['activity_status'] ) ) {
$sql_str_where .= ' OR ';
}
$sql_str_where .= '(ld_user_activity.activity_completed BETWEEN ' . $query_args['time_start_gmt_timestamp'] . ' AND ' . $query_args['time_end_gmt_timestamp'] . ') ';
}
$sql_str_where .= ' ) ';
} elseif ( ( isset( $query_args['time_start_gmt_timestamp'] ) ) && ( ! empty( $query_args['time_start_gmt_timestamp'] ) ) ) {
$sql_str_where .= ' AND ( ';
// This is an old code. We will never get here. activity_status is converted to boolean before this. See line 795.
if ( array_intersect( array( 'NOT_STARTED', 'IN_PROGRESS' ), $query_args_org['activity_status'] ) || empty( $query_args_org['activity_status'] ) ) {
$sql_str_where .= 'ld_user_activity.activity_started >= ' . $query_args['time_start_gmt_timestamp'] . ' OR ld_user_activity.activity_updated >= ' . $query_args['time_start_gmt_timestamp'];
}
if ( in_array( 'COMPLETED', $query_args_org['activity_status'] ) || empty( $query_args_org['activity_status'] ) ) {
if ( count( $query_args_org['activity_status'] ) > 1 || empty( $query_args_org['activity_status'] ) ) {
$sql_str_where .= ' OR ';
}
$sql_str_where .= 'ld_user_activity.activity_completed >= ' . $query_args['time_start_gmt_timestamp'];
}
$sql_str_where .= ' ) ';
} elseif ( ( isset( $query_args['time_end_gmt_timestamp'] ) ) && ( ! empty( $query_args['time_end_gmt_timestamp'] ) ) ) {
$sql_str_where .= ' AND ( ';
// This is an old code. We will never get here. activity_status is converted to boolean before this. See line 795.
if ( array_intersect( array( 'NOT_STARTED', 'IN_PROGRESS' ), $query_args_org['activity_status'] ) || empty( $query_args_org['activity_status'] ) ) {
$sql_str_where .= '(ld_user_activity.activity_started > 0 AND ld_user_activity.activity_started <= ' . $query_args['time_end_gmt_timestamp'] . ') OR ( ld_user_activity.activity_updated > 0 AND ld_user_activity.activity_updated <= ' . $query_args['time_end_gmt_timestamp'] . ')';
}
if ( in_array( 'COMPLETED', $query_args_org['activity_status'] ) || empty( $query_args_org['activity_status'] ) ) {
if ( count( $query_args_org['activity_status'] ) > 1 || empty( $query_args_org['activity_status'] ) ) {
$sql_str_where .= ' OR ';
}
$sql_str_where .= '( ld_user_activity.activity_completed > 0 AND ld_user_activity.activity_completed <= ' . $query_args['time_end_gmt_timestamp'] . ' )';
}
$sql_str_where .= ' ) ';
}
if ( ! empty( $query_args['s'] ) ) {
if ( 'post_title' == $query_args['s_context'] ) {
$sql_str_where .= " AND posts.post_title LIKE '" . $query_args['s'] . "' ";
} elseif ( 'display_name' == $query_args['s_context'] ) {
$sql_str_where .= " AND users.display_name LIKE '" . $query_args['s'] . "' ";
} else {
$sql_str_where .= " AND (posts.post_title LIKE '" . $query_args['s'] . "' OR users.display_name LIKE '" . $query_args['s'] . "') ";
}
}
if ( ! empty( $query_args['orderby_order'] ) ) {
$sql_str_order = ' ORDER BY ' . $query_args['orderby_order'] . ' ';
} else {
$sql_str_order = '';
}
if ( ! empty( $query_args['per_page'] ) ) {
if ( empty( $query_args['paged'] ) ) {
$query_args['paged'] = 1;
}
$sql_str_limit = ' LIMIT ' . $query_args['per_page'] . ' OFFSET ' . ( abs( intval( $query_args['paged'] ) ) - 1 ) * $query_args['per_page'];
} else {
$sql_str_limit = '';
}
if ( ( true != $query_args['suppress_filters_all'] ) && ( true != $query_args['suppress_filters_query_str'] ) ) {
/**
* Filters user activity query fields.
*
* @param string $sql_query_fields User activity query fields with valid sql syntax.
* @param array $query_args An array of user query arguments.
*/
$sql_str_fields = apply_filters( 'learndash_user_activity_query_fields', $sql_str_fields, $query_args );
/**
* Filters tables and joins to be used for user activity query. The `from` part of the query with valid SQL syntax.
*
* @param string $sql_query_from The `from` part of the SQL query with valid SQL syntax.
* @param array $query_args An array of user query arguments.
*/
$sql_str_tables = apply_filters( 'learndash_user_activity_query_tables', $sql_str_tables, $query_args );
/**
* Filters the joins for the user activity query.
*
* @param string $sql_query_where The `where` part of the SQL query with valid SQL syntax.
* @param array $query_args An array of user query arguments.
*/
$sql_str_joins = apply_filters( 'learndash_user_activity_query_joins', $sql_str_joins, $query_args );
/**
* Filters the where condition of the user activity query.
*
* @param string $sql_query_where The `where` part of the SQL query with valid SQL syntax.
* @param array $query_args An array of user query arguments.
*/
$sql_str_where = apply_filters( 'learndash_user_activity_query_where', $sql_str_where, $query_args );
/**
* Filters the order by part of the user activity query.
*
* @param string $sql_query_where The `ORDER BY` part of the SQL query with valid SQL syntax.
* @param array $query_args An array of user query arguments.
*/
$sql_str_order = apply_filters( 'learndash_user_activity_query_order', $sql_str_order, $query_args );
/**
* Filters the limit part of the user activity query.
*
* @param string $sql_query_where The `limit` part of the SQL query with valid SQL syntax.
* @param array $query_args An array of user query arguments.
*/
$sql_str_limit = apply_filters( 'learndash_user_activity_query_limit', $sql_str_limit, $query_args );
}
$sql_str = 'SELECT ' . $sql_str_fields . $sql_str_tables . $sql_str_joins . $sql_str_where . $sql_str_order . $sql_str_limit;
if ( true != $query_args['suppress_filters_query_str'] ) {
/**
* Filters the user activity SQL query string.
*
* @param string $sql_str User activity SQL query string.
* @param array $query_args An array of user query arguments.
*/
$sql_str = apply_filters( 'learndash_user_activity_query_str', $sql_str, $query_args );
}
$activity_results['query_str'] = $sql_str;
$activity_results['query_args'] = $query_args;
$activity_results['results'] = array();
$activity_results['pager'] = array();
$activity_results['pager']['total_items'] = 0;
$activity_results['pager']['per_page'] = intval( $query_args['per_page'] );
$activity_results['pager']['total_pages'] = 0;
if ( ( ! empty( $sql_str ) ) && ( 1 != $query_args['dry_run'] ) ) {
$activity_query_results = $wpdb->get_results( $sql_str ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
if ( ( ! is_wp_error( $activity_query_results ) ) && ( count( $activity_query_results ) ) ) {
$activity_results['results'] = $activity_query_results;
// Need to convert the item date. Actually add a new property which is the formatted date.
foreach ( $activity_results['results'] as &$result_item ) {
// There are three date fields we need format.
// 1. activity_started.
if ( ( property_exists( $result_item, 'activity_started' ) ) && ( ! empty( $result_item->activity_started ) ) ) {
// phpcs:ignore: WordPress.DateTime.RestrictedFunctions.date_date
$result_item->activity_started_formatted = get_date_from_gmt( date( 'Y-m-d H:i:s', $result_item->activity_started ), $query_args['date_format'] );
}
// 2. activity_completed.
if ( ( property_exists( $result_item, 'activity_completed' ) ) && ( ! empty( $result_item->activity_completed ) ) ) {
// phpcs:ignore: WordPress.DateTime.RestrictedFunctions.date_date
$result_item->activity_completed_formatted = get_date_from_gmt( date( 'Y-m-d H:i:s', $result_item->activity_completed ), $query_args['date_format'] );
}
// 3. activity_completed
if ( ( property_exists( $result_item, 'activity_updated' ) ) && ( ! empty( $result_item->activity_updated ) ) ) {
// phpcs:ignore: WordPress.DateTime.RestrictedFunctions.date_date
$result_item->activity_updated_formatted = get_date_from_gmt( date( 'Y-m-d H:i:s', $result_item->activity_updated ), $query_args['date_format'] );
}
if ( true == $query_args['include_meta'] ) {
$result_item->activity_meta = learndash_get_activity_meta_fields( $result_item->activity_id, $query_args['meta_fields'] );
}
}
} else {
$activity_results['results_error'] = $activity_query_results;
}
}
if ( ( 1 != $query_args['dry_run'] ) && ( isset( $activity_results['results'] ) ) && ( ! empty( $activity_results['results'] ) ) && ( ! empty( $query_args['per_page'] ) ) ) {
$query_str_count = 'SELECT SQL_CALC_FOUND_ROWS count(*) as count ' . $sql_str_tables . $sql_str_joins . ' ' . $sql_str_where;
$activity_query_count = $wpdb->get_row( $query_str_count ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
if ( ( ! is_wp_error( $activity_query_count ) ) && ( property_exists( $activity_query_count, 'count' ) ) ) {
$activity_results['pager'] = array();
$activity_results['pager']['total_items'] = absint( $activity_query_count->count );
$activity_results['pager']['per_page'] = absint( $query_args['per_page'] );
if ( $activity_results['pager']['total_items'] > 0 ) {
$activity_results['pager']['total_pages'] = ceil( intval( $activity_results['pager']['total_items'] ) / intval( $activity_results['pager']['per_page'] ) );
$activity_results['pager']['total_pages'] = absint( $activity_results['pager']['total_pages'] );
} else {
$activity_results['pager']['total_pages'] = 0;
}
} else {
$activity_results['pager_error'] = $activity_query_count;
}
}
return $activity_results;
}
/**
* Gets the user's course progress for the report.
*
* @since 2.3.0
*
* @param int $course_id Optional. The ID of the course to get user progress. Default 0.
* @param array $user_query_args Optional. The ID of the user to get progress. Default empty array.
* @param array $activity_query_args Optional. The query arguments to get the user activity. Default empty array.
*
* @return array Returns user course progress results.
*/
function learndash_report_course_users_progress( $course_id = 0, $user_query_args = array(), $activity_query_args = array() ) {
$course_user_progress_data = array();
if ( ! empty( $course_id ) ) {
// If the user_ids was not passed from the caller then we need to do that work.
if ( ( ! isset( $activity_query_args['user_ids'] ) ) || ( empty( $activity_query_args['user_ids'] ) ) ) {
$course_user_query = learndash_get_users_for_course( intval( $course_id ), $user_query_args );
if ( $course_user_query instanceof WP_User_Query ) {
$activity_query_args['user_ids'] = $course_user_query->get_results();
}
}
if ( ! empty( $activity_query_args['user_ids'] ) ) {
$activity_query_defaults = array(
'post_ids' => intval( $course_id ),
'post_types' => 'sfwd-courses',
'activity_types' => 'course',
'activity_status' => '',
'orderby_order' => 'users.display_name, posts.post_title',
'date_format' => 'F j, Y H:i:s',
'paged' => 1,
'per_page' => 10,
);
$activity_query_args = wp_parse_args( $activity_query_args, $activity_query_defaults );
$activity = learndash_reports_get_activity( $activity_query_args );
$report_course = get_post( $course_id );
if ( ! empty( $activity['results'] ) ) {
$course_user_progress_data = $activity;
}
}
}
return $course_user_progress_data;
}
/**
* Clears user activity by user id and activity type for the report.
*
* @since 2.5.0
*
* @param int $user_id Optional. The ID of the user to delete activity. Default 0.
* @param array $activity_types Optional. The type of the activity to delete. Any combination of the
* following: 'access', 'course', 'lesson', 'topic', 'quiz'. Default empty.
*/
function learndash_report_clear_user_activity_by_types( $user_id = 0, $activity_types = '' ) {
$activity_ids = learndash_report_get_activity_by_user_id( $user_id, $activity_types );
if ( ! empty( $activity_ids ) ) {
learndash_report_clear_by_activity_ids( $activity_ids );
}
}
/**
* Clears post activity by post id and activity type for the report.
*
* @since 2.5.0
*
* @param int $post_id Optional. The ID of the post to delete activity. Default 0.
* @param array $activity_types Optional. The type of the activity to delete. Any combination of the
* following: 'access', 'course', 'lesson', 'topic', 'quiz'. Default empty.
*/
function learndash_report_clear_post_activity_by_types( $post_id = 0, $activity_types = '' ) {
$activity_ids = learndash_report_get_activity_by_post_id( $post_id, $activity_types );
if ( ! empty( $activity_ids ) ) {
learndash_report_clear_by_activity_ids( $activity_ids );
}
}
/**
* Deletes the activity rows by activity ID for the report.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @since 2.5.0
*
* @param array $activity_ids Optional. An array of activity IDs. Default empty.
*/
function learndash_report_clear_by_activity_ids( $activity_ids = array() ) {
global $wpdb;
if ( ! empty( $activity_ids ) ) {
$activity_ids = array_map( 'absint', $activity_ids );
$wpdb->query(
$wpdb->prepare(
// phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare, WordPress.DB.PreparedSQL.NotPrepared -- IN clause
'DELETE FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity_meta' ) ) . ' WHERE activity_id IN (' . LDLMS_DB::escape_IN_clause_placeholders( $activity_ids ) . ')',
LDLMS_DB::escape_IN_clause_values( $activity_ids )
)
);
$wpdb->query(
$wpdb->prepare(
// phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare, WordPress.DB.PreparedSQL.NotPrepared -- IN clause
'DELETE FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' WHERE activity_id IN (' . LDLMS_DB::escape_IN_clause_placeholders( $activity_ids ) . ')',
LDLMS_DB::escape_IN_clause_values( $activity_ids )
)
);
}
}
/**
* Removes the mismatched user activities.
*
* Compares user_id field from report activity DB table to WP users rows.
* Entries not found in report activity will be removed.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @since 2.5.0
*/
function learndash_activity_clear_mismatched_users() {
global $wpdb;
$process_users = $wpdb->get_col(
'SELECT DISTINCT lua.user_id FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . " as lua LEFT JOIN {$wpdb->usermeta} as um1 ON lua.user_id = um1.user_id AND um1.meta_key = '{$wpdb->prefix}capabilities' LEFT JOIN {$wpdb->users} as users ON lua.user_id = users.ID WHERE 1=1 AND ( um1.meta_key IS NULL OR users.ID is NULL )"
);
if ( ! empty( $process_users ) ) {
foreach ( $process_users as $user_id ) {
learndash_report_clear_user_activity_by_types( $user_id );
}
}
}
/**
* Removes the mismatched post activities.
*
* Compares post_id field from report activity DB table to WP posts rows.
* Entries not found in report activity will be removed.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @since 2.5.0
*/
function learndash_activity_clear_mismatched_posts() {
global $wpdb;
$process_posts = $wpdb->get_col(
'SELECT DISTINCT ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . '.post_id FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' LEFT JOIN ' . $wpdb->posts . ' ON ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . '.post_id=' . $wpdb->posts . '.ID WHERE ' . $wpdb->posts . '.ID is NULL'
);
if ( ! empty( $process_posts ) ) {
foreach ( $process_posts as $post_id ) {
learndash_report_clear_post_activity_by_types( $post_id );
}
}
}
/**
* Gets the list of activities by user ID for the report.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @since 2.5.0
*
* @param int $user_id Optional. The ID of the user to get activities. Default 0.
* @param array|string $activity_types Optional. The type of the activity to delete. Any combination of the
* following: 'access', 'course', 'lesson', 'topic', 'quiz'. Default empty.
*
* @return array|void Returns an array of activity IDs.
*/
function learndash_report_get_activity_by_user_id( $user_id = 0, $activity_types = '' ) {
global $wpdb;
if ( empty( $user_id ) ) {
return;
}
$activity_ids = array();
if ( empty( $activity_types ) ) {
$activity_ids = $wpdb->get_col(
$wpdb->prepare(
'SELECT activity_id FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' WHERE user_id = %d',
$user_id
)
);
} else {
$activity_ids = $wpdb->get_col(
$wpdb->prepare(
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- IN clause
'SELECT activity_id FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' WHERE user_id = %d AND activity_type IN (' . LDLMS_DB::escape_IN_clause_placeholders( $activity_types ) . ')',
array_merge( array( $user_id ), LDLMS_DB::escape_IN_clause_values( $activity_types ) )
)
);
}
return array_map( 'absint', $activity_ids );
}
/**
* Gets the list of activities by post id for the report.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @since 2.5.0
*
* @param int $post_id Optional. The ID of the post to get activities. Default 0.
* @param array|strings $activity_types Optional. The type of the activity to delete. Any combination of the
* following: 'access', 'course', 'lesson', 'topic', 'quiz'. Default empty.
*
* @return array|void Returns an array of activity IDs.
*/
function learndash_report_get_activity_by_post_id( $post_id = 0, $activity_types = '' ) {
global $wpdb;
if ( empty( $post_id ) ) {
return;
}
$activity_ids = array();
if ( empty( $activity_types ) ) {
$activity_ids = $wpdb->get_col(
$wpdb->prepare(
'SELECT activity_id FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' WHERE post_id = %d',
$post_id
)
);
} else {
$activity_ids = $wpdb->get_col(
$wpdb->prepare(
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- IN clause
'SELECT activity_id FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' WHERE post_id = %d AND activity_type IN (' . LDLMS_DB::escape_IN_clause_placeholders( $activity_types ) . ')',
array_merge( array( $post_id ), LDLMS_DB::escape_IN_clause_values( $activity_types ) )
)
);
}
return array_map( 'absint', $activity_ids );
}
/**
* Gets the users course progress for the report.
*
* @since 2.3.0
*
* @param int $user_id Optional. User ID to get course list. Default 0.
* @param array $course_query_args Optional. The query arguments to get the list of user enrolled courses. Default empty array.
* @param array $activity_query_args Optional. The query arguments to get the the user activities. Default empty array.
*
* @return array If course query and activity query is successful this should be a multi-dimensional array showing 'results', 'pager', 'query_args', 'query_str'
*/
function learndash_report_user_courses_progress( $user_id = 0, $course_query_args = array(), $activity_query_args = array() ) {
$user_courses_progress_data = array();
if ( empty( $user_id ) ) {
if ( ! is_user_logged_in() ) {
return $user_courses_progress_data;
}
$user_id = get_current_user_id();
}
// If the post_ids (Course ids) was not passed from the caller then we need to do that work.
if ( ( ! isset( $activity_query_args['post_ids'] ) ) || ( empty( $activity_query_args['post_ids'] ) ) ) {
$activity_query_args['post_ids'] = learndash_user_get_enrolled_courses( intval( $user_id ), $course_query_args );
}
if ( ! empty( $activity_query_args['post_ids'] ) ) {
$activity_query_defaults = array(
'user_ids' => intval( $user_id ),
'post_types' => 'sfwd-courses',
'activity_types' => 'course',
'activity_status' => '',
'orderby_order' => 'users.display_name, posts.post_title',
'date_format' => 'F j, Y H:i:s',
'paged' => 1,
'per_page' => 10,
);
$activity_query_args = wp_parse_args( $activity_query_args, $activity_query_defaults );
$report_user = get_user_by( 'id', $user_id );
$activity = learndash_reports_get_activity( $activity_query_args );
if ( ! empty( $activity['results'] ) ) {
$user_courses_progress_data = $activity;
}
}
return $user_courses_progress_data;
}
/**
* Gets the user quiz attempts activity.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @since 2.3.0
*
* @param int $user_id Optional. The ID of the user to get quiz attempts. Default 0.
* @param int $quiz_id Optional. The ID of the quiz to get attempts. Default 0.
*
* @return array|void An array of quiz attempt activity IDs.
*/
function learndash_get_user_quiz_attempts( $user_id = 0, $quiz_id = 0 ) {
global $wpdb;
if ( ( ! empty( $user_id ) ) || ( ! empty( $quiz_id ) ) ) {
return $wpdb->get_results(
$wpdb->prepare( 'SELECT activity_id, activity_started, activity_completed FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' WHERE user_id = %d AND post_id = %d AND activity_type = %s ORDER BY activity_id, activity_started ASC', $user_id, $quiz_id, 'quiz' )
);
}
}
/**
* Gets the count of user quiz attempts.
*
* @since 2.3.0
*
* @param int $user_id The ID of the user to get quiz attempts.
* @param int $quiz_id The ID of the quiz to get attempts.
*
* @return int|void The count of quiz attempts.
*/
function learndash_get_user_quiz_attempts_count( $user_id, $quiz_id ) {
$quiz_attempts = learndash_get_user_quiz_attempts( $user_id, $quiz_id );
if ( ( ! empty( $quiz_attempts ) ) && ( is_array( $quiz_attempts ) ) ) {
return count( $quiz_attempts );
}
}
/**
* Gets the time spent by user on the quiz.
*
* Total of each started/complete time set.
*
* @since 2.3.0
*
* @param int $user_id The ID of the user to get quiz time spent.
* @param int $quiz_id The ID of the quiz to get time spent.
*
* @return int The total number of seconds spent on a quiz.
*/
function learndash_get_user_quiz_attempts_time_spent( $user_id, $quiz_id ) {
$total_time_spent = 0;
$attempts = learndash_get_user_quiz_attempts( $user_id, $quiz_id );
if ( ( ! empty( $attempts ) ) && ( is_array( $attempts ) ) ) {
foreach ( $attempts as $attempt ) {
$total_time_spent += ( $attempt->activity_completed - $attempt->activity_started );
}
}
return $total_time_spent;
}
/**
* Gets the user course attempts activity.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @since 2.3.0
*
* @param int $user_id Optional. The ID of the user to get course attempts. Default 0.
* @param int $course_id Optional. The ID of the course to get attempts. Default 0.
*
* @return array|void An array of activity IDs and timestamps or quizzes found.
*/
function learndash_get_user_course_attempts( $user_id = 0, $course_id = 0 ) {
global $wpdb;
if ( ( ! empty( $user_id ) ) || ( ! empty( $course_id ) ) ) {
return $wpdb->get_results(
$wpdb->prepare( 'SELECT activity_id, activity_started, activity_completed, activity_updated FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' WHERE user_id=%d AND post_id=%d and activity_type=%s ORDER BY activity_id, activity_started ASC', $user_id, $course_id, 'course' )
);
}
}
/**
* Gets the time spent by user in the course.
*
* Total of each started/complete time set.
*
* @since 2.3.0
*
* @param int $user_id Optional. The ID of the user to get course time spent. Default 0.
* @param int $course_id Optional. The ID of the course to get time spent. Default 0.
*
* @return int Total number of seconds spent.
*/
function learndash_get_user_course_attempts_time_spent( $user_id = 0, $course_id = 0 ) {
$total_time_spent = 0;
$attempts = learndash_get_user_course_attempts( $user_id, $course_id );
// We should only ever have one entry for a user+course_id. But still we are returned an array of objects.
if ( ( ! empty( $attempts ) ) && ( is_array( $attempts ) ) ) {
foreach ( $attempts as $attempt ) {
if ( ! empty( $attempt->activity_completed ) ) {
// If the Course is complete then we take the time as the completed - started times.
$total_time_spent += ( $attempt->activity_completed - $attempt->activity_started );
} else {
// But if the Course is not complete we calculate the time based on the updated timestamp
// This is updated on the course for each lesson, topic, quiz.
$total_time_spent += ( $attempt->activity_updated - $attempt->activity_started );
}
}
}
return $total_time_spent;
}
/**
* Gets the activity meta fields.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $activity_id Optional. The ID of the activity to get meta fields. Default 0.
* @param array $activity_meta_keys Optional. The array of meta field keys to get. Default empty array.
*
* @return array
*/
function learndash_get_activity_meta_fields( $activity_id = 0, $activity_meta_keys = array() ) {
global $wpdb;
$activity_meta = array();
if ( ! empty( $activity_id ) ) {
$activity_meta_raw = $wpdb->get_results(
$wpdb->prepare( 'SELECT activity_meta_key, activity_meta_value FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity_meta' ) ) . ' WHERE activity_id = %d', $activity_id )
);
// If we have some rows returned we want to restructure the meta to be proper key => value array pairs.
if ( ! empty( $activity_meta_raw ) ) {
foreach ( $activity_meta_raw as $activity_meta_item ) {
if ( ( empty( $activity_meta_keys ) ) || ( in_array( $activity_meta_item->activity_meta_key, $activity_meta_keys, true ) ) ) {
$activity_meta[ $activity_meta_item->activity_meta_key ] = $activity_meta_item->activity_meta_value;
}
}
}
}
return $activity_meta;}
/**
* Calculate the human readable time spent on activity.
*
* @since 2.3.0
* @since 2.3.0.3 Use `human_time_diff` function for output.
*
* @param int $activity_started The start timestamp to compare. Default 0.
* @param int $activity_completed The completed timestamp to compare. Default 0.
* @param int $minimum_diff Optional. The minimum difference between started and completed time. Default 60.
*
* @return string The human readable time difference.
*/
function learndash_get_activity_human_time_diff( $activity_started = 0, $activity_completed = 0, $minimum_diff = 60 ) {
if ( empty( $activity_started ) ) {
return;
}
if ( empty( $activity_completed ) ) {
return;
}
$activity_diff = abs( $activity_completed - $activity_started );
if ( $activity_diff < $minimum_diff ) {
return;
}
return human_time_diff( $activity_started, $activity_completed );
}