<?php
/**
 * Notification template persistence port.
 *
 * @package Bookline
 */

declare( strict_types=1 );

namespace Bookline\Domain\Notification;

/**
 * Template repository.
 *
 * @since 0.1.0
 */
interface NotificationTemplateRepository {

	/**
	 * Find by key/channel/locale.
	 *
	 * @param string $key     Key.
	 * @param string $channel Channel.
	 * @param string $locale  Locale.
	 *
	 * @since 0.1.0
	 */
	public function find_by_key( string $key, string $channel = 'email', string $locale = 'en_GB' ): ?NotificationTemplate;

	/**
	 * Persist a template.
	 *
	 * @param NotificationTemplate $template Template.
	 *
	 * @since 0.1.0
	 */
	public function save( NotificationTemplate $template ): void;

	/**
	 * All templates.
	 *
	 * @return list<NotificationTemplate>
	 *
	 * @since 0.1.0
	 */
	public function all(): array;

	/**
	 * Find by database id.
	 *
	 * @param int $id Id.
	 *
	 * @since 0.1.0
	 */
	public function find_by_id( int $id ): ?NotificationTemplate;
}