<?php

/**

 * Administration API: WP_List_Table class

 *

 * @package WordPress

 * @subpackage List_Table

 * @since 3.1.0

 */

/**

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

 *

 * @since 3.1.0

 * @access private

 */

class WP_List_Table {

	/**

	 * The current list of items.

	 *

	 * @since 3.1.0

	 * @var array

	 */

	public $items;

	/**

	 * Various information about the current table.

	 *

	 * @since 3.1.0

	 * @var array

	 */

	protected $_args;

	/**

	 * Various information needed for displaying the pagination.

	 *

	 * @since 3.1.0

	 * @var array

	 */

	protected $_pagination_args = array();

	/**

	 * The current screen.

	 *

	 * @since 3.1.0

	 */

	protected $screen;

	/**

	 * Cached bulk actions.

	 *

	 * @since 3.1.0

	 * @var array

	 */

	private $_actions;

	/**

	 * Cached pagination output.

	 *

	 * @since 3.1.0

	 * @var string

	 */

	private $_pagination;

	/**

	 * The view switcher modes.

	 *

	 * @since 4.1.0

	 * @var array

	 */

	protected $modes = array();

	/**

	 * Stores the value returned by ->get_column_info().

	 *

	 * @since 4.1.0

	 * @var array

	 */

	protected $_column_headers;

	/**

	 * {@internal Missing Summary}

	 *

	 * @var array

	 */

	protected $compat_fields = array( '_args', '_pagination_args', 'screen', '_actions', '_pagination' );

	/**

	 * {@internal Missing Summary}

	 *

	 * @var array

	 */

	protected $compat_methods = array(

		'set_pagination_args',

		'get_views',

		'get_bulk_actions',

		'bulk_actions',

		'row_actions',

		'months_dropdown',

		'view_switcher',

		'comments_bubble',

		'get_items_per_page',

		'pagination',

		'get_sortable_columns',

		'get_column_info',

		'get_table_classes',

		'display_tablenav',

		'extra_tablenav',

		'single_row_columns',

	);

	/**

	 * Constructor.

	 *

	 * The child class should call this constructor from its own constructor to override

	 * the default $args.

	 *

	 * @since 3.1.0

	 *

	 * @param array|string $args {

	 *     Array or string of arguments.

	 *

	 *     @type string $plural   Plural value used for labels and the objects being listed.

	 *                            This affects things such as CSS class-names and nonces used

	 *                            in the list table, e.g. 'posts'. Default empty.

	 *     @type string $singular Singular label for an object being listed, e.g. 'post'.

	 *                            Default empty

	 *     @type bool   $ajax     Whether the list table supports Ajax. This includes loading

	 *                            and sorting data, for example. If true, the class will call

	 *                            the _js_vars() method in the footer to provide variables

	 *                            to any scripts handling Ajax events. Default false.

	 *     @type string $screen   String containing the hook name used to determine the current

	 *                            screen. If left null, the current screen will be automatically set.

	 *                            Default null.

	 * }

	 */

	public 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' ) );

		}

		if ( empty( $this->modes ) ) {

			$this->modes = array(

				'list'    => __( 'Compact view' ),

				'excerpt' => __( 'Extended view' ),

			);

		}

	}

	/**

	 * Make private properties readable for backward compatibility.

	 *

	 * @since 4.0.0

	 *

	 * @param string $name Property to get.

	 * @return mixed Property.

	 */

	public function __get( $name ) {

		if ( in_array( $name, $this->compat_fields, true ) ) {

			return $this->$name;

		}

	}

	/**

	 * Make private properties settable for backward compatibility.

	 *

	 * @since 4.0.0

	 *

	 * @param string $name  Property to check if set.

	 * @param mixed  $value Property value.

	 * @return mixed Newly-set property.

	 */

	public function __set( $name, $value ) {

		if ( in_array( $name, $this->compat_fields, true ) ) {

			return $this->$name = $value;

		}

	}

	/**

	 * Make private properties checkable for backward compatibility.

	 *

	 * @since 4.0.0

	 *

	 * @param string $name Property to check if set.

	 * @return bool Whether the property is set.

	 */

	public function __isset( $name ) {

		if ( in_array( $name, $this->compat_fields, true ) ) {

			return isset( $this->$name );

		}

	}

	/**

	 * Make private properties un-settable for backward compatibility.

	 *

	 * @since 4.0.0

	 *

	 * @param string $name Property to unset.

	 */

	public function __unset( $name ) {

		if ( in_array( $name, $this->compat_fields, true ) ) {

			unset( $this->$name );

		}

	}

	/**

	 * Make private/protected methods readable for backward compatibility.

	 *

	 * @since 4.0.0

	 *

	 * @param string $name      Method to call.

	 * @param array  $arguments Arguments to pass when calling.

	 * @return mixed|bool Return value of the callback, false otherwise.

	 */

	public function __call( $name, $arguments ) {

		if ( in_array( $name, $this->compat_methods, true ) ) {

			return $this->$name( ...$arguments );

		}

		return false;

	}

	/**

	 * Checks the current user's permissions

	 *

	 * @since 3.1.0

	 * @abstract

	 */

	public function ajax_user_can() {

		die( 'function WP_List_Table::ajax_user_can() must be overridden in a subclass.' );

	}

	/**

	 * Prepares the list of items for displaying.

	 *

	 * @uses WP_List_Table::set_pagination_args()

	 *

	 * @since 3.1.0

	 * @abstract

	 */

	public function prepare_items() {

		die( 'function WP_List_Table::prepare_items() must be overridden in a subclass.' );

	}

	/**

	 * An internal method that sets all the necessary pagination arguments

	 *

	 * @since 3.1.0

	 *

	 * @param array|string $args Array or string of arguments with information about the pagination.

	 */

	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() && ! wp_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

	 *

	 * @param string $key Pagination argument to retrieve. Common values include 'total_items',

	 *                    'total_pages', 'per_page', or 'infinite_scroll'.

	 * @return int Number of items that correspond to the given pagination argument.

	 */

	public 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

	 *

	 * @return bool

	 */

	public function has_items() {

		return ! empty( $this->items );

	}

	/**

	 * Message to be displayed when there are no items

	 *

	 * @since 3.1.0

	 */

	public function no_items() {

		_e( 'No items found.' );

	}

	/**

	 * Displays the search box.

	 *

	 * @since 3.1.0

	 *

	 * @param string $text     The 'submit' button label.

	 * @param string $input_id ID attribute value for the search input field.

	 */

	public 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 esc_attr( $input_id ); ?>"><?php echo $text; ?>:</label>

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

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

</p>

		<?php

	}

	/**

	 * Gets the list of views available on this table.

	 *

	 * The format is an associative array:

	 * - `'id' => 'link'`

	 *

	 * @since 3.1.0

	 *

	 * @return array

	 */

	protected function get_views() {

		return array();

	}

	/**

	 * Displays the list of views available on this table.

	 *

	 * @since 3.1.0

	 */

	public function views() {

		$views = $this->get_views();

		/**

		 * Filters the list of available list table views.

		 *

		 * The dynamic portion of the hook name, `$this->screen->id`, refers

		 *

		 * @since 3.1.0

		 *

		 * @param string[] $views An array of available list table views.

		 */

		$views = apply_filters( "views_{$this->screen->id}", $views );

		if ( empty( $views ) ) {

			return;

		}

		$this->screen->render_screen_reader_content( 'heading_views' );

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

	}

	/**