diff options
Diffstat (limited to 'Postman/Postman-Email-Log/PostmanEmailLogView.php')
| -rw-r--r-- | Postman/Postman-Email-Log/PostmanEmailLogView.php | 419 |
1 files changed, 419 insertions, 0 deletions
diff --git a/Postman/Postman-Email-Log/PostmanEmailLogView.php b/Postman/Postman-Email-Log/PostmanEmailLogView.php new file mode 100644 index 0000000..ef06a29 --- /dev/null +++ b/Postman/Postman-Email-Log/PostmanEmailLogView.php @@ -0,0 +1,419 @@ +<?php + +/** + * See http://wpengineer.com/2426/wp_list_table-a-step-by-step-guide/ + * + */ +if (! class_exists ( 'WP_List_Table' )) { + require_once (ABSPATH . 'wp-admin/includes/class-wp-list-table.php'); +} +class PostmanEmailLogView extends WP_List_Table { + private $logger; + + /** + * ************************************************************************ + * REQUIRED. + * Set up a constructor that references the parent constructor. We + * use the parent reference to set some default configs. + * ************************************************************************* + */ + function __construct() { + $this->logger = new PostmanLogger ( get_class ( $this ) ); + + // Set parent defaults + parent::__construct ( array ( + 'singular' => 'email_log_entry', // singular name of the listed records + 'plural' => 'email_log_entries', // 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 <td> + * ************************************************************************ + */ + function column_default($item, $column_name) { + switch ($column_name) { + case 'date' : + case 'status' : + 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 <td> (movie title only) + * ************************************************************************ + */ + function column_title($item) { + + // Build row actions + $iframeUri = 'admin-post.php?page=postman_email_log&action=%s&email=%s&TB_iframe=true&width=700&height=550'; + $deleteUrl = wp_nonce_url ( admin_url ( sprintf ( 'admin-post.php?page=postman_email_log&action=%s&email=%s', 'delete', $item ['ID'] ) ), 'delete_email_log_item_' . $item ['ID'] ); + $viewUrl = admin_url ( sprintf ( $iframeUri, 'view', $item ['ID'] ) ); + $transcriptUrl = admin_url ( sprintf ( $iframeUri, 'transcript', $item ['ID'] ) ); + $resendUrl = admin_url ( sprintf ( $iframeUri, 'resend', $item ['ID'] ) ); + + $meta_values = get_post_meta ( $item ['ID'] ); + + $actions = array ( + 'delete' => sprintf ( '<a href="%s">%s</a>', $deleteUrl, _x ( 'Delete', 'Delete an item from the email log', Postman::TEXT_DOMAIN ) ), + 'view' => sprintf ( '<a href="%s" class="thickbox">%s</a>', $viewUrl, _x ( 'View', 'View an item from the email log', Postman::TEXT_DOMAIN ) ) + ); + + if (! empty ( $meta_values ['session_transcript'] [0] )) { + $actions ['transcript'] = sprintf ( '<a href="%1$s" class="thickbox">%2$s</a>', $transcriptUrl, __ ( 'Session Transcript', Postman::TEXT_DOMAIN ) ); + } else { + $actions ['transcript'] = sprintf ( '%2$s', $transcriptUrl, __ ( 'Session Transcript', Postman::TEXT_DOMAIN ) ); + } + if (! (empty ( $meta_values ['original_to'] [0] ) && empty ( $meta_values ['originalHeaders'] [0] ))) { + // $actions ['resend'] = sprintf ( '<a href="%s">%s</a>', $resendUrl, __ ( 'Resend', Postman::TEXT_DOMAIN ) ); + $actions ['resend'] = sprintf ( '<span id="%3$s"><a href="javascript:postman_resend_email(%1$s);">%2$s</a></span>', $item ['ID'], __ ( 'Resend', Postman::TEXT_DOMAIN ), 'resend-' . $item ['ID'] ); + } else { + $actions ['resend'] = sprintf ( '%2$s', $resendUrl, __ ( 'Resend', Postman::TEXT_DOMAIN ) ); + } + + // Return the title contents + return sprintf ( '%1$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 <td> (movie title only) + * ************************************************************************ + */ + function column_cb($item) { + return sprintf ( '<input type="checkbox" name="%1$s[]" value="%2$s" />', + /*$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' => '<input type="checkbox" />', // Render a checkbox instead of text + 'title' => _x ( 'Subject', 'What is the subject of this message?', Postman::TEXT_DOMAIN ), + 'status' => __ ( 'Status', Postman::TEXT_DOMAIN ), + 'date' => _x ( 'Delivery Time', 'When was this email sent?', Postman::TEXT_DOMAIN ) + ); + 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() { + return array (); + $sortable_columns = array ( + 'title' => array ( + 'title', + false + ), // true means it's already sorted + 'status' => array ( + 'status', + false + ), + 'date' => array ( + 'date', + 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 <form> 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 ( + 'bulk_delete' => _x ( 'Delete', 'Delete an item from the email log', Postman::TEXT_DOMAIN ) + ); + 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() { + } + + /** + * ************************************************************************ + * 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() { + + /** + * First, lets decide how many records per page to show + */ + $per_page = 10; + + /** + * 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 = array (); + $args = array ( + 'posts_per_page' => 1000, + 'offset' => 0, + 'category' => '', + 'category_name' => '', + 'orderby' => 'date', + 'order' => 'DESC', + 'include' => '', + 'exclude' => '', + 'meta_key' => '', + 'meta_value' => '', + 'post_type' => PostmanEmailLogPostType::POSTMAN_CUSTOM_POST_TYPE_SLUG, + 'post_mime_type' => '', + 'post_parent' => '', + 'post_status' => 'private', + 'suppress_filters' => true + ); + $posts = get_posts ( $args ); + foreach ( $posts as $post ) { + $date = $post->post_date; + $humanTime = human_time_diff ( strtotime ( $post->post_date_gmt ) ); + // if this PHP system support humanTime, than use it + if (! empty ( $humanTime )) { + /* Translators: where %s indicates the relative time from now */ + $date = sprintf ( _x ( '%s ago', 'A relative time as in "five days ago"', Postman::TEXT_DOMAIN ), $humanTime ); + } + $flattenedPost = array ( + // the post title must be escaped as they are displayed in the HTML output + 'title' => esc_html ( $post->post_title ), + // the post status must be escaped as they are displayed in the HTML output + 'status' => ($post->post_excerpt != null ? esc_html ( $post->post_excerpt ) : __ ( 'Sent', Postman::TEXT_DOMAIN )), + 'date' => $date, + 'ID' => $post->ID + ); + array_push ( $data, $flattenedPost ); + } + + /** + * 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 + } +} + |