WooCommerce Code Reference

TotalPaymentsVolumeProcessor.php

Source code

<?php
/**
 * Rule processor that passes when a store's payments volume exceeds a provided amount.
 */

declare(strict_types=1);

namespace Automattic\WooCommerce\Admin\RemoteSpecs\RuleProcessors;

defined( 'ABSPATH' ) || exit;

use Automattic\WooCommerce\Admin\API\Reports\Revenue\Query as RevenueQuery;
use Automattic\WooCommerce\Admin\API\Reports\TimeInterval;
use Automattic\WooCommerce\Admin\DateTimeProvider\CurrentDateTimeProvider;
use Automattic\WooCommerce\Admin\DateTimeProvider\DateTimeProviderInterface;

/**
 * Rule processor that passes when a store's payments volume exceeds a provided amount.
 */
class TotalPaymentsVolumeProcessor implements RuleProcessorInterface {
	/**
	 * The DateTime provider.
	 *
	 * @var DateTimeProviderInterface
	 */
	protected $date_time_provider;

	/**
	 * Constructor.
	 *
	 * @param DateTimeProviderInterface|null $date_time_provider The DateTime provider.
	 */
	public function __construct( $date_time_provider = null ) {
		$this->date_time_provider = null === $date_time_provider
			? new CurrentDateTimeProvider()
			: $date_time_provider;
	}

	/**
	 * Compare against the store's total payments volume.
	 *
	 * @param object $rule         The rule being processed by this rule processor.
	 * @param object $stored_state Stored state.
	 *
	 * @return bool The result of the operation.
	 */
	public function process( $rule, $stored_state ) {
		// The timeframe must be resolved against the site's calendar date: the report query
		// parses the returned boundary strings as site-local datetimes. Work on a fresh
		// instance: the date calculations modify it in place, and the provider's own object
		// (which an implementation may cache and return again) must not absorb that.
		$now   = ( new \DateTime( '@' . $this->date_time_provider->get_now()->getTimestamp() ) )->setTimezone( wp_timezone() );
		$dates = TimeInterval::get_timeframe_dates( $rule->timeframe, $now );

		if ( false === $dates ) {
			return false;
		}

		$reports_revenue = $this->get_reports_query(
			array(
				'before'   => $dates['end'],
				'after'    => $dates['start'],
				'interval' => 'year',
				'fields'   => array( 'total_sales' ),
			)
		);
		$report_data     = $reports_revenue->get_data();

		if ( ! $report_data || ! isset( $report_data->totals->total_sales ) ) {
			return false;
		}

		$value = $report_data->totals->total_sales;

		return ComparisonOperation::compare(
			$value,
			$rule->value,
			$rule->operation
		);
	}

	/**
	 * Validates the rule.
	 *
	 * @param object $rule The rule to validate.
	 *
	 * @return bool Pass/fail.
	 */
	public function validate( $rule ) {
		$allowed_timeframes = array(
			'last_week',
			'last_month',
			'last_quarter',
			'last_6_months',
			'last_year',
		);

		if ( ! isset( $rule->timeframe ) || ! in_array( $rule->timeframe, $allowed_timeframes, true ) ) {
			return false;
		}

		if ( ! isset( $rule->value ) ) {
			return false;
		}

		if ( ! isset( $rule->operation ) ) {
			return false;
		}

		// If the operation is range, the value must be an array of two numbers.
		if ( 'range' === $rule->operation ) {
			if ( ! is_array( $rule->value ) || count( $rule->value ) !== 2 ) {
				return false;
			}

			if ( ! is_numeric( $rule->value[0] ) || ! is_numeric( $rule->value[1] ) ) {
				return false;
			}
		} elseif ( ! is_numeric( $rule->value ) ) {
				return false;
		}

		return true;
	}

	/**
	 * Get the report query.
	 *
	 * @param array $args The query args.
	 *
	 * @return RevenueQuery The report query.
	 */
	protected function get_reports_query( $args ) {
		return new RevenueQuery(
			$args
		);
	}
}