<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WooCommerce Admin (Dashboard) Order Milestones Note Provider.

[2] Fix | Delete

*

[3] Fix | Delete

* Adds a note to the merchant's inbox when certain order milestones are reached.

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

namespace Automattic\WooCommerce\Internal\Admin\Notes;

[7] Fix | Delete

[8] Fix | Delete

defined( 'ABSPATH' ) || exit;

[9] Fix | Delete

[10] Fix | Delete

use Automattic\WooCommerce\Admin\Notes\Note;

[11] Fix | Delete

use Automattic\WooCommerce\Admin\Notes\Notes;

[12] Fix | Delete

/**

[13] Fix | Delete

* Order_Milestones

[14] Fix | Delete

*/

[15] Fix | Delete

class OrderMilestones {

[16] Fix | Delete

/**

[17] Fix | Delete

* Name of the "other milestones" note.

[18] Fix | Delete

*/

[19] Fix | Delete

const NOTE_NAME = 'wc-admin-orders-milestone';

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Option key name to store last order milestone.

[23] Fix | Delete

*/

[24] Fix | Delete

const LAST_ORDER_MILESTONE_OPTION_KEY = 'woocommerce_admin_last_orders_milestone';

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Hook to process order milestones.

[28] Fix | Delete

*/

[29] Fix | Delete

const PROCESS_ORDERS_MILESTONE_HOOK = 'wc_admin_process_orders_milestone';

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Allowed order statuses for calculating milestones.

[33] Fix | Delete

*

[34] Fix | Delete

* @var array

[35] Fix | Delete

*/

[36] Fix | Delete

protected $allowed_statuses = array(

[37] Fix | Delete

'pending',

[38] Fix | Delete

'processing',

[39] Fix | Delete

'completed',

[40] Fix | Delete

);

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Orders count cache.

[44] Fix | Delete

*

[45] Fix | Delete

* @var int

[46] Fix | Delete

*/

[47] Fix | Delete

protected $orders_count = null;

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Further order milestone thresholds.

[51] Fix | Delete

*

[52] Fix | Delete

* @var array

[53] Fix | Delete

*/

[54] Fix | Delete

protected $milestones = array(

[55] Fix | Delete

1,

[56] Fix | Delete

10,

[57] Fix | Delete

100,

[58] Fix | Delete

250,

[59] Fix | Delete

500,

[60] Fix | Delete

1000,

[61] Fix | Delete

5000,

[62] Fix | Delete

10000,

[63] Fix | Delete

500000,

[64] Fix | Delete

1000000,

[65] Fix | Delete

);

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Delay hook attachment until after the WC post types have been registered.

[69] Fix | Delete

*

[70] Fix | Delete

* This is required for retrieving the order count.

[71] Fix | Delete

*/

[72] Fix | Delete

public function __construct() {

[73] Fix | Delete

/**

[74] Fix | Delete

* Filter Order statuses that will count towards milestones.

[75] Fix | Delete

*

[76] Fix | Delete

* @since 3.5.0

[77] Fix | Delete

*

[78] Fix | Delete

* @param array $allowed_statuses Order statuses that will count towards milestones.

[79] Fix | Delete

*/

[80] Fix | Delete

$this->allowed_statuses = apply_filters( 'woocommerce_admin_order_milestone_statuses', $this->allowed_statuses );

[81] Fix | Delete

[82] Fix | Delete

add_action( 'woocommerce_after_register_post_type', array( $this, 'init' ) );

[83] Fix | Delete

register_deactivation_hook( WC_PLUGIN_FILE, array( $this, 'clear_scheduled_event' ) );

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

/**

[87] Fix | Delete

* Hook everything up.

[88] Fix | Delete

*/

[89] Fix | Delete

public function init() {

[90] Fix | Delete

if ( ! wp_next_scheduled( self::PROCESS_ORDERS_MILESTONE_HOOK ) ) {

[91] Fix | Delete

wp_schedule_event( time(), 'hourly', self::PROCESS_ORDERS_MILESTONE_HOOK );

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

add_action( 'wc_admin_installed', array( $this, 'backfill_last_milestone' ) );

[95] Fix | Delete

[96] Fix | Delete

add_action( self::PROCESS_ORDERS_MILESTONE_HOOK, array( $this, 'possibly_add_note' ) );

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Clear out our hourly milestone hook upon plugin deactivation.

[101] Fix | Delete

*/

[102] Fix | Delete

public function clear_scheduled_event() {

[103] Fix | Delete

wp_clear_scheduled_hook( self::PROCESS_ORDERS_MILESTONE_HOOK );

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Get the total count of orders (in the allowed statuses).

[108] Fix | Delete

*

[109] Fix | Delete

* @param bool $no_cache Optional. Skip cache.

[110] Fix | Delete

* @return int Total orders count.

[111] Fix | Delete

*/

[112] Fix | Delete

public function get_orders_count( $no_cache = false ) {

[113] Fix | Delete

if ( $no_cache || is_null( $this->orders_count ) ) {

[114] Fix | Delete

$status_counts = array_map( 'wc_orders_count', $this->allowed_statuses );

[115] Fix | Delete

$this->orders_count = array_sum( $status_counts );

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

return $this->orders_count;

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

/**

[122] Fix | Delete

* Backfill the store's current milestone.

[123] Fix | Delete

*

[124] Fix | Delete

* Used to avoid celebrating milestones that were reached before plugin activation.

[125] Fix | Delete

*/

[126] Fix | Delete

public function backfill_last_milestone() {

[127] Fix | Delete

// If the milestone notes have been disabled via filter, bail.

[128] Fix | Delete

if ( ! $this->are_milestones_enabled() ) {

[129] Fix | Delete

return;

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

$this->set_last_milestone( $this->get_current_milestone() );

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

/**

[136] Fix | Delete

* Get the store's last milestone.

[137] Fix | Delete

*

[138] Fix | Delete

* @return int Last milestone reached.

[139] Fix | Delete

*/

[140] Fix | Delete

public function get_last_milestone() {

[141] Fix | Delete

return get_option( self::LAST_ORDER_MILESTONE_OPTION_KEY, 0 );

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

/**

[145] Fix | Delete

* Update the last reached milestone.

[146] Fix | Delete

*

[147] Fix | Delete

* @param int $milestone Last milestone reached.

[148] Fix | Delete

*/

[149] Fix | Delete

public function set_last_milestone( $milestone ) {

[150] Fix | Delete

update_option( self::LAST_ORDER_MILESTONE_OPTION_KEY, $milestone );

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

/**

[154] Fix | Delete

* Calculate the current orders milestone.

[155] Fix | Delete

*

[156] Fix | Delete

* Based on the threshold values in $this->milestones.

[157] Fix | Delete

*

[158] Fix | Delete

* @return int Current orders milestone.

[159] Fix | Delete

*/

[160] Fix | Delete

public function get_current_milestone() {

[161] Fix | Delete

$milestone_reached = 0;

[162] Fix | Delete

$orders_count = $this->get_orders_count();

[163] Fix | Delete

[164] Fix | Delete

foreach ( $this->milestones as $milestone ) {

[165] Fix | Delete

if ( $milestone <= $orders_count ) {

[166] Fix | Delete

$milestone_reached = $milestone;

[167] Fix | Delete

}

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

return $milestone_reached;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Get the appropriate note title for a given milestone.

[175] Fix | Delete

*

[176] Fix | Delete

* @param int $milestone Order milestone.

[177] Fix | Delete

* @return string Note title for the milestone.

[178] Fix | Delete

*/

[179] Fix | Delete

public static function get_note_title_for_milestone( $milestone ) {

[180] Fix | Delete

switch ( $milestone ) {

[181] Fix | Delete

case 1:

[182] Fix | Delete

return __( 'First order received', 'woocommerce' );

[183] Fix | Delete

case 10:

[184] Fix | Delete

case 100:

[185] Fix | Delete

case 250:

[186] Fix | Delete

case 500:

[187] Fix | Delete

case 1000:

[188] Fix | Delete

case 5000:

[189] Fix | Delete

case 10000:

[190] Fix | Delete

case 500000:

[191] Fix | Delete

case 1000000:

[192] Fix | Delete

return sprintf(

[193] Fix | Delete

/* translators: Number of orders processed. */

[194] Fix | Delete

__( 'Congratulations on processing %s orders!', 'woocommerce' ),

[195] Fix | Delete

wc_format_decimal( $milestone )

[196] Fix | Delete

);

[197] Fix | Delete

default:

[198] Fix | Delete

return '';

[199] Fix | Delete

}

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

/**

[203] Fix | Delete

* Get the appropriate note content for a given milestone.

[204] Fix | Delete

*

[205] Fix | Delete

* @param int $milestone Order milestone.

[206] Fix | Delete

* @return string Note content for the milestone.

[207] Fix | Delete

*/

[208] Fix | Delete

public static function get_note_content_for_milestone( $milestone ) {

[209] Fix | Delete

switch ( $milestone ) {

[210] Fix | Delete

case 1:

[211] Fix | Delete

return __( 'Congratulations on getting your first order! Now is a great time to learn how to manage your orders.', 'woocommerce' );

[212] Fix | Delete

case 10:

[213] Fix | Delete

return __( "You've hit the 10 orders milestone! Look at you go. Browse some WooCommerce success stories for inspiration.", 'woocommerce' );

[214] Fix | Delete

case 100:

[215] Fix | Delete

case 250:

[216] Fix | Delete

case 500:

[217] Fix | Delete

case 1000:

[218] Fix | Delete

case 5000:

[219] Fix | Delete

case 10000:

[220] Fix | Delete

case 500000:

[221] Fix | Delete

case 1000000:

[222] Fix | Delete

return __( 'Another order milestone! Take a look at your Orders Report to review your orders to date.', 'woocommerce' );

[223] Fix | Delete

default:

[224] Fix | Delete

return '';

[225] Fix | Delete

}

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

/**

[229] Fix | Delete

* Get the appropriate note action for a given milestone.

[230] Fix | Delete

*

[231] Fix | Delete

* @param int $milestone Order milestone.

[232] Fix | Delete

* @return array Note actoion (name, label, query) for the milestone.

[233] Fix | Delete

*/

[234] Fix | Delete

public static function get_note_action_for_milestone( $milestone ) {

[235] Fix | Delete

switch ( $milestone ) {

[236] Fix | Delete

case 1:

[237] Fix | Delete

return array(

[238] Fix | Delete

'name' => 'learn-more',

[239] Fix | Delete

'label' => __( 'Learn more', 'woocommerce' ),

[240] Fix | Delete

'query' => 'https://woocommerce.com/document/managing-orders/?utm_source=inbox&utm_medium=product',

[241] Fix | Delete

);

[242] Fix | Delete

case 10:

[243] Fix | Delete

return array(

[244] Fix | Delete

'name' => 'browse',

[245] Fix | Delete

'label' => __( 'Browse', 'woocommerce' ),

[246] Fix | Delete

'query' => 'https://woocommerce.com/success-stories/?utm_source=inbox&utm_medium=product',

[247] Fix | Delete

);

[248] Fix | Delete

case 100:

[249] Fix | Delete

case 250:

[250] Fix | Delete

case 500:

[251] Fix | Delete

case 1000:

[252] Fix | Delete

case 5000:

[253] Fix | Delete

case 10000:

[254] Fix | Delete

case 500000:

[255] Fix | Delete

case 1000000:

[256] Fix | Delete

return array(

[257] Fix | Delete

'name' => 'review-orders',

[258] Fix | Delete

'label' => __( 'Review your orders', 'woocommerce' ),

[259] Fix | Delete

'query' => '?page=wc-admin&path=/analytics/orders',

[260] Fix | Delete

);

[261] Fix | Delete

default:

[262] Fix | Delete

return array(

[263] Fix | Delete

'name' => '',

[264] Fix | Delete

'label' => '',

[265] Fix | Delete

'query' => '',

[266] Fix | Delete

);

[267] Fix | Delete

}

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

/**

[271] Fix | Delete

* Convenience method to see if the milestone notes are enabled.

[272] Fix | Delete

*

[273] Fix | Delete

* @return boolean True if milestone notifications are enabled.

[274] Fix | Delete

*/

[275] Fix | Delete

public function are_milestones_enabled() {

[276] Fix | Delete

/**

[277] Fix | Delete

* Filter to allow for disabling order milestones.

[278] Fix | Delete

*

[279] Fix | Delete

* @since 3.7.0

[280] Fix | Delete

*

[281] Fix | Delete

* @param boolean default true

[282] Fix | Delete

*/

[283] Fix | Delete

$milestone_notes_enabled = apply_filters( 'woocommerce_admin_order_milestones_enabled', true );

[284] Fix | Delete

[285] Fix | Delete

return $milestone_notes_enabled;

[286] Fix | Delete

}

[287] Fix | Delete

[288] Fix | Delete

/**

[289] Fix | Delete

* Get the note. This is used for localizing the note.

[290] Fix | Delete

*

[291] Fix | Delete

* @return Note

[292] Fix | Delete

*/

[293] Fix | Delete

public static function get_note() {

[294] Fix | Delete

$note = Notes::get_note_by_name( self::NOTE_NAME );

[295] Fix | Delete

if ( ! $note ) {

[296] Fix | Delete

return false;

[297] Fix | Delete

}

[298] Fix | Delete

$content_data = $note->get_content_data();

[299] Fix | Delete

if ( ! isset( $content_data->current_milestone ) ) {

[300] Fix | Delete

return false;

[301] Fix | Delete

}

[302] Fix | Delete

return self::get_note_by_milestone(

[303] Fix | Delete

$content_data->current_milestone

[304] Fix | Delete

);

[305] Fix | Delete

}

[306] Fix | Delete

[307] Fix | Delete

/**

[308] Fix | Delete

* Get the note by milestones.

[309] Fix | Delete

*

[310] Fix | Delete

* @param int $current_milestone Current milestone.

[311] Fix | Delete

*

[312] Fix | Delete

* @return Note

[313] Fix | Delete

*/

[314] Fix | Delete

public static function get_note_by_milestone( $current_milestone ) {

[315] Fix | Delete

$content_data = (object) array(

[316] Fix | Delete

'current_milestone' => $current_milestone,

[317] Fix | Delete

);

[318] Fix | Delete

[319] Fix | Delete

$note = new Note();

[320] Fix | Delete

$note->set_title( self::get_note_title_for_milestone( $current_milestone ) );

[321] Fix | Delete

$note->set_content( self::get_note_content_for_milestone( $current_milestone ) );

[322] Fix | Delete

$note->set_content_data( $content_data );

[323] Fix | Delete

$note->set_type( Note::E_WC_ADMIN_NOTE_INFORMATIONAL );

[324] Fix | Delete

$note->set_name( self::NOTE_NAME );

[325] Fix | Delete

$note->set_source( 'woocommerce-admin' );

[326] Fix | Delete

$note_action = self::get_note_action_for_milestone( $current_milestone );

[327] Fix | Delete

$note->add_action( $note_action['name'], $note_action['label'], $note_action['query'] );

[328] Fix | Delete

return $note;

[329] Fix | Delete

}

[330] Fix | Delete

[331] Fix | Delete

/**

[332] Fix | Delete

* Checks if a note can and should be added.

[333] Fix | Delete

*

[334] Fix | Delete

* @return bool

[335] Fix | Delete

*/

[336] Fix | Delete

public function can_be_added() {

[337] Fix | Delete

// If the milestone notes have been disabled via filter, bail.

[338] Fix | Delete

if ( ! $this->are_milestones_enabled() ) {

[339] Fix | Delete

return false;

[340] Fix | Delete

}

[341] Fix | Delete

[342] Fix | Delete

$last_milestone = $this->get_last_milestone();

[343] Fix | Delete

$current_milestone = $this->get_current_milestone();

[344] Fix | Delete

[345] Fix | Delete

if ( $current_milestone <= $last_milestone ) {

[346] Fix | Delete

return false;

[347] Fix | Delete

}

[348] Fix | Delete

[349] Fix | Delete

return true;

[350] Fix | Delete

}

[351] Fix | Delete

[352] Fix | Delete

/**

[353] Fix | Delete

* Add milestone notes for other significant thresholds.

[354] Fix | Delete

*/

[355] Fix | Delete

public function possibly_add_note() {

[356] Fix | Delete

if ( ! self::can_be_added() ) {

[357] Fix | Delete

return;

[358] Fix | Delete

}

[359] Fix | Delete

$current_milestone = $this->get_current_milestone();

[360] Fix | Delete

$this->set_last_milestone( $current_milestone );

[361] Fix | Delete

[362] Fix | Delete

// We only want one milestone note at any time.

[363] Fix | Delete

Notes::delete_notes_with_name( self::NOTE_NAME );

[364] Fix | Delete

$note = $this->get_note_by_milestone( $current_milestone );

[365] Fix | Delete

$note->save();

[366] Fix | Delete

}

[367] Fix | Delete

}

[368] Fix | Delete

[369] Fix | Delete