Payment::getDelayCapture() - Code Metrics - Inspection of "[FEAT] List entries" - moip/moip-sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#271)

unknown

created 2018-05-09 13:58 UTC

Payment::getDelayCapture() A

↳ Parent: Payment

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Moip\Resource;

use Requests;
use stdClass;

/**
 * Class Payment.
 */
class Payment extends MoipResource
{
    /**
     * @const string
     */
    const PATH = 'payments';

    /**
     * @const string
     */
    const MULTI_PAYMENTS_PATH = 'multipayments';

    /**
     * @const string
     */
    const SIMULATOR_PATH = 'simulador';

    /**
     * Payment means.
     *
     * @const string
     */
    const METHOD_CREDIT_CARD = 'CREDIT_CARD';

    /**
     * Payment means.
     *
     * @const string
     */
    const METHOD_BOLETO = 'BOLETO';

    /**
     * Payment means.
     *
     * @const string
     */
    const METHOD_ONLINE_DEBIT = 'ONLINE_DEBIT';

    /**
     * Payment means.
     *
     * @const string
     */
    const METHOD_WALLET = 'WALLET';

    /**
     * Payment means.
     *
     * @const string
     */
    const METHOD_ONLINE_BANK_DEBIT = 'ONLINE_BANK_DEBIT';

    /**
     * @var \Moip\Resource\Orders
     */
    private $order;

    /**
     * Just created, but not initialized yet.
     */
    const STATUS_CREATED = 'CREATED';

    /**
     * Waiting for the payment.
     */
    const STATUS_WAITING = 'WAITING';

    /**
     * On risk analysis, it may be automatic or manual.
     */
    const STATUS_IN_ANALYSIS = 'IN_ANALYSIS';

    /**
     * The amount was reserved on client credit card, it may be caught or discarded until 5 days.
     */
    const STATUS_PRE_AUTHORIZED = 'PRE_AUTHORIZED';

    /**
     * Payment confirmed by the bank institution.
     */
    const STATUS_AUTHORIZED = 'AUTHORIZED';

    /**
     * Payment cancelled.
     */
    const STATUS_CANCELLED = 'CANCELLED';

    /**
     * Payment refunded.
     */
    const STATUS_REFUNDED = 'REFUNDED';

    /**
     * Paymend reversed (it means that the payment may was not recognized by the client).
     */
    const STATUS_REVERSED = 'REVERSED';

    /**
     * Payment finalized, the amout is on your account.
     */
    const STATUS_SETTLED = 'SETTLED';

    /**
     * @var \Moip\Resource\Multiorders
     */
    private $multiorder;

    /**
     * Initializes new instances.
     */
    protected function initialize()
    {
        $this->data = new stdClass();
        $this->data->installmentCount = 1;
        $this->data->fundingInstrument = new stdClass();
    }

    /**
     * Create a new payment in api MoIP.
     *
     * @return $this
     */
    public function execute()
    {
        if ($this->order !== null) {
            $path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, Orders::PATH, $this->order->getId(), self::PATH);
        } else {
            $path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, Multiorders::PATH, $this->multiorder->getId(), self::MULTI_PAYMENTS_PATH);
        }

        $response = $this->httpRequest($path, Requests::POST, $this);

        return $this->populate($response);
    }

    /**
     * Get an payment and multipayment in MoIP.
     *
     * @param string $id_moip Id MoIP payment
     *
     * @return stdClass
     */
    public function get($id_moip)
    {
        if ($this->isMultipayment($id_moip)) {
            return $this->getByPath(sprintf('/%s/%s/%s', MoipResource::VERSION, self::MULTI_PAYMENTS_PATH, $id_moip));
        }

        return $this->getByPath(sprintf('/%s/%s/%s', MoipResource::VERSION, self::PATH, $id_moip));
    }

    /**
     * Get id MoIP payment.
     *
     *
     * @return \Moip\Resource\Payment
     */
    public function getId()
    {
        return $this->getIfSet('id');
    }

    /**
     * Mount payment structure.
     *
     * @param \stdClass $response
     *
     * @return Payment
     */
    protected function populate(stdClass $response)
    {
        $payment = clone $this;

        $payment->data->id = $this->getIfSet('id', $response);
        $payment->data->status = $this->getIfSet('status', $response);
        $payment->data->delayCapture = $this->getIfSet('delayCapture', $response);
        $payment->data->amount = new stdClass();
        $payment->data->amount->total = $this->getIfSet('total', $response->amount);
        $payment->data->amount->currency = $this->getIfSet('currency', $response->amount);
        $payment->data->installmentCount = $this->getIfSet('installmentCount', $response);
        $payment->data->fundingInstrument = $this->getIfSet('fundingInstrument', $response);
        $payment->data->payments = $this->getIfSet('payments', $response);
        $payment->data->escrows = $this->getIfSet('escrows', $response);
        $payment->data->fees = $this->getIfSet('fees', $response);
        $payment->data->refunds = $this->getIfSet('refunds', $response);
        $payment->data->_links = $this->getIfSet('_links', $response);
        $payment->data->createdAt = $this->getIfSetDateTime('createdAt', $response);
        $payment->data->updatedAt = $this->getIfSetDateTime('updatedAt', $response);

        return $payment;
    }

    /**
     * Refunds.
     *
     * @return Refund
     */
    public function refunds()
    {
        $refund = new Refund($this->moip);
        $refund->setPayment($this);

        return $refund;
    }

    /**
     * Escrows.
     *
     * @return Escrow
     */
    public function escrows()
    {
        $escrow = new Escrow($this->moip);
        $escrow->setId($this->getEscrow()->id);

        return $escrow;
    }

    /**
     * Get payment status.
     *
     * @return string Payment status. Possible values CREATED, WAITING, IN_ANALYSIS, PRE_AUTHORIZED, AUTHORIZED, CANCELLED, REFUNDED, REVERSED, SETTLED
     */
    public function getStatus()
    {
        return $this->getIfSet('status');
    }

    /**
     * get creation time.
     *
     * @return \DateTime
     */
    public function getCreatedAt()
    {
        return $this->data->createdAt;
    }

    /**
     * Returns when the last update occurred.
     *
     * @return \DateTime
     */
    public function getUpdatedAt()
    {
        return $this->data->updatedAt;
    }

    /**
     * Returns the funding instrument.
     *
     * @return stdClass
     */
    public function getFundingInstrument()
    {
        //todo: return a funding instrument object
        return $this->data->fundingInstrument;
    }

    /**
     * Get href to Boleto
     * *.
     *
     * @return stdClass
     */
    public function getHrefBoleto()
    {
        return $this->getIfSet('_links')->payBoleto->redirectHref;
    }

    /**
     * Get LineCode to Boleto
     * *.
     *
     * @return stdClass
     */
    public function getLineCodeBoleto()
    {
        return $this->getIfSet('fundingInstrument')->boleto->lineCode;
    }

    /**
     * Get href from print to Boleto
     * *.
     *
     * @return stdClass
     */
    public function getHrefPrintBoleto()
    {
        return $this->getIfSet('_links')->payBoleto->printHref;
    }

    /**
     * Get Expirate Date to Boleto
     * *.
     *
     * @return stdClass
     */
    public function getExpirationDateBoleto()
    {
        return $this->getIfSet('fundingInstrument')->boleto->expirationDate;
    }

    /**
     * Returns payment amount.
     *
     * @return stdClass
     */
    public function getAmount()
    {
        return $this->data->amount;
    }

    /**
     * Returns delay capture.
     * 
     * @return stdClass
     */
    public function getDelayCapture()
    {
        return $this->data->delayCapture;
    }

    /**
     * Returns escrow.
     *
     * @return stdClass
     */
    public function getEscrow()
    {
        return reset($this->data->escrows);
    }

    /**
     * Returns order.
     *
     * @return Order
     */
    public function getOrder()
    {
        return $this->order;
    }

    /**
     * Returns installment count.
     *
     * @return stdClass
     */
    public function getInstallmentCount()
    {
        return $this->data->installmentCount;
    }

    /**
     * Get payments.
     *
     * @return array
     */
    public function getPayments()
    {
        return $this->getIfSet('payments');
    }

    /**
     * Set means of payment.
     *
     * @param \stdClass $fundingInstrument
     *
     * @return $this
     */
    public function setFundingInstrument(stdClass $fundingInstrument)
    {
        $this->data->fundingInstrument = $fundingInstrument;

        return $this;
    }

    /**
     * Set billet.
     *
     * @param \DateTime|string $expirationDate   Expiration date of a billet.
     * @param string           $logoUri          Logo of billet.
     * @param array            $instructionLines Instructions billet.
     *
     * @return $this
     */
    public function setBoleto($expirationDate, $logoUri, array $instructionLines = [])
    {
        $keys = ['first', 'second', 'third'];

        if (empty($instructionLines)) {
            //Avoid warning in array_combine
            $instructionLines = ['', '', ''];
        }

        if ($expirationDate instanceof \DateTime) {
            $expirationDate = $expirationDate->format('Y-m-d');
        }

        $this->data->fundingInstrument->method = self::METHOD_BOLETO;
        $this->data->fundingInstrument->boleto = new stdClass();
        $this->data->fundingInstrument->boleto->expirationDate = $expirationDate;
        $this->data->fundingInstrument->boleto->instructionLines = array_combine($keys, $instructionLines);
        $this->data->fundingInstrument->boleto->logoUri = $logoUri;

        return $this;
    }

    /**
     * Set credit card holder.
     *
     * @param \Moip\Resource\Customer $holder
     */
    private function setCreditCardHolder(Holder $holder)
    {
        $birthdate = $holder->getBirthDate();
        if ($birthdate instanceof \DateTime) {
            $birthdate = $birthdate->format('Y-m-d');
        }
        $this->data->fundingInstrument->creditCard->holder = new stdClass();
        $this->data->fundingInstrument->creditCard->holder->fullname = $holder->getFullname();
        $this->data->fundingInstrument->creditCard->holder->birthdate = $birthdate;
        $this->data->fundingInstrument->creditCard->holder->taxDocument = new stdClass();
        $this->data->fundingInstrument->creditCard->holder->taxDocument->type = $holder->getTaxDocumentType();
        $this->data->fundingInstrument->creditCard->holder->taxDocument->number = $holder->getTaxDocumentNumber();
        $this->data->fundingInstrument->creditCard->holder->phone = new stdClass();
        $this->data->fundingInstrument->creditCard->holder->phone->countryCode = $holder->getPhoneCountryCode();
        $this->data->fundingInstrument->creditCard->holder->phone->areaCode = $holder->getPhoneAreaCode();
        $this->data->fundingInstrument->creditCard->holder->phone->number = $holder->getPhoneNumber();
        $this->data->fundingInstrument->creditCard->holder->billingAddress = $holder->getBillingAddress();
    }

    /**
     * Set credit cardHash.
     *
     * @param string                  $hash   Credit card hash encripted using Moip.js
     * @param \Moip\Resource\Customer $holder
     * @param bool                    $store  Flag to know if credit card should be saved.
     *
     * @return $this
     */
    public function setCreditCardHash($hash, Holder $holder, $store = true)
    {
        $this->data->fundingInstrument->method = self::METHOD_CREDIT_CARD;
        $this->data->fundingInstrument->creditCard = new stdClass();
        $this->data->fundingInstrument->creditCard->hash = $hash;
        $this->data->fundingInstrument->creditCard->store = $store;
        $this->setCreditCardHolder($holder);

        return $this;
    }

    /**
     * Set credit card
     * Credit card used in a payment.
     * The card when returned within a parent resource is presented in its minimum representation.
     *
     * @param int                     $expirationMonth Card expiration month
     * @param int                     $expirationYear  Year of card expiration.
     * @param string                  $number          Card number.
     * @param int                     $cvc             Card Security Code.
     * @param \Moip\Resource\Customer $holder
     * @param bool                    $store           Flag to know if credit card should be saved.
     *
     * @return $this
     */
    public function setCreditCard($expirationMonth, $expirationYear, $number, $cvc, Holder $holder, $store = true)
    {
        $this->data->fundingInstrument->method = self::METHOD_CREDIT_CARD;
        $this->data->fundingInstrument->creditCard = new stdClass();
        $this->data->fundingInstrument->creditCard->expirationMonth = $expirationMonth;
        $this->data->fundingInstrument->creditCard->expirationYear = $expirationYear;
        $this->data->fundingInstrument->creditCard->number = $number;
        $this->data->fundingInstrument->creditCard->cvc = $cvc;
        $this->data->fundingInstrument->creditCard->store = $store;
        $this->setCreditCardHolder($holder);

        return $this;
    }

    /**
     * Sets data from a previously saved credit card
     * Credit card used in a payment.
     * Used when the credit card was saved with the customer and the payment made in a future date.
     *
     * @param string $creditCardId MoIP's Credit Card Id.
     * @param int    $cvc          Card Security Code.
     *
     * @return $this
     */
    public function setCreditCardSaved($creditCardId, $cvc)
    {
        $this->data->fundingInstrument = new stdClass();
        $this->data->fundingInstrument->method = self::METHOD_CREDIT_CARD;
        $this->data->fundingInstrument->creditCard = new stdClass();
        $this->data->fundingInstrument->creditCard->id = $creditCardId;
        $this->data->fundingInstrument->creditCard->cvc = $cvc;

        return $this;
    }

    /**
     * Set installment count.
     *
     * @param int $installmentCount
     *
     * @return $this
     */
    public function setInstallmentCount($installmentCount)
    {
        $this->data->installmentCount = $installmentCount;

        return $this;
    }

    /**
     * Set statement descriptor.
     *
     * @param string $statementDescriptor
     *
     * @return $this
     */
    public function setStatementDescriptor($statementDescriptor)
    {
        $this->data->statementDescriptor = $statementDescriptor;

        return $this;
    }

    /**
     * Set payment means made available by banks.
     *
     * @param string           $bankNumber     Bank number. Possible values: 001, 237, 341, 041.
     * @param \DateTime|string $expirationDate Date of expiration debit.
     * @param string           $returnUri      Return Uri.
     *
     * @return $this
     */
    public function setOnlineBankDebit($bankNumber, $expirationDate, $returnUri)
    {
        if ($expirationDate instanceof \DateTime) {
            $expirationDate = $expirationDate->format('Y-m-d');
        }
        $this->data->fundingInstrument->method = self::METHOD_ONLINE_BANK_DEBIT;
        $this->data->fundingInstrument->onlineBankDebit = new stdClass();
        $this->data->fundingInstrument->onlineBankDebit->bankNumber = $bankNumber;
        $this->data->fundingInstrument->onlineBankDebit->expirationDate = $expirationDate;
        $this->data->fundingInstrument->onlineBankDebit->returnUri = $returnUri;

        return $this;
    }

    /**
     * Set Multiorders.
     *
     * @param \Moip\Resource\Multiorders $multiorder
     *
     * @return $this
     */
    public function setMultiorder(Multiorders $multiorder)
    {
        $this->multiorder = $multiorder;

        return $this;
    }

    /**
     * Set order.
     *
     * @param \Moip\Resource\Orders $order
     *
     * @return $this
     */
    public function setOrder(Orders $order)
    {
        $this->order = $order;

        return $this;
    }

    /**
     * Turns on a delay on credit card payment capture (pre-authorization).
     *
     * @return $this
     */
    public function setDelayCapture($delayCapture = true)
    {
        $this->data->delayCapture = $delayCapture;

        return $this;
    }

    /**
     * Set escrow to a payment.
     *
     * @param string $description
     *
     * @return $this
     */
    public function setEscrow($description)
    {
        $this->data->escrow = new stdClass();
        $this->data->escrow->description = $description;

        return $this;
    }

    /**
     * Capture a pre-authorized amount on a credit card payment.
     *
     * @throws \Exception
     *
     * @return Payment
     */
    public function capture()

    {
        $path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, self::PATH, $this->getId(), 'capture');
        if ($this->isMultipayment($this->getId())) {
            $path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, self::MULTI_PAYMENTS_PATH, $this->getId(), 'capture');
        }

        $response = $this->httpRequest($path, Requests::POST, $this);

        return $this->populate($response);
    }

    /**
     * Cancel a pre-authorized amount on a credit card payment.
     *
     * @throws \Exception
     *
     * @return Payment
     */
    public function cancel()

    {
        $path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, self::PATH, $this->getId(), 'void');
        if ($this->isMultipayment($this->getId())) {
            $path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, self::MULTI_PAYMENTS_PATH, $this->getId(), 'void');
        }

        $response = $this->httpRequest($path, Requests::POST, $this);

        return $this->populate($response);
    }

    /**
     * Cancel a pre-authorized amount on a credit card payment.
     *
     * @throws \Exception
     *
     * @return Payment
     */
    public function avoid()
    {
        trigger_error('The function \'avoid\' is deprecated, use \'cancel\' instead', E_USER_NOTICE);

        return $this->cancel();
    }

    /**
     * Authorize a payment (Available only in sandbox to credit card payment with status IN_ANALYSIS and billet payment with status WAITING).
     *
     * @return bool
     */
    public function authorize($amount = null)
    {
        if (is_null($amount)) {
            $amount = $this->getAmount()->total;
        }
        $path = sprintf('/%s/%s?payment_id=%s&amount=%s', self::SIMULATOR_PATH, 'authorize', $this->getId(), $amount);
        $response = $this->httpRequest($path, Requests::GET);

        if (empty($response)) {
            return true;
        }

        return false;
    }

    private function isMultipayment($paymentId)
    {
        return 0 === strpos($paymentId, 'MPY');
    }
}


1		<?php
2
3		namespace Moip\Resource;
4
5		use Requests;
6		use stdClass;
7
8		/**
9		* Class Payment.
10		*/
11		class Payment extends MoipResource
12		{
13		/**
14		* @const string
15		*/
16		const PATH = 'payments';
17
18		/**
19		* @const string
20		*/
21		const MULTI_PAYMENTS_PATH = 'multipayments';
22
23		/**
24		* @const string
25		*/
26		const SIMULATOR_PATH = 'simulador';
27
28		/**
29		* Payment means.
30		*
31		* @const string
32		*/
33		const METHOD_CREDIT_CARD = 'CREDIT_CARD';
34
35		/**
36		* Payment means.
37		*
38		* @const string
39		*/
40		const METHOD_BOLETO = 'BOLETO';
41
42		/**
43		* Payment means.
44		*
45		* @const string
46		*/
47		const METHOD_ONLINE_DEBIT = 'ONLINE_DEBIT';
48
49		/**
50		* Payment means.
51		*
52		* @const string
53		*/
54		const METHOD_WALLET = 'WALLET';
55
56		/**
57		* Payment means.
58		*
59		* @const string
60		*/
61		const METHOD_ONLINE_BANK_DEBIT = 'ONLINE_BANK_DEBIT';
62
63		/**
64		* @var \Moip\Resource\Orders
65		*/
66		private $order;
67
68		/**
69		* Just created, but not initialized yet.
70		*/
71		const STATUS_CREATED = 'CREATED';
72
73		/**
74		* Waiting for the payment.
75		*/
76		const STATUS_WAITING = 'WAITING';
77
78		/**
79		* On risk analysis, it may be automatic or manual.
80		*/
81		const STATUS_IN_ANALYSIS = 'IN_ANALYSIS';
82
83		/**
84		* The amount was reserved on client credit card, it may be caught or discarded until 5 days.
85		*/
86		const STATUS_PRE_AUTHORIZED = 'PRE_AUTHORIZED';
87
88		/**
89		* Payment confirmed by the bank institution.
90		*/
91		const STATUS_AUTHORIZED = 'AUTHORIZED';
92
93		/**
94		* Payment cancelled.
95		*/
96		const STATUS_CANCELLED = 'CANCELLED';
97
98		/**
99		* Payment refunded.
100		*/
101		const STATUS_REFUNDED = 'REFUNDED';
102
103		/**
104		* Paymend reversed (it means that the payment may was not recognized by the client).
105		*/
106		const STATUS_REVERSED = 'REVERSED';
107
108		/**
109		* Payment finalized, the amout is on your account.
110		*/
111		const STATUS_SETTLED = 'SETTLED';
112
113		/**
114		* @var \Moip\Resource\Multiorders
115		*/
116		private $multiorder;
117
118		/**
119		* Initializes new instances.
120		*/
121		protected function initialize()
122		{
123		$this->data = new stdClass();
124		$this->data->installmentCount = 1;
125		$this->data->fundingInstrument = new stdClass();
126		}
127
128		/**
129		* Create a new payment in api MoIP.
130		*
131		* @return $this
132		*/
133		public function execute()
134		{
135		if ($this->order !== null) {
136		$path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, Orders::PATH, $this->order->getId(), self::PATH);
137		} else {
138		$path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, Multiorders::PATH, $this->multiorder->getId(), self::MULTI_PAYMENTS_PATH);
139		}
140
141		$response = $this->httpRequest($path, Requests::POST, $this);
142
143		return $this->populate($response);
144		}
145
146		/**
147		* Get an payment and multipayment in MoIP.
148		*
149		* @param string $id_moip Id MoIP payment
150		*
151		* @return stdClass
152		*/
153		public function get($id_moip)
154		{
155		if ($this->isMultipayment($id_moip)) {
156		return $this->getByPath(sprintf('/%s/%s/%s', MoipResource::VERSION, self::MULTI_PAYMENTS_PATH, $id_moip));
157		}
158
159		return $this->getByPath(sprintf('/%s/%s/%s', MoipResource::VERSION, self::PATH, $id_moip));
160		}
161
162		/**
163		* Get id MoIP payment.
164		*
165		*
166		* @return \Moip\Resource\Payment
167		*/
168		public function getId()
169		{
170		return $this->getIfSet('id');
171		}
172
173		/**
174		* Mount payment structure.
175		*
176		* @param \stdClass $response
177		*
178		* @return Payment
179		*/
180		protected function populate(stdClass $response)
181		{
182		$payment = clone $this;
183
184		$payment->data->id = $this->getIfSet('id', $response);
185		$payment->data->status = $this->getIfSet('status', $response);
186		$payment->data->delayCapture = $this->getIfSet('delayCapture', $response);
187		$payment->data->amount = new stdClass();
188		$payment->data->amount->total = $this->getIfSet('total', $response->amount);
189		$payment->data->amount->currency = $this->getIfSet('currency', $response->amount);
190		$payment->data->installmentCount = $this->getIfSet('installmentCount', $response);
191		$payment->data->fundingInstrument = $this->getIfSet('fundingInstrument', $response);
192		$payment->data->payments = $this->getIfSet('payments', $response);
193		$payment->data->escrows = $this->getIfSet('escrows', $response);
194		$payment->data->fees = $this->getIfSet('fees', $response);
195		$payment->data->refunds = $this->getIfSet('refunds', $response);
196		$payment->data->_links = $this->getIfSet('_links', $response);
197		$payment->data->createdAt = $this->getIfSetDateTime('createdAt', $response);
198		$payment->data->updatedAt = $this->getIfSetDateTime('updatedAt', $response);
199
200		return $payment;
201		}
202
203		/**
204		* Refunds.
205		*
206		* @return Refund
207		*/
208		public function refunds()
209		{
210		$refund = new Refund($this->moip);
211		$refund->setPayment($this);
212
213		return $refund;
214		}
215
216		/**
217		* Escrows.
218		*
219		* @return Escrow
220		*/
221		public function escrows()
222		{
223		$escrow = new Escrow($this->moip);
224		$escrow->setId($this->getEscrow()->id);
225
226		return $escrow;
227		}
228
229		/**
230		* Get payment status.
231		*
232		* @return string Payment status. Possible values CREATED, WAITING, IN_ANALYSIS, PRE_AUTHORIZED, AUTHORIZED, CANCELLED, REFUNDED, REVERSED, SETTLED
233		*/
234		public function getStatus()
235		{
236		return $this->getIfSet('status');
237		}
238
239		/**
240		* get creation time.
241		*
242		* @return \DateTime
243		*/
244		public function getCreatedAt()
245		{
246		return $this->data->createdAt;
247		}
248
249		/**
250		* Returns when the last update occurred.
251		*
252		* @return \DateTime
253		*/
254		public function getUpdatedAt()
255		{
256		return $this->data->updatedAt;
257		}
258
259		/**
260		* Returns the funding instrument.
261		*
262		* @return stdClass
263		*/
264		public function getFundingInstrument()
265		{
266		//todo: return a funding instrument object
267		return $this->data->fundingInstrument;
268		}
269
270		/**
271		* Get href to Boleto
272		* *.
273		*
274		* @return stdClass
275		*/
276		public function getHrefBoleto()
277		{
278		return $this->getIfSet('_links')->payBoleto->redirectHref;
279		}
280
281		/**
282		* Get LineCode to Boleto
283		* *.
284		*
285		* @return stdClass
286		*/
287		public function getLineCodeBoleto()
288		{
289		return $this->getIfSet('fundingInstrument')->boleto->lineCode;
290		}
291
292		/**
293		* Get href from print to Boleto
294		* *.
295		*
296		* @return stdClass
297		*/
298		public function getHrefPrintBoleto()
299		{
300		return $this->getIfSet('_links')->payBoleto->printHref;
301		}
302
303		/**
304		* Get Expirate Date to Boleto
305		* *.
306		*
307		* @return stdClass
308		*/
309		public function getExpirationDateBoleto()
310		{
311		return $this->getIfSet('fundingInstrument')->boleto->expirationDate;
312		}
313
314		/**
315		* Returns payment amount.
316		*
317		* @return stdClass
318		*/
319		public function getAmount()
320		{
321		return $this->data->amount;
322		}
323
324		/**
325		* Returns delay capture.
326		*
327		* @return stdClass
328		*/
329		public function getDelayCapture()
330		{
331		return $this->data->delayCapture;
332		}
333
334		/**
335		* Returns escrow.
336		*
337		* @return stdClass
338		*/
339		public function getEscrow()
340		{
341		return reset($this->data->escrows);
342		}
343
344		/**
345		* Returns order.
346		*
347		* @return Order
348		*/
349		public function getOrder()
350		{
351		return $this->order;
352		}
353
354		/**
355		* Returns installment count.
356		*
357		* @return stdClass
358		*/
359		public function getInstallmentCount()
360		{
361		return $this->data->installmentCount;
362		}
363
364		/**
365		* Get payments.
366		*
367		* @return array
368		*/
369		public function getPayments()
370		{
371		return $this->getIfSet('payments');
372		}
373
374		/**
375		* Set means of payment.
376		*
377		* @param \stdClass $fundingInstrument
378		*
379		* @return $this
380		*/
381		public function setFundingInstrument(stdClass $fundingInstrument)
382		{
383		$this->data->fundingInstrument = $fundingInstrument;
384
385		return $this;
386		}
387
388		/**
389		* Set billet.
390		*
391		* @param \DateTime\|string $expirationDate Expiration date of a billet.
392		* @param string $logoUri Logo of billet.
393		* @param array $instructionLines Instructions billet.
394		*
395		* @return $this
396		*/
397		public function setBoleto($expirationDate, $logoUri, array $instructionLines = [])
398		{
399		$keys = ['first', 'second', 'third'];
400
401		if (empty($instructionLines)) {
402		//Avoid warning in array_combine
403		$instructionLines = ['', '', ''];
404		}
405
406		if ($expirationDate instanceof \DateTime) {
407		$expirationDate = $expirationDate->format('Y-m-d');
408		}
409
410		$this->data->fundingInstrument->method = self::METHOD_BOLETO;
411		$this->data->fundingInstrument->boleto = new stdClass();
412		$this->data->fundingInstrument->boleto->expirationDate = $expirationDate;
413		$this->data->fundingInstrument->boleto->instructionLines = array_combine($keys, $instructionLines);
414		$this->data->fundingInstrument->boleto->logoUri = $logoUri;
415
416		return $this;
417		}
418
419		/**
420		* Set credit card holder.
421		*
422		* @param \Moip\Resource\Customer $holder
423		*/
424		private function setCreditCardHolder(Holder $holder)
425		{
426		$birthdate = $holder->getBirthDate();
427		if ($birthdate instanceof \DateTime) {
428		$birthdate = $birthdate->format('Y-m-d');
429		}
430		$this->data->fundingInstrument->creditCard->holder = new stdClass();
431		$this->data->fundingInstrument->creditCard->holder->fullname = $holder->getFullname();
432		$this->data->fundingInstrument->creditCard->holder->birthdate = $birthdate;
433		$this->data->fundingInstrument->creditCard->holder->taxDocument = new stdClass();
434		$this->data->fundingInstrument->creditCard->holder->taxDocument->type = $holder->getTaxDocumentType();
435		$this->data->fundingInstrument->creditCard->holder->taxDocument->number = $holder->getTaxDocumentNumber();
436		$this->data->fundingInstrument->creditCard->holder->phone = new stdClass();
437		$this->data->fundingInstrument->creditCard->holder->phone->countryCode = $holder->getPhoneCountryCode();
438		$this->data->fundingInstrument->creditCard->holder->phone->areaCode = $holder->getPhoneAreaCode();
439		$this->data->fundingInstrument->creditCard->holder->phone->number = $holder->getPhoneNumber();
440		$this->data->fundingInstrument->creditCard->holder->billingAddress = $holder->getBillingAddress();
441		}
442
443		/**
444		* Set credit cardHash.
445		*
446		* @param string $hash Credit card hash encripted using Moip.js
447		* @param \Moip\Resource\Customer $holder
448		* @param bool $store Flag to know if credit card should be saved.
449		*
450		* @return $this
451		*/
452		public function setCreditCardHash($hash, Holder $holder, $store = true)
453		{
454		$this->data->fundingInstrument->method = self::METHOD_CREDIT_CARD;
455		$this->data->fundingInstrument->creditCard = new stdClass();
456		$this->data->fundingInstrument->creditCard->hash = $hash;
457		$this->data->fundingInstrument->creditCard->store = $store;
458		$this->setCreditCardHolder($holder);
459
460		return $this;
461		}
462
463		/**
464		* Set credit card
465		* Credit card used in a payment.
466		* The card when returned within a parent resource is presented in its minimum representation.
467		*
468		* @param int $expirationMonth Card expiration month
469		* @param int $expirationYear Year of card expiration.
470		* @param string $number Card number.
471		* @param int $cvc Card Security Code.
472		* @param \Moip\Resource\Customer $holder
473		* @param bool $store Flag to know if credit card should be saved.
474		*
475		* @return $this
476		*/
477		public function setCreditCard($expirationMonth, $expirationYear, $number, $cvc, Holder $holder, $store = true)
478		{
479		$this->data->fundingInstrument->method = self::METHOD_CREDIT_CARD;
480		$this->data->fundingInstrument->creditCard = new stdClass();
481		$this->data->fundingInstrument->creditCard->expirationMonth = $expirationMonth;
482		$this->data->fundingInstrument->creditCard->expirationYear = $expirationYear;
483		$this->data->fundingInstrument->creditCard->number = $number;
484		$this->data->fundingInstrument->creditCard->cvc = $cvc;
485		$this->data->fundingInstrument->creditCard->store = $store;
486		$this->setCreditCardHolder($holder);
487
488		return $this;
489		}
490
491		/**
492		* Sets data from a previously saved credit card
493		* Credit card used in a payment.
494		* Used when the credit card was saved with the customer and the payment made in a future date.
495		*
496		* @param string $creditCardId MoIP's Credit Card Id.
497		* @param int $cvc Card Security Code.
498		*
499		* @return $this
500		*/
501		public function setCreditCardSaved($creditCardId, $cvc)
502		{
503		$this->data->fundingInstrument = new stdClass();
504		$this->data->fundingInstrument->method = self::METHOD_CREDIT_CARD;
505		$this->data->fundingInstrument->creditCard = new stdClass();
506		$this->data->fundingInstrument->creditCard->id = $creditCardId;
507		$this->data->fundingInstrument->creditCard->cvc = $cvc;
508
509		return $this;
510		}
511
512		/**
513		* Set installment count.
514		*
515		* @param int $installmentCount
516		*
517		* @return $this
518		*/
519		public function setInstallmentCount($installmentCount)
520		{
521		$this->data->installmentCount = $installmentCount;
522
523		return $this;
524		}
525
526		/**
527		* Set statement descriptor.
528		*
529		* @param string $statementDescriptor
530		*
531		* @return $this
532		*/
533		public function setStatementDescriptor($statementDescriptor)
534		{
535		$this->data->statementDescriptor = $statementDescriptor;
536
537		return $this;
538		}
539
540		/**
541		* Set payment means made available by banks.
542		*
543		* @param string $bankNumber Bank number. Possible values: 001, 237, 341, 041.
544		* @param \DateTime\|string $expirationDate Date of expiration debit.
545		* @param string $returnUri Return Uri.
546		*
547		* @return $this
548		*/
549		public function setOnlineBankDebit($bankNumber, $expirationDate, $returnUri)
550		{
551		if ($expirationDate instanceof \DateTime) {
552		$expirationDate = $expirationDate->format('Y-m-d');
553		}
554		$this->data->fundingInstrument->method = self::METHOD_ONLINE_BANK_DEBIT;
555		$this->data->fundingInstrument->onlineBankDebit = new stdClass();
556		$this->data->fundingInstrument->onlineBankDebit->bankNumber = $bankNumber;
557		$this->data->fundingInstrument->onlineBankDebit->expirationDate = $expirationDate;
558		$this->data->fundingInstrument->onlineBankDebit->returnUri = $returnUri;
559
560		return $this;
561		}
562
563		/**
564		* Set Multiorders.
565		*
566		* @param \Moip\Resource\Multiorders $multiorder
567		*
568		* @return $this
569		*/
570		public function setMultiorder(Multiorders $multiorder)
571		{
572		$this->multiorder = $multiorder;
573
574		return $this;
575		}
576
577		/**
578		* Set order.
579		*
580		* @param \Moip\Resource\Orders $order
581		*
582		* @return $this
583		*/
584		public function setOrder(Orders $order)
585		{
586		$this->order = $order;
587
588		return $this;
589		}
590
591		/**
592		* Turns on a delay on credit card payment capture (pre-authorization).
593		*
594		* @return $this
595		*/
596		public function setDelayCapture($delayCapture = true)
597		{
598		$this->data->delayCapture = $delayCapture;
599
600		return $this;
601		}
602
603		/**
604		* Set escrow to a payment.
605		*
606		* @param string $description
607		*
608		* @return $this
609		*/
610		public function setEscrow($description)
611		{
612		$this->data->escrow = new stdClass();
613		$this->data->escrow->description = $description;
614
615		return $this;
616		}
617
618		/**
619		* Capture a pre-authorized amount on a credit card payment.
620		*
621		* @throws \Exception
622		*
623		* @return Payment
624		*/
625	View Code Duplication	public function capture()
		0 ignored issues – show Duplication introduced 2017-10-09 17:47 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
626		{
627		$path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, self::PATH, $this->getId(), 'capture');
628		if ($this->isMultipayment($this->getId())) {
629		$path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, self::MULTI_PAYMENTS_PATH, $this->getId(), 'capture');
630		}
631
632		$response = $this->httpRequest($path, Requests::POST, $this);
633
634		return $this->populate($response);
635		}
636
637		/**
638		* Cancel a pre-authorized amount on a credit card payment.
639		*
640		* @throws \Exception
641		*
642		* @return Payment
643		*/
644	View Code Duplication	public function cancel()
		0 ignored issues – show Duplication introduced 2017-10-09 17:47 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
645		{
646		$path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, self::PATH, $this->getId(), 'void');
647		if ($this->isMultipayment($this->getId())) {
648		$path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, self::MULTI_PAYMENTS_PATH, $this->getId(), 'void');
649		}
650
651		$response = $this->httpRequest($path, Requests::POST, $this);
652
653		return $this->populate($response);
654		}
655
656		/**
657		* Cancel a pre-authorized amount on a credit card payment.
658		*
659		* @throws \Exception
660		*
661		* @return Payment
662		*/
663		public function avoid()
664		{
665		trigger_error('The function \'avoid\' is deprecated, use \'cancel\' instead', E_USER_NOTICE);
666
667		return $this->cancel();
668		}
669
670		/**
671		* Authorize a payment (Available only in sandbox to credit card payment with status IN_ANALYSIS and billet payment with status WAITING).
672		*
673		* @return bool
674		*/
675		public function authorize($amount = null)
676		{
677		if (is_null($amount)) {
678		$amount = $this->getAmount()->total;
679		}
680		$path = sprintf('/%s/%s?payment_id=%s&amount=%s', self::SIMULATOR_PATH, 'authorize', $this->getId(), $amount);
681		$response = $this->httpRequest($path, Requests::GET);
682
683		if (empty($response)) {
684		return true;
685		}
686
687		return false;
688		}
689
690		private function isMultipayment($paymentId)
691		{
692		return 0 === strpos($paymentId, 'MPY');
693		}
694		}
695

moip / moip-sdk-php

Pull Request — master (#271)

Payment::getDelayCapture() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like