invoiceninja/app/PaymentDrivers/BasePaymentDriver.php

<?php
/**
 * Invoice Ninja (https://invoiceninja.com)
 *
 * @link https://github.com/invoiceninja/invoiceninja source repository
 *
 * @copyright Copyright (c) 2019. Invoice Ninja LLC (https://invoiceninja.com)
 *
 * @license https://opensource.org/licenses/AAL
 */

namespace App\PaymentDrivers;

use App\Factory\PaymentFactory;
use App\Models\Client;
use App\Models\ClientContact;
use App\Models\CompanyGateway;
use App\Models\GatewayType;
use App\Models\Invoice;
use App\Models\Payment;
use App\Utils\Traits\SystemLogTrait;
use Illuminate\Support\Carbon;
use Illuminate\Support\Facades\Auth;
use Omnipay\Omnipay;


/**
 * Class BasePaymentDriver
 * @package App\PaymentDrivers
 *
 *  Minimum dataset required for payment gateways
 *
 *  $data = [
        'amount' => $invoice->getRequestedAmount(),
        'currency' => $invoice->getCurrencyCode(),
        'returnUrl' => $completeUrl,
        'cancelUrl' => $this->invitation->getLink(),
        'description' => trans('texts.' . $invoice->getEntityType()) . " {$invoice->invoice_number}",
        'transactionId' => $invoice->invoice_number,
        'transactionType' => 'Purchase',
        'clientIp' => Request::getClientIp(),
    ];

 */
class BasePaymentDriver
{
	use SystemLogTrait;
	
	/* The company gateway instance*/
	protected $company_gateway;

	/* The Omnipay payment driver instance*/
	protected $gateway;

	/* The Invitation */
	protected $invitation;

	/* Gateway capabilities */
	protected $refundable = false;
	
	/* Token billing */
	protected $token_billing = false;

	/* Authorise payment methods */
    protected $can_authorise_credit_card = false;


    public function __construct(CompanyGateway $company_gateway, Client $client, $invitation = false)
    {

        $this->company_gateway = $company_gateway;

        $this->invitation = $invitation;

        $this->client = $client;

    }

	/**
	 * Returns the Omnipay driver
	 * @return object Omnipay initialized object
	 */
	protected function gateway()
    {

        $this->gateway = Omnipay::create($this->company_gateway->gateway->provider);
        $this->gateway->initialize((array) $this->company_gateway->getConfig());

        return $this;
    
	}

	/**
	 * Return the configuration fields for the
	 * Gatway
	 * @return array The configuration fields
	 */
	public function getFields()
	{
		return $this->gateway->getDefaultParameters();
	}

	/**
	 * Returns the default gateway type
	 */
    public function gatewayTypes() 
    {
        return [
            GatewayType::CREDIT_CARD,
        ];
    }

    public function getCompanyGatewayId() :int
    {
    	return $this->company_gateway->id;
    }
	/**
	 * Returns whether refunds are possible with the gateway
	 * @return boolean TRUE|FALSE
	 */
	public function getRefundable() :bool
	{
		return $this->refundable;
	}

	/**
	 * Returns whether token billing is possible with the gateway
	 * @return boolean TRUE|FALSE
	 */
	public function getTokenBilling() :bool
	{
		return $this->token_billing;
	}

	/**
	 * Returns whether gateway can 
	 * authorise and credit card.
	 * @return [type] [description]
	 */
	public function canAuthoriseCreditCard() :bool
	{
		return $this->can_authorise_credit_card;
	}

	/**
	 * Refunds a given payment
	 * @return void 
	 */
	public function refundPayment() {}

	public function authorizeCreditCardView(array $data) {}

	public function authorizeCreditCardResponse($request) {}

	public function processPaymentView(array $data) {}
	
	public function processPaymentResponse($request) {}

	/**
	 * Return the contact if possible
	 * 
	 * @return ClientContact The ClientContact object
	 */
	public function getContact()
	{
		if($this->invitation)
			return ClientContact::find($this->invitation->client_contact_id);
		elseif(auth()->guard('contact')->user())
			return auth()->user();
		else
			return false;
	}

	/************************************* Omnipay ******************************************
		authorize($options) - authorize an amount on the customer's card
		completeAuthorize($options) - handle return from off-site gateways after authorization
		capture($options) - capture an amount you have previously authorized
		purchase($options) - authorize and immediately capture an amount on the customer's card
		completePurchase($options) - handle return from off-site gateways after purchase
		refund($options) - refund an already processed transaction
		void($options) - generally can only be called up to 24 hours after submitting a transaction
		acceptNotification() - convert an incoming request from an off-site gateway to a generic notification object for further processing
	*/

    protected function paymentDetails($input) : array
    {

        $data = [
            'currency' => $this->client->getCurrencyCode(),
            'transactionType' => 'Purchase',
            'clientIp' => request()->getClientIp(),
        ];


        return $data;
    }

	public function purchase($data, $items)
	{
		$this->gateway();

		$response =    	$this->gateway
						 ->purchase($data)
						 ->setItems($items)
						 ->send();

		return $response;
		/*
		$this->purchaseResponse = (array)$response->getData();*/
	}
    
	public function completePurchase($data)
	{
		$this->gateway();

		return $this->gateway
					->completePurchase($data)
					->send();
	}

	public function createPayment($data) : Payment
	{

		$payment = PaymentFactory::create($this->client->company->id, $this->client->user->id);
		$payment->client_id = $this->client->id;
		$payment->company_gateway_id = $this->company_gateway->id;
		$payment->status_id = Payment::STATUS_COMPLETED;
		$payment->payment_date = Carbon::now();
		
		return $payment;

	}

	 
    public function attachInvoices(Payment $payment, $hashed_ids) : Payment
    {
        $invoices = Invoice::whereIn('id', $this->transformKeys(explode(",",$hashed_ids)))
                        ->whereClientId($this->client->id)
                        ->get();

		$payment->invoices()->sync($invoices);
        $payment->save();

        return $payment;
  	}
}