Module

abstract class Module extends Service {
	use Container_Service_Trait, Hook_Service_Trait;

	/**
	 * The module slug. Must match the slug when registering the module.
	 *
	 * @since 1.0.0
	 * @var string
	 */
	protected $slug = '';

	/**
	 * The module title.
	 *
	 * @since 1.0.0
	 * @var string
	 */
	protected $title = '';

	/**
	 * The module description.
	 *
	 * @since 1.0.0
	 * @var string
	 */
	protected $description = '';

	/**
	 * Logging context for this module.
	 *
	 * @since 1.0.0
	 * @var array
	 */
	protected $logging_context = array();

	/**
	 * The module manager service definition.
	 *
	 * @since 1.0.0
	 * @static
	 * @var string
	 */
	protected static $service_manager = Module_Manager::class;

	/**
	 * Constructor.
	 *
	 * @since 1.0.0
	 *
	 * @param string $prefix   The instance prefix.
	 * @param array  $services {
	 *     Array of service instances.
	 *
	 *     @type Module_Manager $manager       The module manager instance.
	 *     @type Error_Handler  $error_handler The error handler instance.
	 * }
	 */
	public function __construct( $prefix, $services ) {
		$this->set_prefix( $prefix );
		$this->set_services( $services );

		$this->bootstrap();

		$this->logging_context = array(
			'module' => $this->get_slug(),
		);

		$this->setup_hooks();
	}

	/**
	 * Returns the module slug.
	 *
	 * @since 1.0.0
	 *
	 * @return string Module slug.
	 */
	public function get_slug() {
		return $this->slug;
	}

	/**
	 * Returns the module title.
	 *
	 * @since 1.0.0
	 *
	 * @return string Module title.
	 */
	public function get_title() {
		return $this->title;
	}

	/**
	 * Returns the module description.
	 *
	 * @since 1.0.0
	 *
	 * @return string Module description.
	 */
	public function get_description() {
		return $this->description;
	}

	/**
	 * Checks whether this module is active.
	 *
	 * @since 1.0.0
	 *
	 * @return bool True if the module is active, false otherwise.
	 */
	public function is_active() {
		$options = $this->manager()->options()->get( 'general_settings', array() );
		if ( isset( $options['modules'] ) && is_array( $options['modules'] ) ) {
			return in_array( $this->slug, $options['modules'], true );
		}

		return true;
	}

	/**
	 * Retrieves the value of a specific module option for a specific form.
	 *
	 * @since 1.0.0
	 *
	 * @param int    $form_id Form ID.
	 * @param string $option  Name of the form option to retrieve.
	 * @param mixed  $default Optional. Value to return if the form option doesn't exist. Default false.
	 * @return mixed Value set for the option.
	 */
	public function get_form_option( $form_id, $option, $default = false ) {
		$metadata = $this->get_form_options( $form_id );

		if ( isset( $metadata[ $option ] ) ) {
			return $metadata[ $option ];
		}

		return $default;
	}

	/**
	 * Retrieves the values of all module options for a specific form.
	 *
	 * @since 1.0.0
	 *
	 * @param int $form_id Form ID.
	 * @return array Option values.
	 */
	public function get_form_options( $form_id ) {
		$metadata = $this->manager()->meta()->get( 'post', $form_id, $this->manager()->get_prefix() . $this->get_meta_identifier(), true );

		if ( is_array( $metadata ) ) {
			return $metadata;
		}

		return array();
	}

	/**
	 * Retrieves the value of a specific module option.
	 *
	 * @since 1.0.0
	 *
	 * @param string $option  Name of the option to retrieve.
	 * @param mixed  $default Optional. Value to return if the option doesn't exist. Default false.
	 * @return mixed Value set for the option.
	 */
	public function get_option( $option, $default = false ) {
		$options = $this->get_options();

		if ( isset( $options[ $option ] ) ) {
			return $options[ $option ];
		}

		return $default;
	}

	/**
	 * Retrieves the values of all module options.
	 *
	 * @since 1.0.0
	 *
	 * @return array Option values.
	 */
	public function get_options() {
		return $this->manager()->options()->get( $this->get_settings_identifier(), array() );
	}

	/**
	 * Adds meta tabs, sections and fields for the module to the form edit page.
	 *
	 * @since 1.0.0
	 *
	 * @param Form_Edit_Page_Handler $edit_page Edit page handler.
	 */
	protected final function add_meta( $edit_page ) {
		$tabs = $this->get_meta_tabs();
		if ( empty( $tabs ) ) {
			return;
		}

		$fields = $this->get_meta_fields();

		$meta_box_id = $this->get_meta_identifier();

		$edit_page->add_meta_box( $meta_box_id, array(
			'title'    => $this->get_title(),
			'context'  => 'normal',
			'priority' => 'high',
		) );

		foreach ( $tabs as $slug => $args ) {
			$args['meta_box'] = $meta_box_id;

			$edit_page->add_tab( $slug, $args );
		}

		foreach ( $fields as $slug => $args ) {
			$type = 'text';
			if ( isset( $args['type'] ) ) {
				$type = $args['type'];
				unset( $args['type'] );
			}

			$edit_page->add_field( $slug, $type, $args );
		}
	}

	/**
	 * Returns the meta identifier for the module.
	 *
	 * This identifier must be used to access module metadata.
	 *
	 * @since 1.0.0
	 *
	 * @return string Module meta identifier.
	 */
	protected final function get_meta_identifier() {
		return 'module_' . $this->slug;
	}

	/**
	 * Adds settings subtabs, sections and fields for the module to the plugin settings page.
	 *
	 * @since 1.0.0
	 *
	 * @param Form_Settings_Page $settings_page Settings page instance.
	 */
	protected final function add_settings( $settings_page ) {
		$subtabs = $this->get_settings_subtabs();
		if ( empty( $subtabs ) ) {
			return;
		}

		$sections = $this->get_settings_sections();
		$fields   = $this->get_settings_fields();

		$tab_id = $this->get_settings_identifier();

		$settings_page->add_tab( $tab_id, array(
			'title' => $this->get_title(),
			/* translators: %s: module title */
			'rest_description' => sprintf( _x( 'Torro Forms %s module settings.', 'REST API description', 'torro-forms' ), $this->get_title() ),
		) );

		foreach ( $subtabs as $slug => $args ) {
			$args['tab'] = $tab_id;

			$settings_page->add_subtab( $slug, $args );
		}

		foreach ( $sections as $slug => $args ) {
			$settings_page->add_section( $slug, $args );
		}

		foreach ( $fields as $slug => $args ) {
			$type = 'text';
			if ( isset( $args['type'] ) ) {
				$type = $args['type'];
				unset( $args['type'] );
			}

			$settings_page->add_field( $slug, $type, $args );
		}
	}

	/**
	 * Returns the settings identifier for the module.
	 *
	 * This identifier must be used to access module options.
	 *
	 * @since 1.0.0
	 *
	 * @return string Module settings identifier.
	 */
	protected final function get_settings_identifier() {
		return 'module_' . $this->slug;
	}

	/**
	 * Sets up all action and filter hooks for the service.
	 *
	 * This method must be implemented and then be called from the constructor.
	 *
	 * @since 1.0.0
	 */
	protected function setup_hooks() {
		$this->actions = array(
			array(
				'name'     => "{$this->get_prefix()}add_form_meta_content",
				'callback' => array( $this, 'add_meta' ),
				'priority' => 1,
				'num_args' => 1,
			),
			array(
				'name'     => "{$this->get_prefix()}add_settings_content",
				'callback' => array( $this, 'add_settings' ),
				'priority' => 1,
				'num_args' => 1,
			),
			array(
				'name'     => "{$this->get_prefix()}register_assets",
				'callback' => array( $this, 'register_assets' ),
				'priority' => 1,
				'num_args' => 1,
			),
			array(
				'name'     => "{$this->get_prefix()}enqueue_form_builder_scripts",
				'callback' => array( $this, 'enqueue_form_builder_assets' ),
				'priority' => 1,
				'num_args' => 1,
			),
		);
	}

	/**
	 * Bootstraps the module by setting properties.
	 *
	 * @since 1.0.0
	 */
	protected abstract function bootstrap();

	/**
	 * Returns the available meta box tabs for the module.
	 *
	 * @since 1.0.0
	 *
	 * @return array Associative array of `$tab_slug => $tab_args` pairs.
	 */
	protected abstract function get_meta_tabs();

	/**
	 * Returns the available meta box fields for the module.
	 *
	 * @since 1.0.0
	 *
	 * @return array Associative array of `$field_slug => $field_args` pairs.
	 */
	protected abstract function get_meta_fields();

	/**
	 * Returns the available settings sub-tabs for the module.
	 *
	 * @since 1.0.0
	 *
	 * @return array Associative array of `$subtab_slug => $subtab_args` pairs.
	 */
	protected abstract function get_settings_subtabs();

	/**
	 * Returns the available settings sections for the module.
	 *
	 * @since 1.0.0
	 *
	 * @return array Associative array of `$section_slug => $section_args` pairs.
	 */
	protected abstract function get_settings_sections();

	/**
	 * Returns the available settings fields for the module.
	 *
	 * @since 1.0.0
	 *
	 * @return array Associative array of `$field_slug => $field_args` pairs.
	 */
	protected abstract function get_settings_fields();

	/**
	 * Registers the available module scripts and stylesheets.
	 *
	 * @since 1.0.0
	 *
	 * @param Assets $assets Assets API instance.
	 */
	protected abstract function register_assets( $assets );

	/**
	 * Enqueues the module's form builder scripts and stylesheets.
	 *
	 * @since 1.0.0
	 *
	 * @param Assets $assets Assets API instance.
	 */
	protected abstract function enqueue_form_builder_assets( $assets );
}