<?php
/**
 * Thrown when a create would exceed this plugin's catalogue size.
 *
 * @package Bookline
 */

declare( strict_types=1 );

namespace Bookline\Domain\Edition;

use Bookline\Domain\Shared\DomainException;

/**
 * Catalogue size of this plugin, not a missing licence.
 *
 * @since 0.26.0
 */
final class EditionLimitReached extends DomainException {

	/**
	 * Constructor.
	 *
	 * @param EditionDimension $dimension Dimension.
	 * @param int              $max       Ceiling that was hit.
	 */
	public function __construct(
		private readonly EditionDimension $dimension,
		private readonly int $max,
	) {
		parent::__construct(
			'edition.limit_reached',
			sprintf(
				'This plugin supports at most %d %s.',
				$max,
				self::noun( $dimension )
			)
		);
	}

	/**
	 * Dimension that hit the ceiling.
	 */
	public function dimension(): EditionDimension {
		return $this->dimension;
	}

	/**
	 * Ceiling value.
	 */
	public function max(): int {
		return $this->max;
	}

	/**
	 * British English noun for REST/log copy.
	 *
	 * @param EditionDimension $dimension Dimension.
	 */
	private static function noun( EditionDimension $dimension ): string {
		return match ( $dimension ) {
			EditionDimension::Service => 'services',
			EditionDimension::Agent => 'staff',
			EditionDimension::Location => 'locations',
			EditionDimension::BookingForm => 'booking forms',
		};
	}
}