<?php
/**
 * Raised when an uploaded photo is rejected.
 *
 * @package Fitzaro
 */

namespace Fitzaro\Image;

defined( 'ABSPATH' ) || exit;

/**
 * Carries a machine-readable reason. The REST layer turns it into a translated message,
 * so this class stays free of WordPress calls and can be unit-tested.
 */
final class InvalidImage extends \RuntimeException {

	public const EMPTY             = 'empty';
	public const FILE_TOO_LARGE    = 'file_too_large';
	public const UNSUPPORTED_TYPE  = 'unsupported_type';
	public const WEBP_UNSUPPORTED  = 'webp_unsupported';
	public const UNSUPPORTED_COLOR = 'unsupported_color';
	public const TOO_MANY_PIXELS   = 'too_many_pixels';
	public const TOO_SMALL         = 'too_small';
	public const NOT_ENOUGH_MEMORY = 'not_enough_memory';
	public const UNREADABLE        = 'unreadable';

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

	/**
	 * Creates the exception.
	 *
	 * @param string $reason One of the class constants.
	 */
	public function __construct( string $reason ) {
		parent::__construct( $reason );
		$this->reason = $reason;
	}

	/**
	 * Why the photo was rejected.
	 */
	public function reason(): string {
		return $this->reason;
	}
}