Give_Update_Log_Table::get_paged() - Code Metrics - Inspection of "Merge pull request #2712 from WordImpress/release/..." - WordImpress/Give - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 1d3b59...426730 )

by Devin

created 2018-01-25 07:28 UTC

Give_Update_Log_Table::get_paged() A

↳ Parent: Give_Update_Log_Table

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	2
nc	2
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * Update Log View Class
 *
 * @package     Give
 * @subpackage  Admin/Reports
 * @copyright   Copyright (c) 2016, WordImpress
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
 * @since       2.0.1
 */

// 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';
}

/**
 * Give_Update_Log_Table List Table Class
 *
 * Renders the update log list table
 *
 * @since 2.0.1
 */
class Give_Update_Log_Table extends WP_List_Table {
	/**
	 * Number of items per page
	 *
	 * @var int
	 * @since 2.0.1
	 */
	public $per_page = 30;

	/**
	 * Get things started
	 *
	 * @since 2.0.1
	 * @see   WP_List_Table::__construct()
	 */
	public function __construct() {

		global $status, $page;

		// Set parent defaults
		parent::__construct( array(
			'singular' => give_get_forms_label_singular(),    // Singular name of the listed records
			'plural'   => give_get_forms_label_plural(),        // Plural name of the listed records
			'ajax'     => false,// Does this table support ajax?
		) );
	}

	/**
	 * Show the search field
	 *
	 * @since  2.0.1
	 * @access public
	 *
	 * @param string $text     Label for the search box
	 * @param string $input_id ID of the search box
	 *
	 * @return void
	 */
	public function search_box( $text, $input_id ) {
	}

	/**
	 * Retrieve the table columns
	 *
	 * @access public
	 * @since  2.0.1
	 *
	 * @return array $columns Array of all the list table columns
	 */
	public function get_columns() {
		$columns = array(
			'ID'      => __( 'Log ID', 'give' ),
			'date'    => __( 'Date', 'give' ),
			'details' => __( 'Process Details', 'give' ),
		);

		return $columns;
	}

	/**
	 * This function renders most of the columns in the list table.
	 *
	 * @access public
	 * @since  2.0.1
	 *
	 * @param array  $item        Contains all the data of the discount code
	 * @param string $column_name The name of the column
	 *
	 * @return string Column Name
	 */
	public function column_default( $item, $column_name ) {
		switch ( $column_name ) {
			case 'ID':
				return sprintf(
					'<span class="give-item-label give-item-label-gray">%1$s</span> %2$s',
					esc_attr( $item[ $column_name ] ),
					esc_attr( $item['title'] )
				);

			default:
				return esc_attr( $item[ $column_name ] );
		}
	}

	/**
	 * Output Error Message column
	 *
	 * @access public
	 * @since  2.0.1
	 *
	 * @param array $item Contains all the data of the log
	 *
	 * @return void
	 */
	public function column_details( $item ) {
		echo Give()->tooltips->render_link( array(

			'label'       => __( 'View Update Log', 'give' ),
			'tag_content' => '<span class="dashicons dashicons-visibility"></span>',
			'link'        => "#TB_inline?width=640&amp;inlineId=log-details-{$item['ID']}",
			'attributes'  => array(
				'class' => 'thickbox give-error-log-details-link button button-small',
			),
		) );
		?>
		<div id="log-details-<?php echo $item['ID']; ?>" style="display:none;">

			<?php

			// Print Log Content, if not empty.
			if ( ! empty( $item['log_content'] ) ) {
				echo sprintf(

					'<p><pre>%1$s</pre></div>',
					esc_html( $item['log_content'] )
				);
			}
			?>
		</div>
		<?php
	}


	/**
	 * Display Tablenav (extended)
	 *
	 * Display the table navigation above or below the table even when no items in the logs, so nav doesn't disappear
	 *
	 * @see    : https://github.com/WordImpress/Give/issues/564
	 *
	 * @since  1.4.1
	 * @access protected
	 *
	 * @param string $which
	 */
	protected function display_tablenav( $which ) {

		if ( 'top' === $which ) {
			wp_nonce_field( 'bulk-' . $this->_args['plural'] );
		}
		?>
		<div class="tablenav <?php echo esc_attr( $which ); ?>">

			<div class="alignleft actions bulkactions">
				<?php $this->bulk_actions( $which ); ?>
			</div>
			<?php
			$this->extra_tablenav( $which );
			$this->pagination( $which );
			?>

			<br class="clear"/>
		</div>
		<?php
	}

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

	}

	/**
	 * Outputs the log views
	 *
	 * @param string $which Top or Bottom.
	 *
	 * @access public
	 * @since  2.0.1
	 *
	 * @return void
	 */
	function bulk_actions( $which = '' ) {

	}

	/**
	 * Gets the log entries for the current view
	 *
	 * @access public
	 * @since  2.0.1
	 *
	 * @return array $logs_data Array of all the Log entires
	 */
	public function get_logs() {
		$logs_data = array();
		$paged     = $this->get_paged();
		$log_query = array(
			'log_type'       => 'update',
			'paged'          => $paged,
			'posts_per_page' => $this->per_page,
		);

		$logs = Give()->logs->get_connected_logs( $log_query );

		if ( $logs ) {
			foreach ( $logs as $log ) {

				$logs_data[] = array(
					'ID'          => $log->ID,
					'title'       => $log->log_title,
					'date'        => $log->log_date,
					'log_content' => $log->log_content,
					'log_date'    => $log->log_date,
				);
			}
		}

		return $logs_data;
	}

	/**
	 * Setup the final data for the table
	 *
	 * @access public
	 * @since  2.0.1
	 * @uses   Give_Update_Log_Table::get_columns()
	 * @uses   WP_List_Table::get_sortable_columns()
	 * @uses   Give_Update_Log_Table::get_pagenum()
	 * @uses   Give_Update_Log_Table::get_logs()
	 * @uses   Give_Update_Log_Table::get_log_count()
	 *
	 * @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->get_logs();
		$total_items           = Give()->logs->get_log_count( 0, 'update' );

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


1		<?php
2		/**
3		* Update Log View Class
4		*
5		* @package Give
6		* @subpackage Admin/Reports
7		* @copyright Copyright (c) 2016, WordImpress
8		* @license https://opensource.org/licenses/gpl-license GNU Public License
9		* @since 2.0.1
10		*/
11
12		// Exit if accessed directly.
13		if ( ! defined( 'ABSPATH' ) ) {
14		exit;
15		}
16
17		// Load WP_List_Table if not loaded
18		if ( ! class_exists( 'WP_List_Table' ) ) {
19		require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
20		}
21
22		/**
23		* Give_Update_Log_Table List Table Class
24		*
25		* Renders the update log list table
26		*
27		* @since 2.0.1
28		*/
29		class Give_Update_Log_Table extends WP_List_Table {
30		/**
31		* Number of items per page
32		*
33		* @var int
34		* @since 2.0.1
35		*/
36		public $per_page = 30;
37
38		/**
39		* Get things started
40		*
41		* @since 2.0.1
42		* @see WP_List_Table::__construct()
43		*/
44	View Code Duplication	public function __construct() {
		0 ignored issues – show Duplication introduced 2018-01-25 07:12 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
45		global $status, $page;
46
47		// Set parent defaults
48		parent::__construct( array(
49		'singular' => give_get_forms_label_singular(), // Singular name of the listed records
50		'plural' => give_get_forms_label_plural(), // Plural name of the listed records
51		'ajax' => false,// Does this table support ajax?
52		) );
53		}
54
55		/**
56		* Show the search field
57		*
58		* @since 2.0.1
59		* @access public
60		*
61		* @param string $text Label for the search box
62		* @param string $input_id ID of the search box
63		*
64		* @return void
65		*/
66		public function search_box( $text, $input_id ) {
67		}
68
69		/**
70		* Retrieve the table columns
71		*
72		* @access public
73		* @since 2.0.1
74		*
75		* @return array $columns Array of all the list table columns
76		*/
77		public function get_columns() {
78		$columns = array(
79		'ID' => __( 'Log ID', 'give' ),
80		'date' => __( 'Date', 'give' ),
81		'details' => __( 'Process Details', 'give' ),
82		);
83
84		return $columns;
85		}
86
87		/**
88		* This function renders most of the columns in the list table.
89		*
90		* @access public
91		* @since 2.0.1
92		*
93		* @param array $item Contains all the data of the discount code
94		* @param string $column_name The name of the column
95		*
96		* @return string Column Name
97		*/
98		public function column_default( $item, $column_name ) {
99		switch ( $column_name ) {
100		case 'ID':
101		return sprintf(
102		'<span class="give-item-label give-item-label-gray">%1$s</span> %2$s',
103		esc_attr( $item[ $column_name ] ),
104		esc_attr( $item['title'] )
105		);
106
107		default:
108		return esc_attr( $item[ $column_name ] );
109		}
110		}
111
112		/**
113		* Output Error Message column
114		*
115		* @access public
116		* @since 2.0.1
117		*
118		* @param array $item Contains all the data of the log
119		*
120		* @return void
121		*/
122		public function column_details( $item ) {
123		echo Give()->tooltips->render_link( array(
		0 ignored issues – show introduced 2018-01-25 07:12 UTC by Report Bug Copy Issue Report Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'Give' Loading history...
124		'label' => __( 'View Update Log', 'give' ),
125		'tag_content' => '<span class="dashicons dashicons-visibility"></span>',
126		'link' => "#TB_inline?width=640&inlineId=log-details-{$item['ID']}",
127		'attributes' => array(
128		'class' => 'thickbox give-error-log-details-link button button-small',
129		),
130		) );
131		?>
132		<div id="log-details-<?php echo $item['ID']; ?>" style="display:none;">
		0 ignored issues – show introduced 2018-01-25 07:12 UTC by Report Bug Copy Issue Report Expected next thing to be a escaping function, not '$item' Loading history...
133		<?php
134
135		// Print Log Content, if not empty.
136		if ( ! empty( $item['log_content'] ) ) {
137		echo sprintf(
		0 ignored issues – show introduced 2018-01-25 07:12 UTC by Report Bug Copy Issue Report Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'sprintf' Loading history...
138		'<p><pre>%1$s</pre></div>',
139		esc_html( $item['log_content'] )
140		);
141		}
142		?>
143		</div>
144		<?php
145		}
146
147
148		/**
149		* Display Tablenav (extended)
150		*
151		* Display the table navigation above or below the table even when no items in the logs, so nav doesn't disappear
152		*
153		* @see : https://github.com/WordImpress/Give/issues/564
154		*
155		* @since 1.4.1
156		* @access protected
157		*
158		* @param string $which
159		*/
160	View Code Duplication	protected function display_tablenav( $which ) {
		0 ignored issues – show Duplication introduced 2017-08-01 08:32 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
161		if ( 'top' === $which ) {
162		wp_nonce_field( 'bulk-' . $this->_args['plural'] );
163		}
164		?>
165		<div class="tablenav <?php echo esc_attr( $which ); ?>">
166
167		<div class="alignleft actions bulkactions">
168		<?php $this->bulk_actions( $which ); ?>
169		</div>
170		<?php
171		$this->extra_tablenav( $which );
172		$this->pagination( $which );
173		?>
174
175		<br class="clear"/>
176		</div>
177		<?php
178		}
179
180		/**
181		* Retrieve the current page number
182		*
183		* @access public
184		* @since 2.0.1
185		*
186		* @return int Current page number
187		*/
188		public function get_paged() {
189		return isset( $_GET['paged'] ) ? absint( $_GET['paged'] ) : 1;
		0 ignored issues – show introduced 2018-01-25 07:12 UTC by Report Bug Copy Issue Report Detected access of super global var $_GET, probably need manual inspection. Loading history...
190		}
191
192		/**
193		* Outputs the log views
194		*
195		* @param string $which Top or Bottom.
196		*
197		* @access public
198		* @since 2.0.1
199		*
200		* @return void
201		*/
202		function bulk_actions( $which = '' ) {
		0 ignored issues – show Best Practice introduced 2018-01-25 07:12 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
203		}
204
205		/**
206		* Gets the log entries for the current view
207		*
208		* @access public
209		* @since 2.0.1
210		*
211		* @return array $logs_data Array of all the Log entires
212		*/
213		public function get_logs() {
214		$logs_data = array();
215		$paged = $this->get_paged();
216		$log_query = array(
217		'log_type' => 'update',
218		'paged' => $paged,
219		'posts_per_page' => $this->per_page,
220		);
221
222		$logs = Give()->logs->get_connected_logs( $log_query );
223
224		if ( $logs ) {
225		foreach ( $logs as $log ) {
226
227		$logs_data[] = array(
228		'ID' => $log->ID,
229		'title' => $log->log_title,
230		'date' => $log->log_date,
231		'log_content' => $log->log_content,
232		'log_date' => $log->log_date,
233		);
234		}
235		}
236
237		return $logs_data;
238		}
239
240		/**
241		* Setup the final data for the table
242		*
243		* @access public
244		* @since 2.0.1
245		* @uses Give_Update_Log_Table::get_columns()
246		* @uses WP_List_Table::get_sortable_columns()
247		* @uses Give_Update_Log_Table::get_pagenum()
248		* @uses Give_Update_Log_Table::get_logs()
249		* @uses Give_Update_Log_Table::get_log_count()
250		*
251		* @return void
252		*/
253	View Code Duplication	public function prepare_items() {
		0 ignored issues – show Duplication introduced 2018-01-25 07:12 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
254		$columns = $this->get_columns();
255		$hidden = array(); // No hidden columns
256		$sortable = $this->get_sortable_columns();
257		$this->_column_headers = array( $columns, $hidden, $sortable );
258		$this->items = $this->get_logs();
259		$total_items = Give()->logs->get_log_count( 0, 'update' );
260
261		$this->set_pagination_args( array(
262		'total_items' => $total_items,
263		'per_page' => $this->per_page,
264		'total_pages' => ceil( $total_items / $this->per_page ),
265		)
266		);
267		}
268		}
269

WordImpress / Give

Push — master ( 1d3b59...426730 )

Give_Update_Log_Table::get_paged() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like