From 8b31878ebfb364b99ca9a0918c22d099bb72a4f8 Mon Sep 17 00:00:00 2001 From: Steve Sutton Date: Fri, 17 Oct 2014 16:34:12 -0400 Subject: [PATCH] output sample data testing new plugin with admin list feature --- controllers/admin.php | 19 +- glm-employment.php | 1 + models/class-glm-list-table.php | 1080 +++++++++++++++++++++++++++++++ models/listJobs.php | 382 +++++++++++ 4 files changed, 1481 insertions(+), 1 deletion(-) create mode 100644 models/class-glm-list-table.php create mode 100644 models/listJobs.php diff --git a/controllers/admin.php b/controllers/admin.php index fa1ab21..b15d6e9 100644 --- a/controllers/admin.php +++ b/controllers/admin.php @@ -44,7 +44,24 @@ class AdminController public function overview() { - echo '
List Jobs
'; + $jobListTable = new \listJobs(); + $jobListTable->prepare_items(); + ?> +
+ +

+

List Jobs

+ + +
+ + + + display() ?> +
+ +
+ '', + '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' ) ); + } + } + + /** + * Make private properties readable for backwards compatibility. + * + * @since 4.0.0 + * @access public + * + * @param string $name Property to get. + * @return mixed Property. + */ + public function __get( $name ) { + return $this->$name; + } + + /** + * Make private properties settable for backwards compatibility. + * + * @since 4.0.0 + * @access public + * + * @param string $name Property to set. + * @param mixed $value Property value. + * @return mixed Newly-set property. + */ + public function __set( $name, $value ) { + return $this->$name = $value; + } + + /** + * Make private properties checkable for backwards compatibility. + * + * @since 4.0.0 + * @access public + * + * @param string $name Property to check if set. + * @return bool Whether the property is set. + */ + public function __isset( $name ) { + return isset( $this->$name ); + } + + /** + * Make private properties un-settable for backwards compatibility. + * + * @since 4.0.0 + * @access public + * + * @param string $name Property to unset. + */ + public function __unset( $name ) { + unset( $this->$name ); + } + + /** + * Make private/protected methods readable for backwards compatibility. + * + * @since 4.0.0 + * @access public + * + * @param callable $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 ) { + return call_user_func_array( array( $this, $name ), $arguments ); + } + + /** + * Checks the current user's permissions + * @uses wp_die() + * + * @since 3.1.0 + * @access public + * @abstract + */ + public 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 + */ + public 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 + */ + 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 + */ + 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 + * @access public + * + * @return bool + */ + public function has_items() { + return !empty( $this->items ); + } + + /** + * Message to be displayed when there are no items + * + * @since 3.1.0 + * @access public + */ + 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 + */ + 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 ''; + if ( ! empty( $_REQUEST['order'] ) ) + echo ''; + if ( ! empty( $_REQUEST['post_mime_type'] ) ) + echo ''; + if ( ! empty( $_REQUEST['detached'] ) ) + echo ''; +?> +

+ + + 'search-submit') ); ?> +

+ link ) with the list + * of views available on this table. + * + * @since 3.1.0 + * @access protected + * + * @return array + */ + protected function get_views() { + return array(); + } + + /** + * Display the list of views available on this table. + * + * @since 3.1.0 + * @access public + */ + public function views() { + $views = $this->get_views(); + /** + * Filter the list of available list table views. + * + * The dynamic portion of the hook name, $this->screen->id, refers + * to the ID of the current screen, usually a string. + * + * @since 3.5.0 + * + * @param array $views An array of available list table views. + */ + $views = apply_filters( "views_{$this->screen->id}", $views ); + + if ( empty( $views ) ) + return; + + echo ""; + } + + /** + * 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 + */ + protected function get_bulk_actions() { + return array(); + } + + /** + * Display the bulk actions dropdown. + * + * @since 3.1.0 + * @access protected + * + * @param string $which The location of the bulk actions: 'top' or 'bottom'. + * This is designated as optional for backwards-compatibility. + */ + protected function bulk_actions( $which = '' ) { + if ( is_null( $this->_actions ) ) { + $no_new_actions = $this->_actions = $this->get_bulk_actions(); + /** + * Filter the list table Bulk Actions drop-down. + * + * The dynamic portion of the hook name, $this->screen->id, refers + * to the ID of the current screen, usually a string. + * + * This filter can currently only be used to remove bulk actions. + * + * @since 3.5.0 + * + * @param array $actions An array of the available bulk 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 ""; + echo "\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 + */ + public function current_action() { + if ( isset( $_REQUEST['filter_action'] ) && ! empty( $_REQUEST['filter_action'] ) ) + return false; + + 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 + */ + protected function row_actions( $actions, $always_visible = false ) { + $action_count = count( $actions ); + $i = 0; + + if ( !$action_count ) + return ''; + + $out = '
'; + foreach ( $actions as $action => $link ) { + ++$i; + ( $i == $action_count ) ? $sep = '' : $sep = ' | '; + $out .= "$link$sep"; + } + $out .= '
'; + + return $out; + } + + /** + * Display a monthly dropdown for filtering items + * + * @since 3.1.0 + * @access protected + */ + 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' drop-down results. + * + * @since 3.7.0 + * + * @param object $months The months drop-down 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; +?> + + + __( 'List View' ), + 'excerpt' => __( 'Excerpt View' ) + ); + +?> + +
+ $title ) { + $classes = array( 'view-' . $mode ); + if ( $current_mode == $mode ) + $classes[] = 'current'; + printf( + "%s\n", + esc_url( add_query_arg( 'mode', $mode ) ), + implode( ' ', $classes ), + $title + ); + } + ?> +
+'; + + echo "" . number_format_i18n( get_comments_number() ) . ""; + + if ( $pending_comments ) + echo ''; + } + + /** + * Get the current page number + * + * @since 3.1.0 + * @access public + * + * @return int + */ + public function get_pagenum() { + $pagenum = isset( $_REQUEST['paged'] ) ? absint( $_REQUEST['paged'] ) : 0; + + if( isset( $this->_pagination_args['total_pages'] ) && $pagenum > $this->_pagination_args['total_pages'] ) + $pagenum = $this->_pagination_args['total_pages']; + + return max( 1, $pagenum ); + } + + /** + * Get number of items to display on a single page + * + * @since 3.1.0 + * @access protected + * + * @return int + */ + protected function get_items_per_page( $option, $default = 20 ) { + $per_page = (int) get_user_option( $option ); + if ( empty( $per_page ) || $per_page < 1 ) + $per_page = $default; + + /** + * Filter the number of items to be displayed on each page of the list table. + * + * The dynamic hook name, $option, refers to the per page option depending + * on the type of list table in use. Possible values may include: + * 'edit_comments_per_page', 'sites_network_per_page', 'site_themes_network_per_page', + * 'themes_netework_per_page', 'users_network_per_page', 'edit_{$post_type}', etc. + * + * @since 2.9.0 + * + * @param int $per_page Number of items to be displayed. Default 20. + */ + return (int) apply_filters( $option, $per_page ); + } + + /** + * Display the pagination. + * + * @since 3.1.0 + * @access protected + */ + protected function pagination( $which ) { + if ( empty( $this->_pagination_args ) ) { + return; + } + + $total_items = $this->_pagination_args['total_items']; + $total_pages = $this->_pagination_args['total_pages']; + $infinite_scroll = false; + if ( isset( $this->_pagination_args['infinite_scroll'] ) ) { + $infinite_scroll = $this->_pagination_args['infinite_scroll']; + } + + $output = '' . sprintf( _n( '1 item', '%s items', $total_items ), number_format_i18n( $total_items ) ) . ''; + + $current = $this->get_pagenum(); + + $current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ); + + $current_url = remove_query_arg( array( 'hotkeys_highlight_last', 'hotkeys_highlight_first' ), $current_url ); + + $page_links = array(); + + $disable_first = $disable_last = ''; + if ( $current == 1 ) { + $disable_first = ' disabled'; + } + if ( $current == $total_pages ) { + $disable_last = ' disabled'; + } + $page_links[] = sprintf( "%s", + 'first-page' . $disable_first, + esc_attr__( 'Go to the first page' ), + esc_url( remove_query_arg( 'paged', $current_url ) ), + '«' + ); + + $page_links[] = sprintf( "%s", + 'prev-page' . $disable_first, + esc_attr__( 'Go to the previous page' ), + esc_url( add_query_arg( 'paged', max( 1, $current-1 ), $current_url ) ), + '‹' + ); + + if ( 'bottom' == $which ) { + $html_current_page = $current; + } else { + $html_current_page = sprintf( "%s", + '', + esc_attr__( 'Current page' ), + $current, + strlen( $total_pages ) + ); + } + $html_total_pages = sprintf( "%s", number_format_i18n( $total_pages ) ); + $page_links[] = '' . sprintf( _x( '%1$s of %2$s', 'paging' ), $html_current_page, $html_total_pages ) . ''; + + $page_links[] = sprintf( "%s", + 'next-page' . $disable_last, + esc_attr__( 'Go to the next page' ), + esc_url( add_query_arg( 'paged', min( $total_pages, $current+1 ), $current_url ) ), + '›' + ); + + $page_links[] = sprintf( "%s", + 'last-page' . $disable_last, + esc_attr__( 'Go to the last page' ), + esc_url( add_query_arg( 'paged', $total_pages, $current_url ) ), + '»' + ); + + $pagination_links_class = 'pagination-links'; + if ( ! empty( $infinite_scroll ) ) { + $pagination_links_class = ' hide-if-js'; + } + $output .= "\n" . join( "\n", $page_links ) . ''; + + if ( $total_pages ) { + $page_class = $total_pages < 2 ? ' one-page' : ''; + } else { + $page_class = ' no-pages'; + } + $this->_pagination = "
$output
"; + + echo $this->_pagination; + } + + /** + * Get a list of columns. The format is: + * 'internal-name' => 'Title' + * + * @since 3.1.0 + * @access public + * @abstract + * + * @return array + */ + public function get_columns() { + die( 'function WP_List_Table::get_columns() must be over-ridden in a sub-class.' ); + } + + /** + * Get a list of sortable columns. The format is: + * 'internal-name' => 'orderby' + * or + * 'internal-name' => array( 'orderby', true ) + * + * The second format will make the initial sorting order be descending + * + * @since 3.1.0 + * @access protected + * + * @return array + */ + protected function get_sortable_columns() { + return array(); + } + + /** + * Get a list of all, hidden and sortable columns, with filter applied + * + * @since 3.1.0 + * @access protected + * + * @return array + */ + protected function get_column_info() { + if ( isset( $this->_column_headers ) ) + return $this->_column_headers; + + $columns = get_column_headers( $this->screen ); + $hidden = get_hidden_columns( $this->screen ); + + $sortable_columns = $this->get_sortable_columns(); + /** + * Filter the list table sortable columns for a specific screen. + * + * The dynamic portion of the hook name, $this->screen->id, refers + * to the ID of the current screen, usually a string. + * + * @since 3.5.0 + * + * @param array $sortable_columns An array of sortable columns. + */ + $_sortable = apply_filters( "manage_{$this->screen->id}_sortable_columns", $sortable_columns ); + + $sortable = array(); + foreach ( $_sortable as $id => $data ) { + if ( empty( $data ) ) + continue; + + $data = (array) $data; + if ( !isset( $data[1] ) ) + $data[1] = false; + + $sortable[$id] = $data; + } + + $this->_column_headers = array( $columns, $hidden, $sortable ); + + return $this->_column_headers; + } + + /** + * Return number of visible columns + * + * @since 3.1.0 + * @access public + * + * @return int + */ + public function get_column_count() { + list ( $columns, $hidden ) = $this->get_column_info(); + $hidden = array_intersect( array_keys( $columns ), array_filter( $hidden ) ); + return count( $columns ) - count( $hidden ); + } + + /** + * Print column headers, accounting for hidden and sortable columns. + * + * @since 3.1.0 + * @access public + * + * @param bool $with_id Whether to set the id attribute or not + */ + public function print_column_headers( $with_id = true ) { + list( $columns, $hidden, $sortable ) = $this->get_column_info(); + + $current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ); + $current_url = remove_query_arg( 'paged', $current_url ); + + if ( isset( $_GET['orderby'] ) ) + $current_orderby = $_GET['orderby']; + else + $current_orderby = ''; + + if ( isset( $_GET['order'] ) && 'desc' == $_GET['order'] ) + $current_order = 'desc'; + else + $current_order = 'asc'; + + if ( ! empty( $columns['cb'] ) ) { + static $cb_counter = 1; + $columns['cb'] = '' + . ''; + $cb_counter++; + } + + foreach ( $columns as $column_key => $column_display_name ) { + $class = array( 'manage-column', "column-$column_key" ); + + $style = ''; + if ( in_array( $column_key, $hidden ) ) + $style = 'display:none;'; + + $style = ' style="' . $style . '"'; + + if ( 'cb' == $column_key ) + $class[] = 'check-column'; + elseif ( in_array( $column_key, array( 'posts', 'comments', 'links' ) ) ) + $class[] = 'num'; + + if ( isset( $sortable[$column_key] ) ) { + list( $orderby, $desc_first ) = $sortable[$column_key]; + + if ( $current_orderby == $orderby ) { + $order = 'asc' == $current_order ? 'desc' : 'asc'; + $class[] = 'sorted'; + $class[] = $current_order; + } else { + $order = $desc_first ? 'desc' : 'asc'; + $class[] = 'sortable'; + $class[] = $desc_first ? 'asc' : 'desc'; + } + + $column_display_name = '' . $column_display_name . ''; + } + + $id = $with_id ? "id='$column_key'" : ''; + + if ( !empty( $class ) ) + $class = "class='" . join( ' ', $class ) . "'"; + + echo "$column_display_name"; + } + } + + /** + * Display the table + * + * @since 3.1.0 + * @access public + */ + public function display() { + $singular = $this->_args['singular']; + + $this->display_tablenav( 'top' ); + +?> + + + + print_column_headers(); ?> + + + + + + print_column_headers( false ); ?> + + + + > + display_rows_or_placeholder(); ?> + +
+display_tablenav( 'bottom' ); + } + + /** + * Get a list of CSS classes for the tag + * + * @since 3.1.0 + * @access protected + * + * @return array + */ + protected function get_table_classes() { + return array( 'widefat', 'fixed', $this->_args['plural'] ); + } + + /** + * Generate the table navigation above or below the table + * + * @since 3.1.0 + * @access protected + */ + protected function display_tablenav( $which ) { + if ( 'top' == $which ) + wp_nonce_field( 'bulk-' . $this->_args['plural'] ); +?> +
+ +
+ bulk_actions( $which ); ?> +
+extra_tablenav( $which ); + $this->pagination( $which ); +?> + +
+
+ part of the table + * + * @since 3.1.0 + * @access public + */ + public function display_rows_or_placeholder() { + if ( $this->has_items() ) { + $this->display_rows(); + } else { + echo ''; + } + } + + /** + * Generate the table rows + * + * @since 3.1.0 + * @access public + */ + public function display_rows() { + foreach ( $this->items as $item ) + $this->single_row( $item ); + } + + /** + * Generates content for a single row of the table + * + * @since 3.1.0 + * @access public + * + * @param object $item The current item + */ + public function single_row( $item ) { + static $row_class = ''; + $row_class = ( $row_class == '' ? ' class="alternate"' : '' ); + + echo ''; + $this->single_row_columns( $item ); + echo ''; + } + + /** + * Generates the columns for a single row of the table + * + * @since 3.1.0 + * @access protected + * + * @param object $item The current item + */ + protected function single_row_columns( $item ) { + list( $columns, $hidden ) = $this->get_column_info(); + + foreach ( $columns as $column_name => $column_display_name ) { + $class = "class='$column_name column-$column_name'"; + + $style = ''; + if ( in_array( $column_name, $hidden ) ) + $style = ' style="display:none;"'; + + $attributes = "$class$style"; + + if ( 'cb' == $column_name ) { + echo ''; + } + elseif ( method_exists( $this, 'column_' . $column_name ) ) { + echo ""; + } + else { + echo ""; + } + } + } + + /** + * Handle an incoming ajax request (called from admin-ajax.php) + * + * @since 3.1.0 + * @access public + */ + public function ajax_response() { + $this->prepare_items(); + + ob_start(); + if ( ! empty( $_REQUEST['no_placeholder'] ) ) { + $this->display_rows(); + } else { + $this->display_rows_or_placeholder(); + } + + $rows = ob_get_clean(); + + $response = array( 'rows' => $rows ); + + if ( isset( $this->_pagination_args['total_items'] ) ) { + $response['total_items_i18n'] = sprintf( + _n( '1 item', '%s items', $this->_pagination_args['total_items'] ), + number_format_i18n( $this->_pagination_args['total_items'] ) + ); + } + if ( isset( $this->_pagination_args['total_pages'] ) ) { + $response['total_pages'] = $this->_pagination_args['total_pages']; + $response['total_pages_i18n'] = number_format_i18n( $this->_pagination_args['total_pages'] ); + } + + die( json_encode( $response ) ); + } + + /** + * Send required variables to JavaScript land + * + * @access public + */ + public function _js_vars() { + $args = array( + 'class' => get_class( $this ), + 'screen' => array( + 'id' => $this->screen->id, + 'base' => $this->screen->base, + ) + ); + + printf( "\n", json_encode( $args ) ); + } +} diff --git a/models/listJobs.php b/models/listJobs.php new file mode 100644 index 0000000..78daf39 --- /dev/null +++ b/models/listJobs.php @@ -0,0 +1,382 @@ +query(). + * + * @var array + **************************************************************************/ + var $example_data = array( + array( + 'ID' => 1, + 'title' => 'RN - OR Circular Nurse', + 'category' => 'Nursing', + 'department' => 'Nursing' + ), + array( + 'ID' => 2, + 'title' => 'Dermatologist', + 'category' => 'Physicians', + 'department' => 'Dermatology' + ), + array( + 'ID' => 3, + 'title' => 'ER Physician', + 'category' => 'Physicians', + 'department' => 'Family Practice' + ), + array( + 'ID' => 4, + 'title' => 'Respiratory Therapist', + 'category' => 'Allied Health/Certified/Licensed', + 'department' => 'Nursing' + ), + array( + 'ID' => 5, + 'title' => 'Family Practice', + 'category' => 'Physicians', + 'department' => 'Neurology' + ), + array( + 'ID' => 6, + 'title' => 'Cerified Surgical Technician', + 'category' => 'Allied Health/Certified/Licensed', + 'department' => 'Cardiopulmonary' + ), + array( + 'ID' => 7, + 'title' => 'Dietary Aide', + 'category' => 'Support Services', + 'department' => 'Food & Nutrition Services' + ) + ); + /** ************************************************************************ + * REQUIRED. Set up a constructor that references the parent constructor. We + * use the parent reference to set some default configs. + ***************************************************************************/ + function __construct(){ + global $status, $page; + + //Set parent defaults + parent::__construct( array( + 'singular' => 'movie', //singular name of the listed records + 'plural' => 'movies', //plural name of the listed records + 'ajax' => false //does this table support ajax? + ) ); + + } + /** ************************************************************************ + * Recommended. This method is called when the parent class can't find a method + * specifically build for a given column. Generally, it's recommended to include + * one method for each column you want to render, keeping your package class + * neat and organized. For example, if the class needs to process a column + * named 'title', it would first see if a method named $this->column_title() + * exists - if it does, that method will be used. If it doesn't, this one will + * be used. Generally, you should try to use custom column methods as much as + * possible. + * + * Since we have defined a column_title() method later on, this method doesn't + * need to concern itself with any column with a name of 'title'. Instead, it + * needs to handle everything else. + * + * For more detailed insight into how columns are handled, take a look at + * WP_List_Table::single_row_columns() + * + * @param array $item A singular item (one full row's worth of data) + * @param array $column_name The name/slug of the column to be processed + * @return string Text or HTML to be placed inside the column
'; + $this->no_items(); + echo '
'; + echo $this->column_cb( $item ); + echo '"; + echo call_user_func( array( $this, 'column_' . $column_name ), $item ); + echo ""; + echo $this->column_default( $item, $column_name ); + echo " + **************************************************************************/ + function column_default($item, $column_name){ + switch($column_name){ + case 'category': + case 'department': + return $item[$column_name]; + default: + return print_r($item,true); //Show the whole array for troubleshooting purposes + } + } + + + /** ************************************************************************ + * Recommended. This is a custom column method and is responsible for what + * is rendered in any column with a name/slug of 'title'. Every time the class + * needs to render a column, it first looks for a method named + * column_{$column_title} - if it exists, that method is run. If it doesn't + * exist, column_default() is called instead. + * + * This example also illustrates how to implement rollover actions. Actions + * should be an associative array formatted as 'slug'=>'link html' - and you + * will need to generate the URLs yourself. You could even ensure the links + * + * + * @see WP_List_Table::::single_row_columns() + * @param array $item A singular item (one full row's worth of data) + * @return string Text to be placed inside the column (movie title only) + **************************************************************************/ + function column_title($item){ + + //Build row actions + $actions = array( + 'edit' => sprintf('Edit',$_REQUEST['page'],'edit',$item['ID']), + 'delete' => sprintf('Delete',$_REQUEST['page'],'delete',$item['ID']), + ); + + //Return the title contents + return sprintf('%1$s (id:%2$s)%3$s', + /*$1%s*/ $item['title'], + /*$2%s*/ $item['ID'], + /*$3%s*/ $this->row_actions($actions) + ); + } + + + /** ************************************************************************ + * REQUIRED if displaying checkboxes or using bulk actions! The 'cb' column + * is given special treatment when columns are processed. It ALWAYS needs to + * have it's own method. + * + * @see WP_List_Table::::single_row_columns() + * @param array $item A singular item (one full row's worth of data) + * @return string Text to be placed inside the column (movie title only) + **************************************************************************/ + function column_cb($item){ + return sprintf( + '', + /*$1%s*/ $this->_args['singular'], //Let's simply repurpose the table's singular label ("movie") + /*$2%s*/ $item['ID'] //The value of the checkbox should be the record's id + ); + } + + + /** ************************************************************************ + * REQUIRED! This method dictates the table's columns and titles. This should + * return an array where the key is the column slug (and class) and the value + * is the column's title text. If you need a checkbox for bulk actions, refer + * to the $columns array below. + * + * The 'cb' column is treated differently than the rest. If including a checkbox + * column in your table you must create a column_cb() method. If you don't need + * bulk actions or checkboxes, simply leave the 'cb' entry out of your array. + * + * @see WP_List_Table::::single_row_columns() + * @return array An associative array containing column information: 'slugs'=>'Visible Titles' + **************************************************************************/ + function get_columns(){ + $columns = array( + 'cb' => '', //Render a checkbox instead of text + 'title' => 'Job Title', + 'category' => 'Category', + 'department' => 'Department' + ); + return $columns; + } + + + /** ************************************************************************ + * Optional. If you want one or more columns to be sortable (ASC/DESC toggle), + * you will need to register it here. This should return an array where the + * key is the column that needs to be sortable, and the value is db column to + * sort by. Often, the key and value will be the same, but this is not always + * the case (as the value is a column name from the database, not the list table). + * + * This method merely defines which columns should be sortable and makes them + * clickable - it does not handle the actual sorting. You still need to detect + * the ORDERBY and ORDER querystring variables within prepare_items() and sort + * your data accordingly (usually by modifying your query). + * + * @return array An associative array containing all the columns that should be sortable: 'slugs'=>array('data_values',bool) + **************************************************************************/ + function get_sortable_columns() { + $sortable_columns = array( + 'title' => array('title',false), //true means it's already sorted + 'category' => array('category',false), + 'department' => array('department',false) + ); + return $sortable_columns; + } + + + /** ************************************************************************ + * Optional. If you need to include bulk actions in your list table, this is + * the place to define them. Bulk actions are an associative array in the format + * 'slug'=>'Visible Title' + * + * If this method returns an empty value, no bulk action will be rendered. If + * you specify any bulk actions, the bulk actions box will be rendered with + * the table automatically on display(). + * + * Also note that list tables are not automatically wrapped in
elements, + * so you will need to create those manually in order for bulk actions to function. + * + * @return array An associative array containing all the bulk actions: 'slugs'=>'Visible Titles' + **************************************************************************/ + function get_bulk_actions() { + $actions = array( + 'delete' => 'Delete' + ); + return $actions; + } + + + /** ************************************************************************ + * Optional. You can handle your bulk actions anywhere or anyhow you prefer. + * For this example package, we will handle it in the class to keep things + * clean and organized. + * + * @see $this->prepare_items() + **************************************************************************/ + function process_bulk_action() { + + //Detect when a bulk action is being triggered... + if( 'delete'===$this->current_action() ) { + wp_die('Items deleted (or they would be if we had items to delete)!'); + } + + } + + + /** ************************************************************************ + * REQUIRED! This is where you prepare your data for display. This method will + * usually be used to query the database, sort and filter the data, and generally + * get it ready to be displayed. At a minimum, we should set $this->items and + * $this->set_pagination_args(), although the following properties and methods + * are frequently interacted with here... + * + * @global WPDB $wpdb + * @uses $this->_column_headers + * @uses $this->items + * @uses $this->get_columns() + * @uses $this->get_sortable_columns() + * @uses $this->get_pagenum() + * @uses $this->set_pagination_args() + **************************************************************************/ + function prepare_items() { + global $wpdb; //This is used only if making any database queries + + /** + * First, lets decide how many records per page to show + */ + $per_page = 5; + + + /** + * REQUIRED. Now we need to define our column headers. This includes a complete + * array of columns to be displayed (slugs & titles), a list of columns + * to keep hidden, and a list of columns that are sortable. Each of these + * can be defined in another method (as we've done here) before being + * used to build the value for our _column_headers property. + */ + $columns = $this->get_columns(); + $hidden = array(); + $sortable = $this->get_sortable_columns(); + + + /** + * REQUIRED. Finally, we build an array to be used by the class for column + * headers. The $this->_column_headers property takes an array which contains + * 3 other arrays. One for all columns, one for hidden columns, and one + * for sortable columns. + */ + $this->_column_headers = array($columns, $hidden, $sortable); + + + /** + * Optional. You can handle your bulk actions however you see fit. In this + * case, we'll handle them within our package just to keep things clean. + */ + $this->process_bulk_action(); + + + /** + * Instead of querying a database, we're going to fetch the example data + * property we created for use in this plugin. This makes this example + * package slightly different than one you might build on your own. In + * this example, we'll be using array manipulation to sort and paginate + * our data. In a real-world implementation, you will probably want to + * use sort and pagination data to build a custom query instead, as you'll + * be able to use your precisely-queried data immediately. + */ + $data = $this->example_data; + + + /** + * This checks for sorting input and sorts the data in our array accordingly. + * + * In a real-world situation involving a database, you would probably want + * to handle sorting by passing the 'orderby' and 'order' values directly + * to a custom query. The returned data will be pre-sorted, and this array + * sorting technique would be unnecessary. + */ + function usort_reorder($a,$b){ + $orderby = (!empty($_REQUEST['orderby'])) ? $_REQUEST['orderby'] : 'title'; //If no sort, default to title + $order = (!empty($_REQUEST['order'])) ? $_REQUEST['order'] : 'asc'; //If no order, default to asc + $result = strcmp($a[$orderby], $b[$orderby]); //Determine sort order + return ($order==='asc') ? $result : -$result; //Send final sort direction to usort + } + usort($data, 'usort_reorder'); + + + /*********************************************************************** + * --------------------------------------------------------------------- + * vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv + * + * In a real-world situation, this is where you would place your query. + * + * For information on making queries in WordPress, see this Codex entry: + * http://codex.wordpress.org/Class_Reference/wpdb + * + * ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + * --------------------------------------------------------------------- + **********************************************************************/ + + + /** + * REQUIRED for pagination. Let's figure out what page the user is currently + * looking at. We'll need this later, so you should always include it in + * your own package classes. + */ + $current_page = $this->get_pagenum(); + + /** + * REQUIRED for pagination. Let's check how many items are in our data array. + * In real-world use, this would be the total number of items in your database, + * without filtering. We'll need this later, so you should always include it + * in your own package classes. + */ + $total_items = count($data); + + + /** + * The WP_List_Table class does not handle pagination for us, so we need + * to ensure that the data is trimmed to only the current page. We can use + * array_slice() to + */ + $data = array_slice($data,(($current_page-1)*$per_page),$per_page); + + + + /** + * REQUIRED. Now we can add our *sorted* data to the items property, where + * it can be used by the rest of the class. + */ + $this->items = $data; + + + /** + * REQUIRED. We also have to register our pagination options & calculations. + */ + $this->set_pagination_args( array( + 'total_items' => $total_items, //WE have to calculate the total number of items + 'per_page' => $per_page, //WE have to determine how many items to show on a page + 'total_pages' => ceil($total_items/$per_page) //WE have to calculate the total number of pages + ) ); + } + + +} + -- 2.17.1