WPInv_Gateways_Report_Table

Complexity

Total Complexity

10

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	get_primary_column_name()	0	2	1
A	bulk_actions()	0	2	1
A	get_columns()	0	9	1
A	reports_data()	0	20	2
A	__construct()	0	8	1
A	get_paged()	0	2	2
A	column_default()	0	2	1
A	prepare_items()	0	6	1

<?php
/**
 * Gateways Reports Table Class
 *
 */

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

// Load WP_List_Table if not loaded
if ( ! class_exists( 'WP_List_Table' ) ) {
	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
}

/**
 * WPInv_Gateawy_Reports_Table Class
 *
 * Renders the Gateway Reports table
 *
 * @since 1.0.19
 */
class WPInv_Gateways_Report_Table extends WP_List_Table {

	/**
	 * @var int Number of items per page
	 * @since 1.0.19
	 */
	public $per_page = 300;


	/**
	 * Get things started
	 *
	 * @since 1.0.19
	 * @see WP_List_Table::__construct()
	 */
	public function __construct() {
		global $status, $page;

		// Set parent defaults
		parent::__construct( array(
			'singular' => 'id',
			'plural'   => 'ids',
			'ajax'     => false,
		) );

	}

	/**
	 * Gets the name of the primary column.
	 *
	 * @since 1.0.19
	 * @access protected
	 *
	 * @return string Name of the primary column.
	 */
	protected function get_primary_column_name() {
		return 'label';
	}

	/**
	 * This function renders most of the columns in the list table.
	 *
	 * @since 1.0.19
	 *
	 * @param array $item Contains all the data of the gateways
	 * @param string $column_name The name of the column
	 *
	 * @return string Column Name
	 */
	public function column_default( $item, $column_name ) {
		return esc_html( $item[ $column_name ] );
	}

	/**
	 * Retrieve the table columns
	 *
	 * @since 1.0.19
	 * @return array $columns Array of all the list table columns
	 */
	public function get_columns() {
		$columns = array(
			'label'          => __( 'Gateway', 'invoicing' ),
			'complete_sales' => __( 'Complete Sales', 'invoicing' ),
			'pending_sales'  => __( 'Pending / Failed Sales', 'invoicing' ),
			'total_sales'    => __( 'Total Sales', 'invoicing' ),
		);

		return $columns;
	}

	/**
	 * Retrieve the current page number
	 *
	 * @since 1.0.19
	 * @return int Current page number
	 */
	public function get_paged() {
		return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1;
	}

	/**
	 * Outputs the reporting views
	 *
	 * @since 1.0.19
	 * @return void
	 */
	public function bulk_actions( $which = '' ) {
		return array();

The expression return array() returns the type array which is incompatible with the documented return type void.

	}

	/**
	 * Build all the reports data
	 *
	 * @since 1.0.19
	 * @return array $reports_data All the data for gateway reports
	 */
	public function reports_data() {

		$reports_data = array();
		$gateways     = wpinv_get_payment_gateways();

		foreach ( $gateways as $gateway_id => $gateway ) {

			$complete_count = wpinv_count_sales_by_gateway( $gateway_id, 'publish' );
			$pending_count  = wpinv_count_sales_by_gateway( $gateway_id, array( 'pending', 'failed' ) );

			$reports_data[] = array(
				'ID'             => $gateway_id,
				'label'          => $gateway['admin_label'],
				'complete_sales' => wpinv_format_amount( $complete_count, false ),
				'pending_sales'  => wpinv_format_amount( $pending_count, false ),
				'total_sales'    => wpinv_format_amount( $complete_count + $pending_count, false ),
			);
		}

		return $reports_data;
	}

	/**
	 * Setup the final data for the table
	 *
	 * @since 1.0.19
	 * @return void
	 */
	public function prepare_items() {
		$columns               = $this->get_columns();
		$hidden                = array(); // No hidden columns
		$sortable              = $this->get_sortable_columns();
		$this->_column_headers = array( $columns, $hidden, $sortable );
		$this->items           = $this->reports_data();
	}
}