<?php
/**
 * This class provides the easy way to operate transaction meta.
 *
 * @since 4.5.0
 *
 * @package LearnDash
 */

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

if ( ! class_exists( 'Learndash_Transaction_Meta_DTO' ) && class_exists( 'Learndash_DTO' ) ) {
	/**
	 * Transaction meta DTO class. Used to map the transaction metadata.
	 *
	 * @since 4.5.0
	 */
	class Learndash_Transaction_Meta_DTO extends Learndash_DTO {
		private const VALID_PRICE_TYPES = array( LEARNDASH_PRICE_TYPE_PAYNOW, LEARNDASH_PRICE_TYPE_SUBSCRIBE );

		/**
		 * Properties are being cast to the specified type on construction.
		 *
		 * @since 4.5.0
		 *
		 * @var array<string, string>
		 */
		protected $cast = array(
			'ld_payment_processor' => 'string',
			'is_test_mode'         => 'bool',
			'price_type'           => 'string',
			'pricing_info'         => Learndash_Pricing_DTO::class,
			'gateway_transaction'  => Learndash_Transaction_Gateway_Transaction_DTO::class,
			'has_trial'            => 'bool',
			'has_free_trial'       => 'bool',
		);

		/**
		 * Payment gateway name.
		 *
		 * @since 4.5.0
		 *
		 * @var string
		 */
		public $ld_payment_processor = '';

		/**
		 * Whether the transaction was made in test mode or not.
		 *
		 * @since 4.19.0
		 *
		 * @var bool
		 */
		public $is_test_mode = false;

		/**
		 * Type. Valid values are LEARNDASH_PRICE_TYPE_PAYNOW and LEARNDASH_PRICE_TYPE_SUBSCRIBE.
		 *
		 * @since 4.5.0
		 *
		 * @var string
		 */
		public $price_type = '';

		/**
		 * Pricing DTO.
		 *
		 * @since 4.5.0
		 *
		 * @var Learndash_Pricing_DTO
		 */
		public $pricing_info;

		/**
		 * Gateway transaction DTO.
		 *
		 * @since 4.5.0
		 *
		 * @var Learndash_Transaction_Gateway_Transaction_DTO
		 */
		public $gateway_transaction;

		/**
		 * If it has a trial or not.
		 *
		 * @since 4.5.0
		 *
		 * @var bool
		 */
		public $has_trial = false;

		/**
		 * If it has a free trial or not.
		 *
		 * @since 4.5.0
		 *
		 * @var bool
		 */
		public $has_free_trial = false;

		/**
		 * Validates properties on construction based on validators.
		 * Key is a property name, value is an array of validator objects.
		 *
		 * @since 4.5.0
		 *
		 * @return array<string,mixed>
		 */
		protected function get_validators(): array {
			$validators = parent::get_validators();

			if ( ! empty( $this->ld_payment_processor ) ) {
				$validators['ld_payment_processor'] = array(
					new Learndash_DTO_Property_Validator_Possible_Values(
						array_keys( Learndash_Payment_Gateway::get_select_list() )
					),
				);
			}

			if ( ! empty( $this->price_type ) ) {
				$validators['price_type'] = array(
					new Learndash_DTO_Property_Validator_Possible_Values( self::VALID_PRICE_TYPES ),
				);
			}

			return $validators;
		}
	}
}
