<?php
/**
 * Result of checking one advert for changes.
 *
 * @package Tidelist
 */

namespace Tidelist\Sync;

/**
 * Update check result.
 */
final class UpdateResult {

	const NOT_LISTED      = 'not_listed';       // No advert on the marketplace for this listing: nothing to do.
	const TAKEDOWN_NEEDED = 'takedown_needed';  // The item is no longer for sale: the takedown job handles it.
	const BLOCKED         = 'blocked';          // The advert as built now has errors: nothing is sent, the first error is stored.
	const UNCHANGED       = 'unchanged';        // The advert would be identical: nothing to send.
	const UPDATED         = 'updated';
	const SIMULATED       = 'simulated';        // Dry-run: would have been updated.
	const RETRY           = 'retry';            // Could not do it now; try again after $delay seconds.
	const GAVE_UP         = 'gave_up';          // Failed too many times; the owner can use the manual button.

	/**
	 * Action (constants above).
	 *
	 * @var string
	 */
	public $action = '';

	/**
	 * Seconds until the next try (RETRY).
	 *
	 * @var int
	 */
	public $delay = 0;

	/**
	 * Whether a RETRY counts as a failed attempt.
	 *
	 * @var bool
	 */
	public $counts = false;

	/**
	 * New result.
	 *
	 * @param string $action Action.
	 * @param int    $delay  Retry delay.
	 * @param bool   $counts Counts as a failed attempt.
	 */
	public static function of( string $action, int $delay = 0, bool $counts = false ): self {
		$result         = new self();
		$result->action = $action;
		$result->delay  = $delay;
		$result->counts = $counts;
		return $result;
	}
}