<?php
/**
 * Request context value object.
 *
 * @package BlockSieve
 */

namespace BlockSieve\Conditions\Context;

/**
 * Immutable snapshot of the current request that conditions evaluate against.
 *
 * Built once per request by ContextFactory. Conditions read only from this
 * object, keeping them pure and unit-testable. Device targeting is intentionally
 * absent: the Device condition is enforced with responsive CSS (no user-agent
 * detection), so it never needs a server-side device class here.
 */
final class Context {

	/**
	 * Current user id (0 for logged-out).
	 *
	 * @var int
	 * @readonly
	 */
	public int $user_id;

	/**
	 * Current user roles.
	 *
	 * @var string[]
	 * @readonly
	 */
	public array $roles;

	/**
	 * Whether the current user is logged in.
	 *
	 * @var bool
	 * @readonly
	 */
	public bool $is_logged_in;

	/**
	 * Current date-time in site timezone.
	 *
	 * @var \DateTimeImmutable
	 * @readonly
	 */
	public \DateTimeImmutable $datetime;

	/**
	 * Current post type, when applicable.
	 *
	 * @var string|null
	 * @readonly
	 */
	public ?string $post_type;

	/**
	 * Current post id (0 when not singular).
	 *
	 * @var int
	 * @readonly
	 */
	public int $post_id;

	/**
	 * Whether the current view is an archive.
	 *
	 * @var bool
	 * @readonly
	 */
	public bool $is_archive;

	/**
	 * Archive kind ('category'|'tag'|'taxonomy'|'date'|'author'|'post_type').
	 *
	 * @var string|null
	 * @readonly
	 */
	public ?string $archive_type;

	/**
	 * Whether viewing the blog posts index.
	 *
	 * @var bool
	 * @readonly
	 */
	public bool $is_home;

	/**
	 * Whether viewing the site front page.
	 *
	 * @var bool
	 * @readonly
	 */
	public bool $is_front_page;

	/**
	 * Whether viewing a search results page.
	 *
	 * @var bool
	 * @readonly
	 */
	public bool $is_search;

	/**
	 * Whether viewing a 404 (not found) page.
	 *
	 * @var bool
	 * @readonly
	 */
	public bool $is_404;

	/**
	 * Whether viewing a single post.
	 *
	 * @var bool
	 * @readonly
	 */
	public bool $is_single;

	/**
	 * Full current request URL.
	 *
	 * @var string
	 * @readonly
	 */
	public string $url;

	/**
	 * URL query parameters.
	 *
	 * @var array
	 * @readonly
	 */
	public array $query_params;

	/**
	 * Constructor.
	 *
	 * @param int                $user_id       Current user id (0 for logged-out).
	 * @param string[]           $roles         Current user roles.
	 * @param bool               $is_logged_in  Whether the current user is logged in.
	 * @param \DateTimeImmutable $datetime      Current date-time in site timezone.
	 * @param string|null        $post_type     Current post type, when applicable.
	 * @param int                $post_id       Current post id (0 when not singular).
	 * @param bool               $is_archive    Whether the current view is an archive.
	 * @param string|null        $archive_type  Archive kind ('category'|'tag'|'taxonomy'|'date'|'author'|'post_type').
	 * @param bool               $is_home       Whether viewing the blog posts index.
	 * @param bool               $is_front_page Whether viewing the site front page.
	 * @param bool               $is_search     Whether viewing a search results page.
	 * @param bool               $is_404        Whether viewing a 404 (not found) page.
	 * @param bool               $is_single     Whether viewing a single post.
	 * @param string             $url           Full current request URL.
	 * @param array              $query_params  URL query parameters.
	 */
	public function __construct(
		int $user_id,
		array $roles,
		bool $is_logged_in,
		\DateTimeImmutable $datetime,
		?string $post_type = null,
		int $post_id = 0,
		bool $is_archive = false,
		?string $archive_type = null,
		bool $is_home = false,
		bool $is_front_page = false,
		bool $is_search = false,
		bool $is_404 = false,
		bool $is_single = false,
		string $url = '',
		array $query_params = array()
	) {
		$this->user_id       = $user_id;
		$this->roles         = $roles;
		$this->is_logged_in  = $is_logged_in;
		$this->datetime      = $datetime;
		$this->post_type     = $post_type;
		$this->post_id       = $post_id;
		$this->is_archive    = $is_archive;
		$this->archive_type  = $archive_type;
		$this->is_home       = $is_home;
		$this->is_front_page = $is_front_page;
		$this->is_search     = $is_search;
		$this->is_404        = $is_404;
		$this->is_single     = $is_single;
		$this->url           = $url;
		$this->query_params  = $query_params;
	}
}