Charge.php

<?php
namespace Dfe\TwoCheckout;
use Dfe\TwoCheckout\LineItem\Additional as LIA;
use Dfe\TwoCheckout\LineItem\Product as LIP;
use Dfe\TwoCheckout\Method as M;
use Magento\Sales\Model\Order\Item as OI;
/**
 * 2016-05-20
 * https://www.2checkout.com/documentation/payment-api/create-sale
 * https://github.com/2Checkout/2checkout-php/wiki/Charge_Authorize#example-usage
 * @method M m()
 * @method Settings s()
 */
final class Charge extends \Df\Payment\Charge {
	/**
	 * 2016-05-23
	 * @used-by self::lineItems()
	 * @return array(string => string)|null
	 */
	private function liDiscount() {$o = $this->o(); return !($a = $o->getDiscountAmount()) ? null :
		LIA::p('coupon', $this->cFromDocF($a) ,df_ccc(': ',
			($d = $o->getDiscountDescription()) === $o->getCouponCode() ? $o['coupon_rule_name'] : null, $d
		))
	;}

	/**
	 * 2016-05-23
	 * @used-by self::lineItems()
	 * @return array(string => string)|null
	 */
	private function liShipping() {$o = $this->o(); return !($a = $o->getShippingAmount()) ? null :
		LIA::p('shipping', $this->cFromDocF($a), $o->getShippingDescription(), true)
	;}

	/**
	 * 2016-05-23
	 * @used-by self::lineItems()
	 * @return array(string => string)|null
	 */
	private function liTax() {return !($a = $this->o()->getTaxAmount()) ? null : LIA::p('tax', $this->cFromDocF($a));}
	
	/**
	 * 2016-05-23
	 * @used-by self::pCharge()
	 * @return array(array(string => string))
	 */
	private function lineItems():array {/** @var array(array(string => string)) $r */
		$r = df_clean(array_merge(
			$this->oiLeafs(function(OI $i) {return LIP::p($this, $i);})
			,[$this->liShipping(), $this->liDiscount(), $this->liTax()]
		));
		$rest = $this->amount() - array_sum(array_map(function(array $item) {return
			floatval($item['price'])
			* dfa($item, 'quantity', 1)
			* ('coupon' === $item['type'] ? -1 : 1)
		;}, $r)); /** @var float $rest */
		return array_merge($r, dff_eq0($rest) ? [] : [LIA::p(
			$rest > 0 ? 'tax' : 'coupon', $this->amountFormat($rest), 'Correction', false, 'correction'
		)]);
	}

	/**
	 * 2016-05-19
	 * @used-by self::p()
	 * @return array(string => mixed)
	 */
	private function pCharge():array {return [
		/**
		 * 2016-05-19
		 * «sellerId»
		 * «Your 2Checkout account number. Required»
		 * https://www.2checkout.com/documentation/payment-api/create-sale
		 * 'sellerId' => S::s()->accountNumber()
		 * несмотря на пример документации https://github.com/2Checkout/2checkout-php/wiki/Charge_Authorize#example-usage
		 * этот параметр указывать не только не обязательно,
		 * но и не имеет смысла, потому что значение перетрётся
		 * заданным при вызове @see \Twocheckout::sellerId()
		 * https://github.com/2Checkout/2checkout-php/blob/cbac8da/lib/Twocheckout/Api/TwocheckoutApi.php#L28
		 *
		 * «privateKey» указывать не нужно и нет смысла по той же причине:
		 * https://github.com/2Checkout/2checkout-php/blob/cbac8da/lib/Twocheckout/Api/TwocheckoutApi.php#L27
		 */
		# 2016-05-19 «Your custom order identifier. Required.» https://www.2checkout.com/documentation/payment-api/create-sale
		'merchantOrderId' => $this->id()
		# 2016-05-19 «The credit card token. Required.» https://www.2checkout.com/documentation/payment-api/create-sale
		,'token' => $this->token()
		/**
		 * 2016-05-19
		 * «Use to specify the currency for the sale. Required.»
		 * https://www.2checkout.com/documentation/payment-api/create-sale
		 *
		 * «As a merchant, it’s important to offer your customers a recognizable,
		 * local buying experience when buying from you.
		 * Localized payment options offer a buyer an improved customer experience
		 * that is both familiar while boosting confidence in their purchase.
		 * 2Checkout offers 87 currencies so that, as a merchant,
		 * you may provide your customer the option
		 * to pay with the currency of their choice.
		 * The information below lists what currencies are available for your country.
		 * Please be aware the availability of currencies vary from region to region,
		 * so this information is a general reference guide and could vary.»
		 * http://help.2checkout.com/articles/Knowledge_Article/2Checkout-Offers-87-Currency-Options
		 */
		,'currency' => $this->currencyC()
		/**
		 * 2016-05-19
		 * «Object that defines the billing address using the attributes specified below.
		 * Required. (Passed as a sub object to the Authorization Object.)»
		 * https://www.2checkout.com/documentation/payment-api/create-sale
		 */
		,'billingAddr' => Address::build($this->addressB(), true)
		/**
		 * 2016-05-19
		 * «Object that defines the shipping address using the attributes specified below.
		 * Optional. Only required if a shipping lineitem is passed.
		 * (Passed as a sub object to the Authorization Object.) »
		 * https://www.2checkout.com/documentation/payment-api/create-sale
		 */
		,'shippingAddr' => Address::build($this->addressS())
		/**
		 * 2016-05-21
		 * Пока не знаю, как передавать нестандартные параметры.
		 * Похоже, для Payment API такой возможности пока нет.
		 * https://mail.google.com/mail/u/0/#sent/154d5138c541ed85
		 * Вариант 'x_custom_username' => $this->o()->getIncrementId()
		 * у меня не работает.
		 *
		 * 2016-05-23
		 * «"Unknown parameters" are not supported with the Payment API,
		 * as custom parameters are not supported with the payment API.
		 * Your site needs to record any custom data with the order, and associate that data with the API's response after the sale is made.»
		 * https://mail.google.com/mail/u/0/#inbox/154d5138c541ed85
		 */
	] + ($this->s()->passOrderItems()
		/**
		 * 2016-05-23
		 * «Array of lineitem objects using the attributes specified below.
		 * Will be returned in the order that they are passed in.
		 * (Passed as a sub object to the Authorization Object.)
		 * (Only Use if you are not passing in total.)»
		 * https://www.2checkout.com/documentation/payment-api/create-sale
		 */
		? ['lineItems' => $this->lineItems()]
		/**
		 * 2016-05-19
		 * «The Sale Total. Format: 0.00-99999999.99,
		 * defaults to 0 if a value isn’t passed in or if value is incorrectly formatted,
		 * no negatives (Only Use if you are not passing in lineItems.)»
		 * https://www.2checkout.com/documentation/payment-api/create-sale
		 */
		: ['total' => $this->amountF()]
	);}

	/**
	 * 2016-05-19
	 * 2017-11-08 Such one-liner is compatible with PHP >= 5.4: https://3v4l.org/LJlDE
	 * @used-by \Dfe\TwoCheckout\Method::charge()
	 * @return array(string => mixed)
	 */
	static function p(M $m):array {return (new self($m))->pCharge();}
}