Na}{

File Content: `OrderMilestones.php`

<?php
/**
 * Kkart Admin (Dashboard) Order Milestones Note Provider.
 *
 * Adds a note to the merchant's inbox when certain order milestones are reached.
 */

namespace Automattic\Kkart\Admin\Notes;

defined( 'ABSPATH' ) || exit;

/**
 * Order_Milestones
 */
class OrderMilestones {
	/**
	 * Name of the "other milestones" note.
	 */
	const NOTE_NAME = 'kkart-admin-orders-milestone';

	/**
	 * Option key name to store last order milestone.
	 */
	const LAST_ORDER_MILESTONE_OPTION_KEY = 'kkart_admin_last_orders_milestone';

	/**
	 * Hook to process order milestones.
	 */
	const PROCESS_ORDERS_MILESTONE_HOOK = 'kkart_admin_process_orders_milestone';

	/**
	 * Allowed order statuses for calculating milestones.
	 *
	 * @var array
	 */
	protected $allowed_statuses = array(
		'pending',
		'processing',
		'completed',
	);

	/**
	 * Orders count cache.
	 *
	 * @var int
	 */
	protected $orders_count = null;

	/**
	 * Further order milestone thresholds.
	 *
	 * @var array
	 */
	protected $milestones = array(
		1,
		10,
		100,
		250,
		500,
		1000,
		5000,
		10000,
		500000,
		1000000,
	);

	/**
	 * Delay hook attachment until after the KKART post types have been registered.
	 *
	 * This is required for retrieving the order count.
	 */
	public function __construct() {
		/**
		 * Filter Order statuses that will count towards milestones.
		 *
		 * @since 3.5.0
		 *
		 * @param array $allowed_statuses Order statuses that will count towards milestones.
		 */
		$this->allowed_statuses = apply_filters( 'kkart_admin_order_milestone_statuses', $this->allowed_statuses );

		add_action( 'kkart_after_register_post_type', array( $this, 'init' ) );
		register_deactivation_hook( KKART_ADMIN_PLUGIN_FILE, array( $this, 'clear_scheduled_event' ) );
	}

	/**
	 * Hook everything up.
	 */
	public function init() {
		if ( ! wp_next_scheduled( self::PROCESS_ORDERS_MILESTONE_HOOK ) ) {
			wp_schedule_event( time(), 'hourly', self::PROCESS_ORDERS_MILESTONE_HOOK );
		}

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

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

	/**
	 * Clear out our hourly milestone hook upon plugin deactivation.
	 */
	public function clear_scheduled_event() {
		wp_clear_scheduled_hook( self::PROCESS_ORDERS_MILESTONE_HOOK );
	}

	/**
	 * Get the total count of orders (in the allowed statuses).
	 *
	 * @param bool $no_cache Optional. Skip cache.
	 * @return int Total orders count.
	 */
	public function get_orders_count( $no_cache = false ) {
		if ( $no_cache || is_null( $this->orders_count ) ) {
			$status_counts      = array_map( 'kkart_orders_count', $this->allowed_statuses );
			$this->orders_count = array_sum( $status_counts );
		}

		return $this->orders_count;
	}

	/**
	 * Backfill the store's current milestone.
	 *
	 * Used to avoid celebrating milestones that were reached before plugin activation.
	 */
	public function backfill_last_milestone() {
		// If the milestone notes have been disabled via filter, bail.
		if ( ! $this->are_milestones_enabled() ) {
			return;
		}

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

	/**
	 * Get the store's last milestone.
	 *
	 * @return int Last milestone reached.
	 */
	public function get_last_milestone() {
		return get_option( self::LAST_ORDER_MILESTONE_OPTION_KEY, 0 );
	}

	/**
	 * Update the last reached milestone.
	 *
	 * @param int $milestone Last milestone reached.
	 */
	public function set_last_milestone( $milestone ) {
		update_option( self::LAST_ORDER_MILESTONE_OPTION_KEY, $milestone );
	}

	/**
	 * Calculate the current orders milestone.
	 *
	 * Based on the threshold values in $this->milestones.
	 *
	 * @return int Current orders milestone.
	 */
	public function get_current_milestone() {
		$milestone_reached = 0;
		$orders_count      = $this->get_orders_count();

		foreach ( $this->milestones as $milestone ) {
			if ( $milestone <= $orders_count ) {
				$milestone_reached = $milestone;
			}
		}

		return $milestone_reached;
	}

	/**
	 * Get the appropriate note title for a given milestone.
	 *
	 * @param int $milestone Order milestone.
	 * @return string Note title for the milestone.
	 */
	public function get_note_title_for_milestone( $milestone ) {
		switch ( $milestone ) {
			case 1:
				return __( 'First order received', 'kkart' );
			case 10:
			case 100:
			case 250:
			case 500:
			case 1000:
			case 5000:
			case 10000:
			case 500000:
			case 1000000:
				return sprintf(
					/* translators: Number of orders processed. */
					__( 'Congratulations on processing %s orders!', 'kkart' ),
					kkart_format_decimal( $milestone )
				);
			default:
				return '';
		}
	}

	/**
	 * Get the appropriate note content for a given milestone.
	 *
	 * @param int $milestone Order milestone.
	 * @return string Note content for the milestone.
	 */
	public function get_note_content_for_milestone( $milestone ) {
		switch ( $milestone ) {
			case 1:
				return __( 'Congratulations on getting your first order! Now is a great time to learn how to manage your orders.', 'kkart' );
			case 10:
				return __( "You've hit the 10 orders milestone! Look at you go. Browse some Kkart success stories for inspiration.", 'kkart' );
			case 100:
			case 250:
			case 500:
			case 1000:
			case 5000:
			case 10000:
			case 500000:
			case 1000000:
				return __( 'Another order milestone! Take a look at your Orders Report to review your orders to date.', 'kkart' );
			default:
				return '';
		}
	}

	/**
	 * Get the appropriate note action for a given milestone.
	 *
	 * @param int $milestone Order milestone.
	 * @return array Note actoion (name, label, query) for the milestone.
	 */
	public function get_note_action_for_milestone( $milestone ) {
		switch ( $milestone ) {
			case 1:
				return array(
					'name'  => 'learn-more',
					'label' => __( 'Learn more', 'kkart' ),
					'query' => 'https://docs.kkart.com/document/managing-orders/?utm_source=inbox',
				);
			case 10:
				return array(
					'name'  => 'browse',
					'label' => __( 'Browse', 'kkart' ),
					'query' => 'https://kkart.com/success-stories/?utm_source=inbox',
				);
			case 100:
			case 250:
			case 500:
			case 1000:
			case 5000:
			case 10000:
			case 500000:
			case 1000000:
				return array(
					'name'  => 'review-orders',
					'label' => __( 'Review your orders', 'kkart' ),
					'query' => '?page=kkart-admin&path=/analytics/orders',
				);
			default:
				return array(
					'name'  => '',
					'label' => '',
					'query' => '',
				);
		}
	}

	/**
	 * Convenience method to see if the milestone notes are enabled.
	 *
	 * @return boolean True if milestone notifications are enabled.
	 */
	public function are_milestones_enabled() {
		/**
		 * Filter to allow for disabling order milestones.
		 *
		 * @since 3.7.0
		 *
		 * @param boolean default true
		 */
		$milestone_notes_enabled = apply_filters( 'kkart_admin_order_milestones_enabled', true );

		return $milestone_notes_enabled;
	}

	/**
	 * Add milestone notes for other significant thresholds.
	 */
	public function other_milestones() {
		// If the milestone notes have been disabled via filter, bail.
		if ( ! $this->are_milestones_enabled() ) {
			return;
		}

		$last_milestone    = $this->get_last_milestone();
		$current_milestone = $this->get_current_milestone();

		if ( $current_milestone <= $last_milestone ) {
			return;
		}

		$this->set_last_milestone( $current_milestone );

		// We only want one milestone note at any time.
		Notes::delete_notes_with_name( self::NOTE_NAME );

		// Add the milestone note.
		$note = new Note();
		$note->set_title( $this->get_note_title_for_milestone( $current_milestone ) );
		$note->set_content( $this->get_note_content_for_milestone( $current_milestone ) );
		$note_action = $this->get_note_action_for_milestone( $current_milestone );
		$note->add_action( $note_action['name'], $note_action['label'], $note_action['query'] );
		$note->set_type( Note::E_KKART_ADMIN_NOTE_INFORMATIONAL );
		$note->set_name( self::NOTE_NAME );
		$note->set_source( 'kkart-admin' );
		$note->save();
	}
}

Name	Size	Permission
ChooseNiche.php	2287 bytes	0644
ConfirmTaxSettings.php	1166 bytes	0644
CouponPageMoved.php	3540 bytes	0644
CustomizeStoreWithBlocks.php	2199 bytes	0644
DataStore.php	13209 bytes	0644
DeactivatePlugin.php	2209 bytes	0644
DeprecatedNotes.php	20450 bytes	0644
DrawAttention.php	2132 bytes	0644
EUVATNumber.php	1534 bytes	0644
EditProductsOnTheMove.php	1558 bytes	0644
FirstProduct.php	2026 bytes	0644
GivingFeedbackNotes.php	1469 bytes	0644
GoogleAdsAndMarketing.php	2754 bytes	0644
HistoricalData.php	2104 bytes	0644
HomeScreenFeedback.php	2133 bytes	0644
InsightFirstSale.php	1625 bytes	0644
InstallJPAndKKARTSPlugins.php	3778 bytes	0644
KkartPayments.php	5353 bytes	0644
KkartSubscriptions.php	1675 bytes	0644
LaunchChecklist.php	1525 bytes	0644
ManageOrdersOnTheGo.php	1467 bytes	0644
Marketing.php	1094 bytes	0644
MigrateFromShopify.php	2059 bytes	0644
MobileApp.php	1234 bytes	0644
NavigationFeedback.php	1182 bytes	0644
NavigationFeedbackFollowUp.php	1722 bytes	0644
NeedSomeInspiration.php	1829 bytes	0644
NewSalesRecord.php	4005 bytes	0644
Note.php	16968 bytes	0644
NoteTraits.php	2857 bytes	0644
Notes.php	8336 bytes	0644
OnboardingEmailMarketing.php	1193 bytes	0644
OnboardingPayments.php	1591 bytes	0644
OnlineClothingStore.php	2570 bytes	0644
OrderMilestones.php	8098 bytes	0644
PerformanceOnMobile.php	1519 bytes	0644
PersonalizeStore.php	1797 bytes	0644
RealTimeOrderAlerts.php	1436 bytes	0644
ReviewShippingSettings.php	1479 bytes	0644
SellingOnlineCourses.php	2256 bytes	0644
SetUpAdditionalPaymentTypes.php	2602 bytes	0644
StartDropshippingBusiness.php	2336 bytes	0644
TestCheckout.php	2627 bytes	0644
TrackingOptIn.php	2613 bytes	0644
WooSubscriptionsNotes.php	13825 bytes	0644

File Content: OrderMilestones.php

File Content: `OrderMilestones.php`