<?php

/**

 * Base class for displaying a list of items in an ajaxified HTML table.

 *

 * @package WordPress

 * @subpackage List_Table

 * @since 3.1.0

 */

/**

 * Base class for displaying a list of items in an ajaxified HTML table.

 *

 * @package WordPress

 * @subpackage List_Table

 * @since 3.1.0

 * @access private

 */

class WP_List_Table {

	/**

	 * The current list of items

	 *

	 * @since 3.1.0

	 * @var array

	 * @access protected

	 */

	var $items;

	/**

	 * Various information about the current table

	 *

	 * @since 3.1.0

	 * @var array

	 * @access private

	 */

	var $_args;

	/**

	 * Various information needed for displaying the pagination

	 *

	 * @since 3.1.0

	 * @var array

	 * @access private

	 */

	var $_pagination_args = array();

	/**

	 * The current screen

	 *

	 * @since 3.1.0

	 * @var object

	 * @access protected

	 */

	var $screen;

	/**

	 * Cached bulk actions

	 *

	 * @since 3.1.0

	 * @var array

	 * @access private

	 */

	var $_actions;

	/**

	 * Cached pagination output

	 *

	 * @since 3.1.0

	 * @var string

	 * @access private

	 */

	var $_pagination;

	/**

	 * Constructor. The child class should call this constructor from its own constructor

	 *

	 * @param array $args An associative array with information about the current table

	 * @access protected

	 */

	function __construct( $args = array() ) {

		$args = wp_parse_args( $args, array(

			'plural' => '',

			'singular' => '',

			'ajax' => false,

			'screen' => null,

		) );

		$this->screen = convert_to_screen( $args['screen'] );

		add_filter( "manage_{$this->screen->id}_columns", array( $this, 'get_columns' ), 0 );

		if ( !$args['plural'] )

			$args['plural'] = $this->screen->base;

		$args['plural'] = sanitize_key( $args['plural'] );

		$args['singular'] = sanitize_key( $args['singular'] );

		$this->_args = $args;

		if ( $args['ajax'] ) {

			// wp_enqueue_script( 'list-table' );

			add_action( 'admin_footer', array( $this, '_js_vars' ) );

		}

	}

	/**

	 * Checks the current user's permissions

	 * @uses wp_die()

	 *

	 * @since 3.1.0

	 * @access public

	 * @abstract

	 */

	function ajax_user_can() {

		die( 'function WP_List_Table::ajax_user_can() must be over-ridden in a sub-class.' );

	}

	/**

	 * Prepares the list of items for displaying.

	 * @uses WP_List_Table::set_pagination_args()

	 *

	 * @since 3.1.0

	 * @access public

	 * @abstract

	 */

	function prepare_items() {

		die( 'function WP_List_Table::prepare_items() must be over-ridden in a sub-class.' );

	}

	/**

	 * An internal method that sets all the necessary pagination arguments

	 *

	 * @param array $args An associative array with information about the pagination

	 * @access protected

	 */

	function set_pagination_args( $args ) {

		$args = wp_parse_args( $args, array(

			'total_items' => 0,

			'total_pages' => 0,

			'per_page' => 0,

		) );

		if ( !$args['total_pages'] && $args['per_page'] > 0 )

			$args['total_pages'] = ceil( $args['total_items'] / $args['per_page'] );

		// redirect if page number is invalid and headers are not already sent

		if ( ! headers_sent() && ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX ) && $args['total_pages'] > 0 && $this->get_pagenum() > $args['total_pages'] ) {

			wp_redirect( add_query_arg( 'paged', $args['total_pages'] ) );

			exit;

		}

		$this->_pagination_args = $args;

	}

	/**

	 * Access the pagination args

	 *

	 * @since 3.1.0

	 * @access public

	 *

	 * @param string $key

	 * @return array

	 */

	function get_pagination_arg( $key ) {

		if ( 'page' == $key )

			return $this->get_pagenum();

		if ( isset( $this->_pagination_args[$key] ) )

			return $this->_pagination_args[$key];

	}

	/**

	 * Whether the table has items to display or not

	 *

	 * @since 3.1.0

	 * @access public

	 *

	 * @return bool

	 */

	function has_items() {

		return !empty( $this->items );

	}

	/**

	 * Message to be displayed when there are no items

	 *

	 * @since 3.1.0

	 * @access public

	 */

	function no_items() {

		_e( 'No items found.' );

	}

	/**

	 * Display the search box.

	 *

	 * @since 3.1.0

	 * @access public

	 *

	 * @param string $text The search button text

	 * @param string $input_id The search input id

	 */

	function search_box( $text, $input_id ) {

		if ( empty( $_REQUEST['s'] ) && !$this->has_items() )

			return;

		$input_id = $input_id . '-search-input';

		if ( ! empty( $_REQUEST['orderby'] ) )

			echo '<input type="hidden" name="orderby" value="' . esc_attr( $_REQUEST['orderby'] ) . '" />';

		if ( ! empty( $_REQUEST['order'] ) )

			echo '<input type="hidden" name="order" value="' . esc_attr( $_REQUEST['order'] ) . '" />';

		if ( ! empty( $_REQUEST['post_mime_type'] ) )

			echo '<input type="hidden" name="post_mime_type" value="' . esc_attr( $_REQUEST['post_mime_type'] ) . '" />';

		if ( ! empty( $_REQUEST['detached'] ) )

			echo '<input type="hidden" name="detached" value="' . esc_attr( $_REQUEST['detached'] ) . '" />';

?>

<p class="search-box">

	<label class="screen-reader-text" for="<?php echo $input_id ?>"><?php echo $text; ?>:</label>

	<input type="search" id="<?php echo $input_id ?>" name="s" value="<?php _admin_search_query(); ?>" />

	<?php submit_button( $text, 'button', false, false, array('id' => 'search-submit') ); ?>

</p>

<?php

	}

	/**

	 * Get an associative array ( id => link ) with the list

	 * of views available on this table.

	 *

	 * @since 3.1.0

	 * @access protected

	 *

	 * @return array

	 */

	function get_views() {

		return array();

	}

	/**

	 * Display the list of views available on this table.

	 *

	 * @since 3.1.0

	 * @access public

	 */

	function views() {

		$views = $this->get_views();

		$views = apply_filters( 'views_' . $this->screen->id, $views );

		if ( empty( $views ) )

			return;

		echo "<ul class='subsubsub'>\n";

		foreach ( $views as $class => $view ) {

			$views[ $class ] = "\t<li class='$class'>$view";

		}

		echo implode( " |</li>\n", $views ) . "</li>\n";

		echo "</ul>";

	}

	/**

	 * Get an associative array ( option_name => option_title ) with the list

	 * of bulk actions available on this table.

	 *

	 * @since 3.1.0

	 * @access protected

	 *

	 * @return array

	 */

	function get_bulk_actions() {

		return array();

	}

	/**

	 * Display the bulk actions dropdown.

	 *

	 * @since 3.1.0

	 * @access public

	 */

	function bulk_actions() {

		if ( is_null( $this->_actions ) ) {

			$no_new_actions = $this->_actions = $this->get_bulk_actions();

			// This filter can currently only be used to remove actions.

			$this->_actions = apply_filters( 'bulk_actions-' . $this->screen->id, $this->_actions );

			$this->_actions = array_intersect_assoc( $this->_actions, $no_new_actions );

			$two = '';

		} else {

			$two = '2';

		}

		if ( empty( $this->_actions ) )

			return;

		echo "<select name='action$two'>\n";

		echo "<option value='-1' selected='selected'>" . __( 'Bulk Actions' ) . "</option>\n";

		foreach ( $this->_actions as $name => $title ) {

			$class = 'edit' == $name ? ' class="hide-if-no-js"' : '';

			echo "\t<option value='$name'$class>$title</option>\n";

		}

		echo "</select>\n";

		submit_button( __( 'Apply' ), 'action', false, false, array( 'id' => "doaction$two" ) );

		echo "\n";

	}

	/**

	 * Get the current action selected from the bulk actions dropdown.

	 *

	 * @since 3.1.0

	 * @access public

	 *

	 * @return string|bool The action name or False if no action was selected

	 */

	function current_action() {

		if ( isset( $_REQUEST['action'] ) && -1 != $_REQUEST['action'] )

			return $_REQUEST['action'];

		if ( isset( $_REQUEST['action2'] ) && -1 != $_REQUEST['action2'] )

			return $_REQUEST['action2'];

		return false;

	}

	/**

	 * Generate row actions div

	 *

	 * @since 3.1.0

	 * @access protected

	 *

	 * @param array $actions The list of actions

	 * @param bool $always_visible Whether the actions should be always visible

	 * @return string

	 */

	function row_actions( $actions, $always_visible = false ) {

		$action_count = count( $actions );

		$i = 0;

		if ( !$action_count )

			return '';

		$out = '<div class="' . ( $always_visible ? 'row-actions visible' : 'row-actions' ) . '">';

		foreach ( $actions as $action => $link ) {

			++$i;

			( $i == $action_count ) ? $sep = '' : $sep = ' | ';

			$out .= "<span class='$action'>$link$sep</span>";

		}

		$out .= '</div>';

		return $out;

	}

	/**

	 * Display a monthly dropdown for filtering items

	 *

	 * @since 3.1.0

	 * @access protected

	 */

	function months_dropdown( $post_type ) {

		global $wpdb, $wp_locale;

		$months = $wpdb->get_results( $wpdb->prepare( "

			SELECT DISTINCT YEAR( post_date ) AS year, MONTH( post_date ) AS month

			FROM $wpdb->posts

			WHERE post_type = %s

			ORDER BY post_date DESC

		", $post_type ) );

		/**

		 * Filter the months dropdown results.

		 *

		 * @since 3.7.0

		 *

		 * @param object $months    The months dropdown query results.

		 * @param string $post_type The post type.

		 */

		$months = apply_filters( 'months_dropdown_results', $months, $post_type );

		$month_count = count( $months );

		if ( !$month_count || ( 1 == $month_count && 0 == $months[0]->month ) )

			return;

		$m = isset( $_GET['m'] ) ? (int) $_GET['m'] : 0;

?>

		<select name='m'>

			<option<?php selected( $m, 0 ); ?> value='0'><?php _e( 'Show all dates' ); ?></option>

<?php

		foreach ( $months as $arc_row ) {

			if ( 0 == $arc_row->year )

				continue;

			$month = zeroise( $arc_row->month, 2 );

			$year = $arc_row->year;

			printf( "<option %s value='%s'>%s</option>\n",

				selected( $m, $year . $month, false ),

				esc_attr( $arc_row->year . $month ),

				/* translators: 1: month name, 2: 4-digit year */

				sprintf( __( '%1$s %2$d' ), $wp_locale->get_month( $month ), $year )

			);

		}

?>

		</select>

<?php

	}

	/**

	 * Display a view switcher

	 *

	 * @since 3.1.0

	 * @access protected

	 */

	function view_switcher( $current_mode ) {

		$modes = array(

			'list'    => __( 'List View' ),

			'excerpt' => __( 'Excerpt View' )

		);

?>

		<input type="hidden" name="mode" value="<?php echo esc_attr( $current_mode ); ?>" />

		<div class="view-switch">

<?php

			foreach ( $modes as $mode => $title ) {

				$class = ( $current_mode == $mode ) ? 'class="current"' : '';

				echo "<a href='" . esc_url( add_query_arg( 'mode', $mode, $_SERVER['REQUEST_URI'] ) ) . "' $class><img id='view-switch-$mode' src='" . esc_url( includes_url( 'images/blank.gif' ) ) . "' width='20' height='20' title='$title' alt='$title' /></a>\n";

			}

		?>

		</div>

<?php

	}

	/**

	 * Display a comment count bubble