<?php
/**
 * @package PlugixaCrm
 */

declare( strict_types = 1 );

namespace PlugixaCrm\Core\Http;

use WP_REST_Request;
use WP_REST_Response;

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

/**
 * The dashboard's numbers.
 *
 * Core owns the endpoint and knows none of the numbers. Every figure on the dashboard is
 * contributed by the module that owns the data, through a filter — so Core does not have
 * to import a repository from each module, and a module that is removed takes its tile
 * with it rather than leaving a broken query behind.
 *
 * It is also the seam the Reports module hangs its own tiles on: it hooks the same
 * filter, and Core never learns that revenue forecasting exists.
 */
final class DashboardController extends RestController {

	protected function entity_type(): string {
		return 'core';
	}

	public function register_routes(): void {
		register_rest_route(
			$this->namespace,
			'/dashboard/stats',
			array(
				array(
					'methods'             => 'GET',
					'callback'            => array( $this, 'stats' ),
					'permission_callback' => array( $this, 'can_read' ),
				),
			)
		);
	}

	/**
	 * @param WP_REST_Request $request The request.
	 */
	public function stats( WP_REST_Request $request ): WP_REST_Response {
		unset( $request );

		/**
		 * The dashboard's figures.
		 *
		 * Each module adds what it owns. Nothing is required, and a module that contributes
		 * nothing simply has no tile.
		 *
		 * @param array<string, mixed> $stats Contributed statistics, keyed by module.
		 */
		$stats = (array) apply_filters( 'plugixa_crm_dashboard_stats', array() );

		return $this->ok( $stats );
	}
}