<?php
/**
 * One configurable notification.
 *
 * @package Rahkar\WP
 */

declare( strict_types = 1 );

namespace Rahkar\WP\Notifications\Events;

defined( 'ABSPATH' ) || exit;

/**
 * Describes a single thing the store can send, and to whom.
 *
 * The unit here is a *notification*, not an event: "order moved to processing"
 * produces two separate entries, one for the customer and one for the shop
 * manager. They are configured independently because in practice they always
 * differ — different wording, different channel, and on an Iranian service line
 * a separately approved pattern code for each. Modelling them as one row with a
 * pair of sub-forms is what turns these screens into a wall.
 *
 * A definition is pure data. It knows nothing about how sending works.
 */
final class EventDefinition {

	public const AUDIENCE_CUSTOMER = 'customer';
	public const AUDIENCE_ADMIN    = 'admin';

	/**
	 * Describe one notification.
	 *
	 * @param string               $id          Stable identifier, e.g. `order.processing.customer`.
	 * @param string               $group       Grouping key for the admin list, e.g. `orders`.
	 * @param string               $label       Human-readable name.
	 * @param string               $audience    One of the AUDIENCE_* constants.
	 * @param array<string,string> $variables   Placeholder name => description.
	 * @param string               $defaultText Message body used until an admin edits it.
	 * @param string               $description Optional one-line explanation.
	 * @param string               $short       Name within its tab and group, e.g. the order status alone.
	 * @param string               $kind        How the send rules treat it: `immediate` (default; never held
	 *                                          back), `service` (waits out quiet hours) or `promotional`
	 *                                          (quiet hours, opt-out, cap). See SendPolicy.
	 */
	public function __construct(
		public string $id,
		public string $group,
		public string $label,
		public string $audience,
		public array $variables = [],
		public string $defaultText = '',
		public string $description = '',
		public string $short = '',
		public string $kind = 'immediate'
	) {}

	/**
	 * Is this addressed to the shop's own staff?
	 */
	public function isForAdmin(): bool {
		return self::AUDIENCE_ADMIN === $this->audience;
	}

	/**
	 * Settings key under which this notification's configuration is stored.
	 *
	 * Derived from the id rather than stored, so adding a notification needs no
	 * migration and removing one leaves an orphan row that is simply ignored.
	 */
	public function settingsKey(): string {
		return str_replace( '.', '_', $this->id );
	}
}