Hook up the remainder of the sales record message. There can only be one.

This commit is contained in:
Allen Snook 2018-10-18 15:52:55 -07:00
parent d05a1c63ff
commit 04b33f9e6b
3 changed files with 65 additions and 23 deletions

View File

@ -13,14 +13,14 @@ defined( 'ABSPATH' ) || exit;
* WC_Admin_Notes_New_Sales_Record * WC_Admin_Notes_New_Sales_Record
*/ */
class WC_Admin_Notes_New_Sales_Record { class WC_Admin_Notes_New_Sales_Record {
const RECORD_DATE_OPTION_KEY = 'woocommerce_sales_record_date'; // YYYY-MM-DD. const RECORD_DATE_OPTION_KEY = 'woocommerce_sales_record_date'; // ISO 8601 (YYYY-MM-DD) date.
const RECORD_AMOUNT_OPTION_KEY = 'woocommerce_sales_record_amount'; const RECORD_AMOUNT_OPTION_KEY = 'woocommerce_sales_record_amount';
/** /**
* Sales Record constructor. * Sales Record constructor.
*/ */
public function __construct() { public function __construct() {
add_action( 'admin_footer', array( $this, 'sum_yesterdays_sales' ) ); add_action( 'admin_footer', array( $this, 'possibly_add_sales_record_note' ) );
} }
/** /**
@ -49,32 +49,32 @@ class WC_Admin_Notes_New_Sales_Record {
$total = $this->sum_sales_for_date( $yesterday ); $total = $this->sum_sales_for_date( $yesterday );
// No sales yesterday? Bail. // No sales yesterday? Bail.
if ( 0 <= $total ) { if ( 0 >= $total ) {
return; return;
} }
$record_date = get_option( RECORD_DATE_OPTION_KEY, '' ); $record_date = get_option( self::RECORD_DATE_OPTION_KEY, '' );
$record_amt = floatval( get_option( RECORD_AMOUNT_OPTION_KEY, 0 ) ); $record_amt = floatval( get_option( self::RECORD_AMOUNT_OPTION_KEY, 0 ) );
// No previous entry? Just enter what we have and return without generating a note. // No previous entry? Just enter what we have and return without generating a note.
if ( empty( $record_date ) ) { if ( empty( $record_date ) ) {
update_option( RECORD_DATE_OPTION_KEY, $yesterday ); update_option( self::RECORD_DATE_OPTION_KEY, $yesterday );
update_option( RECORD_AMOUNT_OPTION_KEY, $total ); update_option( self::RECORD_AMOUNT_OPTION_KEY, $total );
return; return;
} }
// Otherwise, if yesterdays total bested the record, update AND generate a note. // Otherwise, if yesterdays total bested the record, update AND generate a note.
if ( $total > $record_amt ) { if ( $total > $record_amt ) {
update_option( RECORD_DATE_OPTION_KEY, $yesterday ); update_option( self::RECORD_DATE_OPTION_KEY, $yesterday );
update_option( RECORD_AMOUNT_OPTION_KEY, $total ); update_option( self::RECORD_AMOUNT_OPTION_KEY, $total );
$formatted_yesterday = 'October 16th'; $formatted_yesterday = date( 'F jS', strtotime( $yesterday ) );
$formatted_total = '$160.00'; $formatted_total = html_entity_decode( strip_tags( wc_price( $total ) ) );
$formatted_record_date = 'May 23rd'; $formatted_record_date = date( 'F jS', strtotime( $record_date ) );
$formatted_record_amt = '$100.00'; $formatted_record_amt = html_entity_decode( strip_tags( wc_price( $record_amt ) ) );
$note_content = sprintf( $content = sprintf(
/* translators: */ /* translators: 1 and 4: Date (e.g. October 16th), 2 and 3: Amount (e.g. $160.00) */
__( 'Woohoo, %1$s was your record day for sales! Net revenue was %2$s beating the previous record of %3$s set on %4$s.', 'wc-admin' ), __( 'Woohoo, %1$s was your record day for sales! Net revenue was %2$s beating the previous record of %3$s set on %4$s.', 'wc-admin' ),
$formatted_yesterday, $formatted_yesterday,
$formatted_total, $formatted_total,
@ -82,16 +82,27 @@ class WC_Admin_Notes_New_Sales_Record {
$formatted_record_date $formatted_record_date
); );
// TODO: Delete any pre-existing notes named wc-admin-new-sales-record. $content_data = (object) array(
'old_record_date' => $record_date,
'old_record_amt' => $record_amt,
'new_record_date' => $yesterday,
'new_record_amt' => $total,
);
$name = 'wc-admin-new-sales-record';
// We only want one sales record note at any time in the inbox, so we delete any other first.
WC_Admin_Notes::delete_notes_with_name( $name );
// And now, create our new note.
$note = new WC_Admin_Note(); $note = new WC_Admin_Note();
$note->set_title( __( 'New sales record!', 'wc-admin' ) ); $note->set_title( __( 'New sales record!', 'wc-admin' ) );
$note->set_content( $note_content ); $note->set_content( $content );
$note->set_content_data( '{}' ); $note->set_content_data( $content_data );
$note->set_type( WC_Admin_Note::E_WC_ADMIN_NOTE_INFORMATIONAL ); $note->set_type( WC_Admin_Note::E_WC_ADMIN_NOTE_INFORMATIONAL );
$note->set_icon( 'trophy' ); $note->set_icon( 'trophy' );
$note->set_name( 'wc-admin-new-sales-record' ); $note->set_name( $name );
$note->set_source( 'wc-admin' ); $note->set_source( 'wc-admin' );
$note->add_action( 'view-report', __( 'View report', 'wc-admin' ), '' ); $note->add_action( 'view-report', __( 'View report', 'wc-admin' ), '?page=wc-admin#/analytics' );
$note->save(); $note->save();
} }
} }

View File

@ -69,4 +69,19 @@ class WC_Admin_Notes {
$data_store = WC_Data_Store::load( 'admin-note' ); $data_store = WC_Data_Store::load( 'admin-note' );
return $data_store->get_notes_count(); return $data_store->get_notes_count();
} }
/**
* Deletes admin notes with a given name.
*
* @param string $name Name to search for.
*/
public static function delete_notes_with_name( $name ) {
$data_store = WC_Data_Store::load( 'admin-note' );
$note_ids = $data_store->get_notes_with_name( $name );
foreach ( (array) $note_ids as $note_id ) {
$note = new WC_Admin_Note( $note_id );
$note->set_id( $note_id );
$note->delete();
}
}
} }

View File

@ -135,13 +135,13 @@ class WC_Admin_Notes_Data_Store extends WC_Data_Store_WP implements WC_Object_Da
*/ */
public function delete( &$note, $args = array() ) { public function delete( &$note, $args = array() ) {
$note_id = $note->get_id(); $note_id = $note->get_id();
if ( $note->get_id() ) { if ( $note_id ) {
global $wpdb; global $wpdb;
$wpdb->delete( $wpdb->prefix . 'woocommerce_admin_notes', array( 'note_id' => $note_id ) ); $wpdb->delete( $wpdb->prefix . 'woocommerce_admin_notes', array( 'note_id' => $note_id ) );
$wpdb->delete( $wpdb->prefix . 'woocommerce_admin_note_actions', array( 'note_id' => $note_id ) ); $wpdb->delete( $wpdb->prefix . 'woocommerce_admin_note_actions', array( 'note_id' => $note_id ) );
$note->set_id( null ); $note->set_id( null );
} }
do_action( 'woocommerce_trash_note', $id ); do_action( 'woocommerce_trash_note', $note_id );
} }
/** /**
@ -242,4 +242,20 @@ class WC_Admin_Notes_Data_Store extends WC_Data_Store_WP implements WC_Object_Da
return $wpdb->get_var( $query ); // phpcs:ignore WordPress.WP.PreparedSQL.NotPrepared return $wpdb->get_var( $query ); // phpcs:ignore WordPress.WP.PreparedSQL.NotPrepared
} }
/**
* Find all the notes with a given name.
*
* @param string $name Name to search for.
* @return array An array of matching note ids.
*/
public function get_notes_with_name( $name ) {
global $wpdb;
return $wpdb->get_col(
$wpdb->prepare(
"SELECT note_id FROM {$wpdb->prefix}woocommerce_admin_notes WHERE name = %s ORDER BY note_id ASC;",
$name
)
);
}
} }