<?php
/**
 * Module contract.
 *
 * @package AcidStudios\AEO
 */

declare(strict_types=1);

namespace AcidStudios\AEO;

defined( 'ABSPATH' ) || exit;

/**
 * A feature of the plugin that can be switched on and off and audited.
 */
interface Module {

	/**
	 * Machine name, matching the settings section the module reads.
	 *
	 * @return string Module slug, e.g. `llms`.
	 */
	public function slug(): string;

	/**
	 * Human readable, translated module name.
	 *
	 * @return string Module title.
	 */
	public function title(): string;

	/**
	 * Whether the module is switched on in the settings.
	 *
	 * @return bool True when enabled.
	 */
	public function is_enabled(): bool;

	/**
	 * Hooks the module into WordPress. Called only when enabled.
	 *
	 * @return void
	 */
	public function register(): void;

	/**
	 * Audit checks contributed by this module.
	 *
	 * @return array<int,mixed> List of checks.
	 */
	public function checks(): array;
}