page = $page;
$args = wp_parse_args( $args, array(
'singular' => 'email-log', // singular name of the listed records
'plural' => 'email-logs', // plural name of the listed records
'ajax' => false, // does this table support ajax?
'screen' => $this->page->get_screen(),
) );
parent::__construct( $args );
add_action( 'admin_body_class', array( $this, 'add_body_class' ) );
add_action( 'el_display_log_columns', array( $this, 'display_column_data_in_log_list_table' ), 10, 2 );
add_action( 'el_view_log_after_headers', array( $this, 'add_headers_in_view_log_modal' ) );
add_filter( 'el_export_column_list', array( $this, 'add_columns_to_export_list' ) );
add_filter( 'el_export_raw_log', [ $this, 'add_columns_to_exported_raw_log' ] );
}
/**
* Adds extra markup in the toolbars before or after the list.
*
* @access protected
*
* @param string $which Add the markup after (bottom) or before (top) the list.
*/
protected function extra_tablenav( $which ) {
if ( 'top' == $which ) {
/**
* Triggered before the logs list table is displayed.
*
* @since 2.2.5
* @since 2.4.0 Added $total_logs parameter
*
* @param int $total_logs Total number of logs.
*/
do_action( 'el_before_logs_list_table', $this->get_pagination_arg( 'total_items' ) );
}
}
/**
* Returns the list of column and title names.
*
* @since 2.3.0 Retrieve Column labels using Utility methods.
* @since 2.3.2 Added `result` column.
* @since 2.4.0 Added `sent_status` column.
* @see WP_List_Table::single_row_columns()
*
* @uses \EmailLog\Util\get_column_label()
*
* @return array An associative array containing column information: 'slugs'=>'Visible Titles'.
*/
public function get_columns() {
$columns = array(
'cb' => '',
);
foreach ( array( 'sent_date', 'result', 'to_email', 'subject', 'cc', 'bcc', 'reply_to', 'attachments', 'ip_address' ) as $column ) {
$columns[ $column ] = Util\get_column_label( $column );
}
/**
* Filter the email log list table columns.
*
* @since 2.0.0
*
* @param array $columns Columns of email log list table.
*/
return apply_filters( 'el_manage_log_columns', $columns );
}
/**
* Returns the list of columns.
*
* @access protected
*
* @return array> An associative array containing all the columns
* that should be sortable: 'slugs'=>array('data_values',bool).
*/
protected function get_sortable_columns() {
$sortable_columns = array(
'sent_date' => array( 'sent_date', true ), // true means it's already sorted.
'to_email' => array( 'to_email', false ),
'subject' => array( 'subject', false ),
);
return $sortable_columns;
}
/**
* Returns value for default columns.
*
* @access protected
*
* @param object $item Data object.
* @param string $column_name Column Name.
*/
protected function column_default( $item, $column_name ) {
/**
* Display Email Log list table columns.
*
* @since 2.0
*
* @param string $column_name Column Name.
* @param object $item Data object.
*/
do_action( 'el_display_log_columns', $column_name, $item );
}
/**
* Display sent date column.
*
* @access protected
*
* @param object $item Current item object.
*
* @return string Markup to be displayed for the column.
*/
protected function column_sent_date( $item ) {
$email_date = mysql2date(
sprintf(
/* translators: 1 Date of the log, 2 Time of the log */
__( '%1$s @ %2$s', 'email-log' ),
get_option( 'date_format', 'F j, Y' ),
get_display_format_for_log_time()
),
$item->sent_date
);
$actions = array();
$content_ajax_url = add_query_arg(
array(
'action' => 'el-log-list-view-message',
'log_id' => $item->id,
'width' => '800',
'height' => '550',
),
'admin-ajax.php'
);
$actions['view-content'] = sprintf( '%3$s',
esc_url( $content_ajax_url ),
__( 'Email Content', 'email-log' ),
__( 'View Content', 'email-log' )
);
$delete_url = add_query_arg(
array(
'page' => sanitize_text_field( wp_unslash( $_REQUEST['page'] ?? '')), //phpcs:ignore
'action' => 'el-log-list-delete',
$this->_args['singular'] => $item->id,
)
);
$delete_url = add_query_arg( $this->page->get_nonce_args(), $delete_url );
$actions['delete'] = sprintf( '%s',
esc_url( $delete_url ),
__( 'Delete', 'email-log' )
);
/**
* This filter can be used to modify the list of row actions that are displayed.
*
* @since 1.8
*
* @param array $actions List of actions.
* @param object $item The current log item.
*/
$actions = apply_filters( 'el_row_actions', $actions, $item );
return sprintf( '%1$s (id:%2$s)%3$s',
/*$1%s*/ $email_date,
/*$2%s*/ $item->id,
/*$3%s*/ $this->row_actions( $actions )
);
}
/**
* To field.
*
* @access protected
*
* @param object $item
*
* @return string
*/
protected function column_to_email( $item ) {
/**
* Filters the `To` field before outputting on the table.
*
* @since 2.3.0
*
* @param string $email `To` field
*/
$email = apply_filters( 'el_log_list_column_to_email', esc_html( $item->to_email ) );
return $email;
}
/**
* Subject field.
*
* @access protected
*
* @param object $item
*
* @return string
*/
protected function column_subject( $item ) {
return esc_html( $item->subject );
}
/**
* Markup for action column.
*
* @access protected
*
* @param object $item
*
* @return string
*/
protected function column_cb( $item ) {
return sprintf(
'',
/*$1%s*/ $this->_args['singular'],
/*$2%s*/ $item->id
);
}
/**
* Markup for Status column.
*
* @since 2.3.2
* @since 2.4.0 Output the error message as tooltip.
*
* @param object $item Email Log item.
*
* @return string Column markup.
*/
protected function column_result( $item ) {
// For older records that does not have value in the result column,
// $item->result will be null.
if ( is_null( $item->result ) ) {
return '';
}
$icon = \EmailLog\Util\get_failure_icon();
if ( $item->result ) {
$icon = \EmailLog\Util\get_success_icon();
}
if ( ! isset( $item->error_message ) ) {
return $icon;
}
return sprintf(
'%1$s',
$icon,
esc_attr( $item->error_message ),
'el-help'
);
}
/**
* Specify the list of bulk actions.
*
* @access protected
*
* @return array An associative array containing all the bulk actions: 'slugs'=>'Visible Titles'.
*/
protected function get_bulk_actions() {
$actions = array(
'el-log-list-delete' => __( 'Delete', 'email-log' ),
'el-log-list-delete-all' => __( 'Delete All Logs', 'email-log' ),
'el-log-export' => __( 'Export - PRO', 'email-log' ),
'el-log-export-all' => __( 'Export All Logs - PRO', 'email-log' ),
'el-log-resend' => __( 'Resend - PRO', 'email-log' ),
'el-log-resend-all' => __( 'Resend All Logs - PRO', 'email-log' ),
);
$actions = apply_filters( 'el_bulk_actions', $actions );
return $actions;
}
/**
* Prepare data for display.
*/
public function prepare_items() {
$this->_column_headers = $this->get_column_info();
// Get current page number.
$current_page_no = $this->get_pagenum();
$per_page = $this->page->get_per_page();
//phpcs:ignore as $_GET is processed in fetch_log_items
list( $items, $total_items ) = $this->page->get_table_manager()->fetch_log_items( $_GET, $per_page, $current_page_no ); //phpcs:ignore
$this->items = $items;
// Register pagination options & calculations.
$this->set_pagination_args( array(
'total_items' => $total_items,
'per_page' => $per_page,
'total_pages' => ceil( $total_items / $per_page ),
) );
}
/**
* Displays default message when no items are found.
*/
public function no_items() {
esc_html_e( 'Your email log is empty', 'email-log' );
}
/**
* Displays the search box.
*
* @since 2.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 ) {
//phpcs:ignore nonce not needed as can be linked to directly
$input_text_id = $input_id . '-search-input';
$input_date_id = $input_id . '-search-date-input';
$input_date_val = ( ! empty( $_REQUEST['d'] ) ) ? sanitize_text_field( wp_unslash($_REQUEST['d']) ) : ''; //phpcs:ignore
if ( ! empty( $_REQUEST['orderby'] ) ) //phpcs:ignore
echo ''; //phpcs:ignore
if ( ! empty( $_REQUEST['order'] ) ) //phpcs:ignore
echo ''; //phpcs:ignore
if ( ! empty( $_REQUEST['post_mime_type'] ) ) //phpcs:ignore
echo ''; //phpcs:ignore
if ( ! empty( $_REQUEST['detached'] ) ) //phpcs:ignore
echo ''; //phpcs:ignore
?>
'search-submit' ) ); ?>
get_columns() ) );
}
/**
* Display content for additional columns
*
* @param string $column_name Column Name.
* @param object $item Data object.
*/
public function display_column_data_in_log_list_table( $column_name, $item ) {
if ( ! isset( $this->parsed_headers[ $item->id ] ) ) {
$parser = new EmailHeaderParser();
$this->parsed_headers[ $item->id ] = $parser->parse_headers( $item->headers );
}
$header = $this->parsed_headers[ $item->id ];
switch ( $column_name ) {
case 'cc':
echo 'PRO';
break;
case 'bcc':
echo 'PRO';
break;
case 'reply_to':
echo 'PRO';
break;
case 'attachments':
echo 'PRO';
break;
case 'ip_address':
echo 'PRO';
break;
}
}
/**
* Adds additional column values to the log item that is getting exported to CSV.
*
* @param array $raw_log The raw log item.
*
* @return array The raw log with additional columns.
*/
public function add_columns_to_exported_raw_log( $raw_log ) {
$raw_headers = '';
if ( isset( $raw_log[ 'headers' ] ) ) {
$raw_headers = $raw_log['headers'];
}
$parser = new EmailHeaderParser();
$header = $parser->parse_headers( $raw_headers );
$raw_log['from'] = ( isset( $header['from'] ) ? esc_attr( $header['from'] ) : '' );
$raw_log['cc'] = ( isset( $header['cc'] ) ? esc_attr( $header['cc'] ) : '' );
$raw_log['bcc'] = ( isset( $header['bcc'] ) ? esc_attr( $header['bcc'] ) : '' );
$raw_log['reply-to'] = ( isset( $header['reply-to'] ) ? esc_attr( $header['reply-to'] ) : '' );
$raw_log['attachments'] = 'true' === $raw_log['attachments'] ? 'Yes' : 'No';
return $raw_log;
}
/**
* Add additional headers to view message in thickbox.
*
* @since 2.0.0
*
* @param array $log_item Log item that is getting displayed.
*/
public function add_headers_in_view_log_modal( $log_item ) {
$parser = new EmailHeaderParser();
$headers = $parser->parse_headers( $log_item['headers'] );
$columns = $this->get_columns();
foreach ( $columns as $key => $column ) {
if ( ! empty( $headers[ $key ] ) ) {
?>
tag in the Admin end.
*
* @since 2.1.0
*
* @param string $classes Body classes.
*
* @return string Modified body classes.
*/
public function add_body_class( $classes ) {
return "$classes more-fields-addon";
}
}