<?php
/**
 * Interface for Add-On Handlers
 *
 * This interface defines the contract that all add-on handlers must implement
 * to ensure consistent add-on registration and management.
 *
 * @package miniorange-sms-order-notification-otp-verification/objects
 */

namespace WCSMSOTP\Objects;

if ( ! defined( 'ABSPATH' ) ) {
	exit; // Exit if accessed directly.
}

/**
 * Add-On Handler Interface
 *
 * Interface that defines the required methods for add-on handlers.
 * All classes implementing this interface must provide methods to set
 * add-on metadata including key, description, name, settings URL, documentation,
 * and video links.
 */
interface AddOnHandlerInterface {

	/**
	 * Set the unique key for the add-on.
	 *
	 * This method should be implemented to set a unique identifier
	 * for the add-on that will be used throughout the plugin.
	 *
	 * @return void
	 */
	public function set_addon_key();

	/**
	 * Set the add-on description.
	 *
	 * This method should be implemented to set a description
	 * that explains what the add-on does.
	 *
	 * @return void
	 */
	public function set_add_on_desc();

	/**
	 * Set the add-on name.
	 *
	 * This method should be implemented to set the display name
	 * of the add-on.
	 *
	 * @return void
	 */
	public function set_add_on_name();

	/**
	 * Set the settings page URL for the add-on.
	 *
	 * This method should be implemented to set the URL where
	 * the add-on's settings page can be accessed.
	 *
	 * @return void
	 */
	public function set_settings_url();

	/**
	 * Set the documentation link for the add-on.
	 *
	 * This method should be implemented to set a URL pointing
	 * to the add-on's documentation.
	 *
	 * @return void
	 */
	public function set_add_on_docs();

	/**
	 * Set the video tutorial link for the add-on.
	 *
	 * This method should be implemented to set a URL pointing
	 * to a video tutorial for the add-on.
	 *
	 * @return void
	 */
	public function set_add_on_video();
}
