<?php
/**
 * The request was refused locally (pause, allow-list, rate guard) and never sent.
 *
 * @package Tidelist
 */

namespace Tidelist\Channel\Exception;

/**
 * The request was refused locally (pause, allow-list, rate guard) and never sent.
 */
final class BlockedException extends ChannelException {

	const PAUSED     = 'paused';
	const COOLDOWN   = 'cooldown';
	const RATE_LIMIT = 'rate_limit';

	/**
	 * Reason (a constant above, or a request-policy reason such as "not_allowed").
	 *
	 * @var string
	 */
	private $reason;

	/**
	 * Constructor.
	 *
	 * @param string $reason  Reason.
	 * @param string $message Message.
	 */
	public function __construct( string $reason, string $message ) {
		parent::__construct( $message );
		$this->reason = $reason;
	}

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

	/**
	 * Whether the plugin's global pause switch caused the block.
	 */
	public function is_paused(): bool {
		return self::PAUSED === $this->reason;
	}
}