<?php
/**
 * Plugin Constants
 *
 * Central definition of every string identifier used by the plugin.
 * All capability checks, option reads/writes, hook registrations, and
 * asset enqueues reference constants from this class so that renaming
 * any identifier is a single-file change.
 *
 * @package AAMO_Notification_Groups
 * @since   1.0.0
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

class AAMO_Notification_Groups_Constants {

	// -------------------------------------------------------------------------
	// Prefixes
	// -------------------------------------------------------------------------

	/**
	 * All wp_options keys use this prefix. Deliberately distinct from the
	 * sibling aamo-admin-menu-organizer plugin's bare "aamo_" prefix — that
	 * plugin shares its prefix with a paid Pro sibling by design, but this
	 * plugin has no such pairing, so a distinct "aamo_ng_" prefix avoids any
	 * option-key collision if both plugins are active on the same site.
	 */
	const OPTION_PREFIX = 'aamo_ng_';

	// -------------------------------------------------------------------------
	// Admin page slugs
	// -------------------------------------------------------------------------

	const PAGE_MAIN = 'aamo-notification-groups';

	// -------------------------------------------------------------------------
	// WordPress option keys
	// -------------------------------------------------------------------------

	/** Schema version tracker — bump when the stored data structure changes. */
	const OPTION_DB_VERSION = 'aamo_ng_db_version';

	// -------------------------------------------------------------------------
	// Capability
	// -------------------------------------------------------------------------

	/**
	 * Custom capability that gates access to all plugin pages and AJAX
	 * endpoints. Granted to the administrator role on activation. Can be
	 * granted to any other role or user via standard WordPress role
	 * management. Never use manage_options in this plugin.
	 */
	const CAP_MANAGE_NOTIFICATIONS = 'ap_notification_manager';

	// -------------------------------------------------------------------------
	// Assets
	// -------------------------------------------------------------------------

	const ASSET_HANDLE_CSS = 'aamo-notification-groups-admin';

	/** Notice Collector card — loaded on every admin screen, not scoped to this plugin's own page. */
	const ASSET_HANDLE_NOTICE_COLLECTOR_CSS = 'aamo-notification-groups-notice-collector';
	const ASSET_HANDLE_NOTICE_COLLECTOR_JS  = 'aamo-notification-groups-notice-collector';

	// -------------------------------------------------------------------------
	// Notice Collector — severity classification
	// -------------------------------------------------------------------------

	const SEVERITY_ERROR   = 'error';
	const SEVERITY_WARNING = 'warning';
	const SEVERITY_SUCCESS = 'success';
	const SEVERITY_INFO    = 'info';

	/**
	 * Catch-all bucket for any captured notice that doesn't match a known
	 * severity class — e.g. a bare `.notice` with no severity suffix.
	 */
	const SEVERITY_MISC = 'misc';

	/**
	 * Ordered severity → matching CSS class(es) map, most severe first.
	 * Localized into JS so the classifier and this file share one
	 * definition — renaming or adding a class is a single-file change.
	 * Checked in this order; the first match wins, so a notice carrying
	 * more than one severity class is bucketed under the most severe one
	 * rather than decided by attribute order. `misc` has no entry — it is
	 * the classifier's fallback when nothing here matches.
	 */
	const SEVERITY_CLASS_MAP = array(
		'error'   => array( 'notice-error', 'error' ),
		'warning' => array( 'notice-warning' ),
		'success' => array( 'notice-success', 'updated' ),
		'info'    => array( 'notice-info' ),
	);

	/**
	 * Classes that mark a notice as intentionally page-local — WordPress
	 * core's own admin-notice relocation (wp-admin/js/common.js) skips
	 * these, and so do we, for the same reason: an `.inline` notice is
	 * meant to stay exactly where its plugin placed it (e.g. next to a
	 * specific list-table row), not be swept into a global collector.
	 */
	const NOTICE_EXCLUDE_CLASSES = array( 'inline', 'below-h2' );

	// -------------------------------------------------------------------------
	// Demo notices
	// -------------------------------------------------------------------------

	/**
	 * Query arg that, when present and nonce-verified on this plugin's own
	 * page, triggers a one-off batch of fake notices covering every
	 * severity tab. Never persisted — only affects the single page load
	 * that carries this arg.
	 */
	const DEMO_QUERY_ARG = 'aamo_ng_demo';

	const DEMO_NONCE_ACTION = 'aamo_ng_demo_notices';

	// -------------------------------------------------------------------------
	// Notice Collector — display style
	// -------------------------------------------------------------------------

	/** Persisted option holding the admin's chosen display style. */
	const OPTION_DISPLAY_STYLE = 'aamo_ng_display_style';

	const STYLE_TABBED    = 'tabbed';
	const STYLE_ACCORDION = 'accordion';
	const STYLE_GRID      = 'grid';

	/** Every allowed display-style value, in the order shown on the settings page. */
	const DISPLAY_STYLES = array(
		self::STYLE_TABBED,
		self::STYLE_ACCORDION,
		self::STYLE_GRID,
	);

	/** admin_post_ hook suffix and nonce action for saving the settings form (display style + minimum group count). */
	const SAVE_SETTINGS_ACTION = 'aamo_ng_save_settings';

	/** Query arg set on the redirect back after a successful save. */
	const SETTINGS_SAVED_QUERY_ARG = 'aamo_ng_settings_saved';

	// -------------------------------------------------------------------------
	// Notice Collector — minimum group count
	// -------------------------------------------------------------------------

	/**
	 * Persisted option holding the minimum number of notices that must be
	 * present on a page before the Notice Collector groups them into a
	 * card. Below this count, notices are left exactly where WordPress
	 * core's own relocation shim placed them — collapsing just one or two
	 * notices into a card isn't worth the extra click.
	 */
	const OPTION_MIN_GROUP_COUNT = 'aamo_ng_min_group_count';

	const MIN_GROUP_COUNT_DEFAULT = 3;

	/** Every allowed minimum-group-count value, in display order. */
	const MIN_GROUP_COUNT_OPTIONS = array( 2, 3, 4, 5 );

	// -------------------------------------------------------------------------
	// Notice Collector — default open/closed state
	// -------------------------------------------------------------------------

	/** Persisted option: whether the Notice Collector starts collapsed on page load. */
	const OPTION_COLLAPSED_BY_DEFAULT = 'aamo_ng_collapsed_by_default';
}