woothemes / sensei

includes/class-sensei-analysis-user-profile-list-table.php

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 12 and the first side effect is on line 2.

if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly

/**
 * Analysis User Profile Data Table in Sensei.
 *
 * @package Analytics
 * @author Automattic
 *
 * @since 1.2.0
 */
class Sensei_Analysis_User_Profile_List_Table extends Sensei_List_Table {
	public $user_id;
	public $page_slug = 'sensei_analysis';

	/**
	 * Constructor
	 * @since  1.2.0
	 * @return  void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

	 */
	public function __construct ( $user_id = 0 ) {
		$this->user_id = intval( $user_id );

		// Load Parent token into constructor
		parent::__construct( 'analysis_user_profile' );

		// Actions
		add_action( 'sensei_before_list_table', array( $this, 'data_table_header' ) );
		add_action( 'sensei_after_list_table', array( $this, 'data_table_footer' ) );

		add_filter( 'sensei_list_table_search_button_text', array( $this, 'search_button' ) );
	} // End __construct()

	/**
	 * Define the columns that are going to be used in the table
	 * @since  1.7.0
	 * @return array $columns, the array of columns to use with the table
	 */
	function get_columns() {

It is generally recommended to explicitly declare the visibility for methods.

This method seems to be duplicated in your project.

		$columns = array(
			'title' => __( 'Course', 'woothemes-sensei' ),
			'started' => __( 'Date Started', 'woothemes-sensei' ),
			'completed' => __( 'Date Completed', 'woothemes-sensei' ),
			'status' => __( 'Status', 'woothemes-sensei' ),
//			'grade' => __( 'Grade', 'woothemes-sensei' ),

54% of this comment could be valid code. Did you maybe forget this after debugging?

			'percent' => __( 'Percent Complete', 'woothemes-sensei' ),
		);
		$columns = apply_filters( 'sensei_analysis_user_profile_columns', $columns );
		return $columns;
	}

	/**
	 * Define the columns that are going to be used in the table
	 * @since  1.7.0
	 * @return array $columns, the array of columns to use with the table
	 */
	function get_sortable_columns() {

It is generally recommended to explicitly declare the visibility for methods.

This method seems to be duplicated in your project.

		$columns = array(
			'title' => array( 'title', false ),
			'started' => array( 'started', false ),
			'completed' => array( 'completed', false ),
			'status' => array( 'status', false ),
//			'grade' => array( 'grade', false ),

54% of this comment could be valid code. Did you maybe forget this after debugging?

			'percent' => array( 'percent', false )
		);
		$columns = apply_filters( 'sensei_analysis_user_profile_columns_sortable', $columns );
		return $columns;
	}

	/**
	 * Prepare the table with different parameters, pagination, columns and table elements
	 * @since  1.7.0
	 * @return void
	 */
	public function prepare_items() {

This method seems to be duplicated in your project.

		global $per_page;

		// Handle orderby (needs work)
		$orderby = '';
		if ( !empty( $_GET['orderby'] ) ) {
			if ( array_key_exists( esc_html( $_GET['orderby'] ), $this->get_sortable_columns() ) ) {
				$orderby = esc_html( $_GET['orderby'] );
			} // End If Statement
		}

		// Handle order
		$order = 'ASC';
		if ( !empty( $_GET['order'] ) ) {
			$order = ( 'ASC' == strtoupper($_GET['order']) ) ? 'ASC' : 'DESC';
		}

		// Handle search, need 4.1 version of WP to be able to restrict statuses to known post_ids
		$search = false;
		if ( !empty( $_GET['s'] ) ) {
			$search = esc_html( $_GET['s'] );
		} // End If Statement
		$this->search = $search;

		$per_page = $this->get_items_per_page( 'sensei_comments_per_page' );
		$per_page = apply_filters( 'sensei_comments_per_page', $per_page, 'sensei_comments' );

		$paged = $this->get_pagenum();
		$offset = 0;
		if ( !empty($paged) ) {
			$offset = $per_page * ( $paged - 1 );
		} // End If Statement

		$args = array(
			'number' => $per_page,
			'offset' => $offset,
			'orderby' => $orderby,
			'order' => $order,
		);
		if ( $this->search ) {
			$args['search'] = $this->search;
		} // End If Statement

		$this->items = $this->get_course_statuses( $args );

		$total_items = $this->total_items;
		$total_pages = ceil( $total_items / $per_page );
		$this->set_pagination_args( array(
			'total_items' => $total_items,
			'total_pages' => $total_pages,
			'per_page' => $per_page
		) );
	}

	/**
	 * Generate a csv report with different parameters, pagination, columns and table elements
	 * @since  1.7.0
	 * @return data
	 */
	public function generate_report( $report ) {

This method seems to be duplicated in your project.

		$data = array();

		$this->csv_output = true;

		// Handle orderby
		$orderby = '';
		if ( !empty( $_GET['orderby'] ) ) {
			if ( array_key_exists( esc_html( $_GET['orderby'] ), $this->get_sortable_columns() ) ) {
				$orderby = esc_html( $_GET['orderby'] );
			} // End If Statement
		}

		// Handle order
		$order = 'ASC';
		if ( !empty( $_GET['order'] ) ) {
			$order = ( 'ASC' == strtoupper($_GET['order']) ) ? 'ASC' : 'DESC';
		}

		// Handle search
		$search = false;
		if ( !empty( $_GET['s'] ) ) {
			$search = esc_html( $_GET['s'] );
		} // End If Statement
		$this->search = $search;

		$args = array(
			'orderby' => $orderby,
			'order' => $order,
		);
		if ( $this->search ) {
			$args['search'] = $this->search;
		} // End If Statement

		// Start the csv with the column headings
		$column_headers = array();
		$columns = $this->get_columns();
		foreach( $columns AS $key => $title ) {
			$column_headers[] = $title;
		}
		$data[] = $column_headers;

		$this->items = $this->get_course_statuses( $args );

		// Process each row
		foreach( $this->items AS $item) {
			$data[] = $this->get_row_data( $item );
		}

		return $data;
	}

	/**
	 * Generates the overall array for a single item in the display
	 * @since  1.7.0
	 * @param object $item The current item
	 */
	protected function get_row_data( $item ) {

		$course_title =  get_the_title( $item->comment_post_ID );
		$course_percent = get_comment_meta( $item->comment_ID, 'percent', true );
		$course_start_date = get_comment_meta( $item->comment_ID, 'start', true );
		$course_end_date = '';

		if( 'complete' == $item->comment_approved ) {

This code seems to be duplicated across your project.

            $status =  __( 'Completed', 'woothemes-sensei' );
			$status_class = 'graded';

			$course_end_date = $item->comment_date;

		} else {

			$status =  __( 'In Progress', 'woothemes-sensei' );
			$status_class = 'in-progress';

		}

		// Output users data
		if ( !$this->csv_output ) {

This code seems to be duplicated across your project.

			$url = add_query_arg( array( 'page' => $this->page_slug, 'user_id' => $this->user_id, 'course_id' => $item->comment_post_ID ), admin_url( 'admin.php' ) );

			$course_title = '<strong><a class="row-title" href="' . esc_url( $url ) . '">' . $course_title . '</a></strong>';
			$status = sprintf( '<span class="%s">%s</span>', $status_class, $status );
			if ( is_numeric($course_percent) ) {
				$course_percent .= '%';
			}
		} // End If Statement
		$column_data = apply_filters( 'sensei_analysis_user_profile_column_data', array( 'title' => $course_title,
										'started' => $course_start_date,
										'completed' => $course_end_date,
										'status' => $status,
										'percent' => $course_percent,
									), $item );

		return $column_data;
	}

	/**
	 * Return array of Course statuses
	 * @since  1.7.0
	 * @return array statuses
	 */
	private function get_course_statuses( $args ) {

		$activity_args = array( 
				'user_id' => $this->user_id,
				'type' => 'sensei_course_status',
				'number' => $args['number'],
				'offset' => $args['offset'],
				'orderby' => $args['orderby'],
				'order' => $args['order'],
				'status' => 'any',
			);

		$activity_args = apply_filters( 'sensei_analysis_user_profile_filter_statuses', $activity_args );

		// WP_Comment_Query doesn't support SQL_CALC_FOUND_ROWS, so instead do this twice
		$this->total_items = Sensei_Utils::sensei_check_for_activity( array_merge( $activity_args, array('count' => true, 'offset' => 0, 'number' => 0) ) );

		// Ensure we change our range to fit (in case a search threw off the pagination) - Should this be added to all views?
		if ( $this->total_items < $activity_args['offset'] ) {

			$new_paged = floor( $this->total_items / $activity_args['number'] );
			$activity_args['offset'] = $new_paged * $activity_args['number'];

		}
		$statuses = Sensei_Utils::sensei_check_for_activity( $activity_args, true );

		// Need to always return an array, even with only 1 item
		if ( !is_array($statuses) ) {
			$statuses = array( $statuses );
		}

		return $statuses;
	} // End get_course_statuses()

	/**
	 * Sets output when no items are found
	 * Overloads the parent method
	 * @since  1.2.0
	 * @return void
	 */
	public function no_items() {
		echo  __( 'No courses found.', 'woothemes-sensei' );
	} // End no_items()

	/**
	 * Output for table heading
	 * @since  1.2.0
	 * @return void
	 */
	public function data_table_header() {
		echo '<strong>' . __( 'Courses', 'woothemes-sensei' ) . '</strong>';
	}

	/**
	 * Output for table footer
	 * @since  1.7.0
	 * @return void
	 */
	public function data_table_footer() {

This method seems to be duplicated in your project.

		$user = get_user_by( 'id', $this->user_id );
		$report = sanitize_title( $user->display_name ) . '-course-overview';
		$url = add_query_arg( array( 'page' => $this->page_slug, 'user_id' => $this->user_id, 'sensei_report_download' => $report ), admin_url( 'admin.php' ) );
		echo '<a class="button button-primary" href="' . esc_url( wp_nonce_url( $url, 'sensei_csv_download-' . $report, '_sdl_nonce' ) ) . '">' . __( 'Export all rows (CSV)', 'woothemes-sensei' ) . '</a>';
	}

	/**
	 * The text for the search button
	 * @since  1.7.0
	 * @return string
	 */
	public function search_button( $text = '' ) {
		return __( 'Search Courses', 'woothemes-sensei' );
	}

} // End Class

/**
 * Class WooThemes_Sensei_Analysis_User_Profile_List_Table
 * @ignore only for backward compatibility
 * @since 1.9.0
 */
class WooThemes_Sensei_Analysis_User_Profile_List_Table extends WooThemes_Sensei_List_Table {}