<?php
/**
 * A provider failure, as a code the rest of the plugin can act on.
 *
 * @package Fitzaro
 */

namespace Fitzaro\Provider;

defined( 'ABSPATH' ) || exit;

/**
 * Codes, not messages: provider error text can contain part of an API key, so it is never stored
 * or shown. The REST layer turns the code into a translated message.
 */
final class ProviderError {

	public const INVALID_KEY  = 'invalid_key';
	public const NO_QUOTA     = 'no_quota';
	public const FORBIDDEN    = 'forbidden';
	public const RATE_LIMITED = 'rate_limited';
	public const MODERATION   = 'moderation';
	public const BAD_REQUEST  = 'bad_request';
	public const SERVER       = 'server';
	public const CONNECTION   = 'connection';
	public const NO_IMAGE     = 'no_image';
	public const UNKNOWN      = 'unknown';

	/**
	 * Errors that will repeat for every request with the same key: try-on should pause and tell the owner.
	 */
	private const FATAL = array( self::INVALID_KEY, self::NO_QUOTA, self::FORBIDDEN );

	private const KNOWN = array(
		self::INVALID_KEY,
		self::NO_QUOTA,
		self::FORBIDDEN,
		self::RATE_LIMITED,
		self::MODERATION,
		self::BAD_REQUEST,
		self::SERVER,
		self::CONNECTION,
		self::NO_IMAGE,
		self::UNKNOWN,
	);

	/**
	 * One of the constants above.
	 *
	 * @var string
	 */
	private $code;

	/**
	 * Creates an error. Unknown codes become UNKNOWN.
	 *
	 * @param string $code One of the class constants.
	 */
	public function __construct( string $code ) {
		$this->code = in_array( $code, self::KNOWN, true ) ? $code : self::UNKNOWN;
	}

	/**
	 * Error code.
	 */
	public function code(): string {
		return $this->code;
	}

	/**
	 * Whether every following call with the same credentials would fail the same way.
	 */
	public function is_fatal(): bool {
		return in_array( $this->code, self::FATAL, true );
	}
}