File "PaymentPreferences.php"

Full Path: /home/siazco/grocery.siazco.se/wp-content/plugins/woocommerce-paypal-payments/modules/ppcp-api-client/src/Entity/PaymentPreferences.php
File size: 2.25 KB
MIME-type: text/x-php
Charset: utf-8

<?php
/**
 * The Payment Preferences object.
 *
 * @package WooCommerce\PayPalCommerce\ApiClient\Entity
 */

declare(strict_types=1);

namespace WooCommerce\PayPalCommerce\ApiClient\Entity;

/**
 * Class PaymentPreferences
 */
class PaymentPreferences {

	/**
	 * Setup fee.
	 *
	 * @var array
	 */
	private $setup_fee;

	/**
	 * Auto bill outstanding.
	 *
	 * @var bool
	 */
	private $auto_bill_outstanding;

	/**
	 * Setup fee failure action.
	 *
	 * @var string
	 */
	private $setup_fee_failure_action;

	/**
	 * Payment failure threshold.
	 *
	 * @var int
	 */
	private $payment_failure_threshold;

	/**
	 * PaymentPreferences constructor.
	 *
	 * @param array  $setup_fee Setup fee.
	 * @param bool   $auto_bill_outstanding Auto bill outstanding.
	 * @param string $setup_fee_failure_action Setup fee failure action.
	 * @param int    $payment_failure_threshold payment failure threshold.
	 */
	public function __construct(
		array $setup_fee,
		bool $auto_bill_outstanding = true,
		string $setup_fee_failure_action = 'CONTINUE',
		int $payment_failure_threshold = 3
	) {

		$this->setup_fee                 = $setup_fee;
		$this->auto_bill_outstanding     = $auto_bill_outstanding;
		$this->setup_fee_failure_action  = $setup_fee_failure_action;
		$this->payment_failure_threshold = $payment_failure_threshold;
	}

	/**
	 * Setup fee.
	 *
	 * @return array
	 */
	public function setup_fee(): array {
		return $this->setup_fee;
	}

	/**
	 * Auto bill outstanding.
	 *
	 * @return bool
	 */
	public function auto_bill_outstanding(): bool {
		return $this->auto_bill_outstanding;
	}

	/**
	 * Setup fee failure action.
	 *
	 * @return string
	 */
	public function setup_fee_failure_action(): string {
		return $this->setup_fee_failure_action;
	}

	/**
	 * Payment failure threshold.
	 *
	 * @return int
	 */
	public function payment_failure_threshold(): int {
		return $this->payment_failure_threshold;
	}

	/**
	 * Returns Payment Preferences as array.
	 *
	 * @return array
	 */
	public function to_array():array {
		return array(
			'setup_fee'                 => $this->setup_fee(),
			'auto_bill_outstanding'     => $this->auto_bill_outstanding(),
			'setup_fee_failure_action'  => $this->setup_fee_failure_action(),
			'payment_failure_threshold' => $this->payment_failure_threshold(),
		);
	}
}