<?php
/**
 * Module: DynamicContentOptionProductStockStatus class.
 *
 * @package Divi
 * @since ??
 */

namespace ET\Builder\Packages\Module\Layout\Components\DynamicContent;

if ( ! defined( 'ABSPATH' ) ) {
	die( 'Direct access forbidden.' );
}

/**
 * Module: DynamicContentOptionProductStockStatus class.
 *
 * @since ??
 */
class DynamicContentOptionProductStockStatus extends DynamicContentOptionBase implements DynamicContentOptionInterface {

	/**
	 * Get the name of the product stock status option.
	 *
	 * @since ??
	 *
	 * @return string The name of the product stock status option.
	 */
	public function get_name(): string {
		return 'product_stock_status';
	}

	/**
	 * Get the label for the product stock status option.
	 *
	 * This function retrieves the localized label for the product stock status option,
	 * which is used to describe the product stock status in user interfaces.
	 *
	 * @since ??
	 *
	 * @return string The label for the product stock status option.
	 */
	public function get_label(): string {
		return esc_html__( 'Product Stock Status', 'et_builder_5' );
	}

	/**
	 * Callback for registering product stock status option .
	 *
	 * This function is a callback for the `divi_module_dynamic_content_options` filter .
	 * This function is used to register options for product stock status by adding them to the options array passed to the function .
	 * It checks if the current module's name exists as a key in the options array.
	 * If not, it adds the module's name as a key and the specific options for that module as the value.
	 *
	 * @since ??
	 *
	 * @param array  $options The options array to be registered.
	 * @param int    $post_id The post ID.
	 * @param string $context The context in which the options are retrieved e.g `edit`, `display`.
	 *
	 * @return array The options array.
	 */
	public function register_option_callback( array $options, int $post_id, string $context ): array {
		if ( ! isset( $options[ 'loop_' . $this->get_name() ] ) && et_is_woocommerce_plugin_active() ) {
			$options[ 'loop_' . $this->get_name() ] = [
				'id'     => 'loop_' . $this->get_name(),
				'label'  => esc_html__( 'Loop', 'et_builder_5' ) . ' ' . $this->get_label(),
				'type'   => 'text',
				'custom' => false,
				'group'  => 'Loop Product',
				'fields' => DynamicContentUtils::get_common_loop_fields(),
			];
		}

		return $options;
	}

	/**
	 * Render callback for product stock status option.
	 *
	 * Retrieves the value of product stock status option based on the provided arguments and settings.
	 * This is a callback for `divi_module_dynamic_content_resolved_value` filter.
	 *
	 * @since ??
	 *
	 * @param mixed $value     The current value of the product stock status option.
	 * @param array $data_args {
	 *     Optional. An array of arguments for retrieving the product stock status.
	 *     Default `[]`.
	 *
	 *     @type string  $name       Optional. Option name. Default empty string.
	 *     @type array   $settings   Optional. Option settings. Default `[]`.
	 *     @type integer $post_id    Optional. Post Id. Default `null`.
	 * }
	 *
	 * @return string The formatted value of the product stock status option.
	 *
	 * @example:
	 * ```php
	 *  $element = new MyDynamicContentElement();
	 *
	 *  // Render the element with a specific value and data arguments.
	 *  $html = $element->render_callback( $value, [
	 *      'name'     => 'my_element',
	 *      'settings' => [
	 *          'post_id' => 123,
	 *          'foo'     => 'bar',
	 *      ],
	 *      'post_id'  => 456,
	 *      'overrides' => [
	 *        'my_element' => 'My Element',
	 *        'product_stock_status' => 'Product Stock Status',
	 *      ],
	 *  ] );
	 * ```
	 */
	public function render_callback( $value, array $data_args = [] ): string {
		return $value;
	}
}
