LearnDash_Razorpay_Integration.php 12.1 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
<?php
/**
 * Deprecated. Use LearnDash_Razorpay_Gateway instead.
 * This class handled Razorpay integration.
 *
 * @since 4.2.0
 * @deprecated 4.5.0
 *
 * @package LearnDash\Deprecated
 */

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

_deprecated_file(
	__FILE__,
	'4.5.0',
	esc_html( LEARNDASH_LMS_PLUGIN_DIR . '/includes/payments/gateways/class-learndash-razorpay-gateway.php' )
);

if ( ! class_exists( 'LearnDash_Razorpay_Integration' ) && class_exists( 'LearnDash_Payment_Gateway_Integration' ) ) {
	/**
	 * Deprecated Razorpay's integration class.
	 *
	 * @since 4.2.0
	 * @deprecated 4.5.0
	 */
	class LearnDash_Razorpay_Integration extends LearnDash_Payment_Gateway_Integration {
		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const AJAX_ACTION_SETUP_OPTIONS = 'learndash_razorpay_setup_options';

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const META_KEY_CUSTOMER_ID_LIVE = 'learndash_razorpay_live_customer_id';

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const META_KEY_CUSTOMER_ID_TEST = 'learndash_razorpay_test_customer_id';

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const META_KEY_PLANS_LIVE = 'learndash_razorpay_live_plans';

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const META_KEY_PLANS_TEST = 'learndash_razorpay_test_plans';

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const PERIOD_HASH = array(
			'D' => 'daily',
			'W' => 'weekly',
			'M' => 'monthly',
			'Y' => 'yearly',
		);

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const TRIAL_PERIOD_DURATION_HASH = array(
			'D' => DAY_IN_SECONDS,
			'W' => WEEK_IN_SECONDS,
			'M' => MONTH_IN_SECONDS,
			'Y' => YEAR_IN_SECONDS,
		);

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const EVENT_ORDER_PAID = 'order.paid';

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const EVENT_SUBSCRIPTION_AUTHENTICATED = 'subscription.authenticated';

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const EVENT_SUBSCRIPTION_ACTIVATED = 'subscription.activated';

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const EVENT_SUBSCRIPTION_COMPLETED = 'subscription.completed';

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const EVENT_SUBSCRIPTION_PENDING = 'subscription.pending';

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const EVENT_SUBSCRIPTION_HALTED = 'subscription.halted';

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const EVENT_SUBSCRIPTION_CANCELLED = 'subscription.cancelled';

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const EVENT_SUBSCRIPTION_PAUSED = 'subscription.paused';

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const EVENT_SUBSCRIPTION_RESUMED = 'subscription.resumed';

		/**
		 * Deprecated.
		 *
		 * @deprecated 4.5.0
		 */
		const PAYMENT_PROCESSOR = 'razorpay';

		/**
		 * Settings.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @var array
		 */
		protected $settings = array();

		/**
		 * Secret key.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @var string
		 */
		protected $secret_key = '';

		/**
		 * Publishable key.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @var string
		 */
		protected $publishable_key = '';

		/**
		 * Webhook secret.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @var string
		 */
		protected $webhook_secret = '';

		/**
		 * API client.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @var null
		 */
		protected $api = null;

		/**
		 * Course/Group we are working with.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @var null
		 */
		protected $post = null;

		/**
		 * Current user.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @var null
		 */
		protected $user = null;

		/**
		 * Razorpay customer id meta key name.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @var string
		 */
		protected $customer_id_meta_key = '';

		/**
		 * Razorpay plans meta key name.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @var string
		 */
		protected $plans_meta_key = '';

		/**
		 * Current currency code.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @var string
		 */
		protected $currency = '';

		/**
		 * Construction.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 */
		public function __construct() {
			_deprecated_constructor( __CLASS__, '4.5.0' );
		}

		/**
		 * Enqueues scripts.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @return void
		 */
		public function enqueue_scripts(): void {
			_deprecated_function( __METHOD__, '4.5.0' );

			$gateway = Learndash_Payment_Gateway::get_active_payment_gateway_by_name( Learndash_Razorpay_Gateway::get_name() );
			$gateway->enqueue_scripts();
		}

		/**
		 * Creates an order/subscription in Razorpay.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @return void
		 */
		public function setup_options(): void {
			_deprecated_function( __METHOD__, '4.5.0' );

			$gateway = Learndash_Payment_Gateway::get_active_payment_gateway_by_name( Learndash_Razorpay_Gateway::get_name() );
			$gateway->setup_payment();
		}

		/**
		 * Checks if enabled and all keys are filled in.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @return bool
		 */
		public function is_ready(): bool {
			_deprecated_function( __METHOD__, '4.5.0' );

			return false;
		}

		/**
		 * Configures settings.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @return void
		 */
		protected function configure(): void {
			_deprecated_function( __METHOD__, '4.5.0' );
		}

		/**
		 * Checks if it's a test mode.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @return bool
		 */
		protected function is_test_mode(): bool {
			_deprecated_function( __METHOD__, '4.5.0' );

			return true;
		}

		/**
		 * Returns Razorpay options.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @throws Exception Throws if not valid arguments passed.
		 *
		 * @return array
		 */
		protected function map_payment_options(): array {
			_deprecated_function( __METHOD__, '4.5.0' );

			return array();
		}

		/**
		 * Returns modified payment button.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @param string $default_button Learndash default payment button.
		 * @param array  $params         Parameters.
		 *
		 * @return string
		 */
		public function add_payment_button( string $default_button, array $params ): string {
			_deprecated_function( __METHOD__, '4.5.0' );

			return $default_button;
		}

		/**
		 * Processes a webhook.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @return void
		 */
		public function process_webhook(): void {
			_deprecated_function( __METHOD__, '4.5.0' );

			$gateway = Learndash_Payment_Gateway::get_active_payment_gateway_by_name( Learndash_Razorpay_Gateway::get_name() );
			$gateway->process_webhook();
		}

		/**
		 * Finds or creates a user.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @param array $event Event.
		 *
		 * @return WP_User|null
		 */
		public function find_or_create_user( array $event ): ?WP_User {
			_deprecated_function( __METHOD__, '4.5.0' );

			$entity  = $this->get_main_entity_from_event( $event );
			$user_id = (int) $entity['notes']['user_id'];
			$payment = $this->get_payment_entity_from_event( $event );

			if ( $user_id > 0 ) {
				$user = get_user_by( 'ID', $user_id );
			} elseif ( ! empty( $payment ) ) {
				$user = get_user_by( 'email', $event['payload']['payment']['entity']['email'] );
			} else {
				return null;
			}

			if ( ! is_a( $user, WP_User::class ) ) {
				if ( empty( $payment ) ) {
					return null;
				}

				$user = $this->create_user( $payment['email'] );
			}

			return $user;
		}

		/**
		 * Creates a user.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @param string $email Email.
		 *
		 * @return WP_User
		 */
		public function create_user( string $email ): WP_User {
			_deprecated_function( __METHOD__, '4.5.0' );

			$username = $email;
			$password = wp_generate_password( 18 );

			if ( username_exists( $username ) ) {
				$username = $username . '-' . uniqid();
			}

			$user_id = wp_create_user( $username, $password, $email );

			return get_user_by( 'ID', $user_id );
		}

		/**
		 * Returns subscription/order entity from the event.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @param array $event Event.
		 *
		 * @return array
		 */
		protected function get_main_entity_from_event( array $event ): array {
			_deprecated_function( __METHOD__, '4.5.0' );

			$entity_key = $this->event_contains_subscription( $event ) ? 'subscription' : 'order';

			if ( ! isset( $event['payload'][ $entity_key ] ) ) {
				return array();
			}

			return $event['payload'][ $entity_key ]['entity'];
		}

		/**
		 * Returns payment from the event.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @param array $event Event.
		 *
		 * @return array
		 */
		protected function get_payment_entity_from_event( array $event ): array {
			_deprecated_function( __METHOD__, '4.5.0' );

			return array();
		}

		/**
		 * Returns true if it's a subscription event.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @param array $event Event.
		 *
		 * @return bool
		 */
		protected function event_contains_subscription( array $event ): bool {
			_deprecated_function( __METHOD__, '4.5.0' );

			return in_array( 'subscription', $event['contains'], true );
		}

		/**
		 * Records a payment transaction.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @param array $event Event data.
		 */
		public function record_transaction( array $event ): void {
			_deprecated_function( __METHOD__, '4.5.0' );
		}

		/**
		 * Maps payment button markup.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @param string $default_button Default button.
		 *
		 * @return string
		 */
		protected function map_payment_button( string $default_button ): string {
			_deprecated_function( __METHOD__, '4.5.0' );

			return '';
		}

		/**
		 * Returns nonce name.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @return string
		 */
		protected function get_nonce_name(): string {
			_deprecated_function( __METHOD__, '4.5.0' );

			return '';
		}

		/**
		 * Gets or creates a customer. Returns customer id.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @throws Exception If customer is not found or created.
		 */
		protected function find_or_create_customer_id(): string {
			_deprecated_function( __METHOD__, '4.5.0' );

			throw new Exception(
				__( 'Deprecated', 'learndash' )
			);
		}

		/**
		 * Creates an order.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @param int $amount Amount.
		 *
		 * @return string
		 */
		protected function create_order_id( int $amount ): string {
			_deprecated_function( __METHOD__, '4.5.0' );

			return '';
		}

		/**
		 * Creates a subscription.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @throws Exception Exception.
		 *
		 * @param int $price Price.
		 *
		 * @return string
		 */
		protected function create_subscription_id( int $price ): string {
			_deprecated_function( __METHOD__, '4.5.0' );

			return '';
		}

		/**
		 * Creates a plan or returns an existing plan id.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @param int    $amount   Amount.
		 * @param int    $interval Interval.
		 * @param string $period   Period.
		 *
		 * @return string Plan ID.
		 */
		protected function find_or_create_plan_id( int $amount, int $interval, string $period ): string {
			_deprecated_function( __METHOD__, '4.5.0' );

			return '';
		}

		/**
		 * Creates a plan.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @param array  $plan_options      Plan options.
		 * @param string $plan_options_hash Plan options hash.
		 * @param array  $existing_plans    Existing plans.
		 *
		 * @return string Plan ID.
		 */
		protected function create_plan( array $plan_options, string $plan_options_hash, array $existing_plans ): string {
			_deprecated_function( __METHOD__, '4.5.0' );

			return '';
		}

		/**
		 * Maps transaction meta fields.
		 *
		 * @since 4.2.0
		 * @deprecated 4.5.0
		 *
		 * @param array $event Event.
		 *
		 * @return array
		 */
		protected function map_transaction_meta( array $event ): array {
			_deprecated_function( __METHOD__, '4.5.0' );

			return array();
		}
	}
}