<?php
/**
 * Base class for feature modules.
 *
 * @package AjSec
 */

namespace AjSec\Features;

use AjSec\Settings;

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

/**
 * A feature module. Each module owns one settings flag (its id) and registers its own hooks.
 */
abstract class Feature {

	/**
	 * Module status values shown on the dashboard.
	 */
	const STATUS_STUB   = 'stub';
	const STATUS_ACTIVE = 'active';

	/**
	 * Machine id; also the settings key that enables the module.
	 *
	 * @return string
	 */
	abstract public function id();

	/**
	 * Human label.
	 *
	 * @return string
	 */
	abstract public function label();

	/**
	 * One-line description.
	 *
	 * @return string
	 */
	abstract public function description();

	/**
	 * Register hooks. Called only when the module is enabled.
	 */
	abstract public function register();

	/**
	 * Implementation status.
	 *
	 * @return string
	 */
	public function status() {
		return self::STATUS_ACTIVE;
	}

	/**
	 * Whether the site owner enabled this module. A stub never runs, whatever the saved flag says.
	 *
	 * @return bool
	 */
	public function is_enabled() {
		return self::STATUS_STUB !== $this->status() && (bool) Settings::get( $this->id() );
	}
}