Payment::getLineCodeBoleto() - Code Metrics - Inspection of "[RELEASE] v2.0.0" - moip/moip-sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4a5840...1f0278 )

unknown

created 2017-09-29 20:29 UTC

Payment::getLineCodeBoleto() 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->order !== null) {
            return $this->getByPath(sprintf('/%s/%s/%s', MoipResource::VERSION, self::PATH, $id_moip));
        }

        return $this->getByPath(sprintf('/%s/%s/%s', MoipResource::VERSION, self::MULTI_PAYMENTS_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->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 escrow.
     *
     * @return stdClass
     */
    public function getEscrow()
    {
        return reset($this->data->escrows);
    }

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

    /**
     * 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(Customer $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, Customer $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, Customer $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()
    {
        $this->data->delayCapture = true;

        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()
    {
        if (is_null($this->order)) {
            throw new \Exception('Sorry, multipayment capture is not available on this version');
        }
        $path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, self::PATH, $this->getId(), 'capture');

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

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

    /**
     * Avoid a pre-authorized amount on a credit card payment.
     *
     * @throws \Exception
     *
     * @return Payment
     */
    public function avoid()
    {
        if (is_null($this->order)) {
            throw new \Exception('Sorry, multipayment capture is not available on this version');
        }
        $path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, self::PATH, $this->getId(), 'void');

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

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

    /**
     * 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;
    }
}


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->order !== null) {
156			return $this->getByPath(sprintf('/%s/%s/%s', MoipResource::VERSION, self::PATH, $id_moip));
157			}
158
159			return $this->getByPath(sprintf('/%s/%s/%s', MoipResource::VERSION, self::MULTI_PAYMENTS_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->escrows = $this->getIfSet('escrows', $response);
193			$payment->data->fees = $this->getIfSet('fees', $response);
194			$payment->data->refunds = $this->getIfSet('refunds', $response);
195			$payment->data->_links = $this->getIfSet('_links', $response);
196			$payment->data->createdAt = $this->getIfSetDateTime('createdAt', $response);
197			$payment->data->updatedAt = $this->getIfSetDateTime('updatedAt', $response);
198
199			return $payment;
200			}
201
202			/**
203			* Refunds.
204			*
205			* @return Refund
206			*/
207			public function refunds()
208			{
209			$refund = new Refund($this->moip);
210			$refund->setPayment($this);
211
212			return $refund;
213			}
214
215			/**
216			* Escrows.
217			*
218			* @return Escrow
219			*/
220			public function escrows()
221			{
222			$escrow = new Escrow($this->moip);
223			$escrow->setId($this->getEscrow()->id);
224
225			return $escrow;
226			}
227
228			/**
229			* Get payment status.
230			*
231			* @return string Payment status. Possible values CREATED, WAITING, IN_ANALYSIS, PRE_AUTHORIZED, AUTHORIZED, CANCELLED, REFUNDED, REVERSED, SETTLED
232			*/
233			public function getStatus()
234			{
235			return $this->getIfSet('status');
236			}
237
238			/**
239			* get creation time.
240			*
241			* @return \DateTime
242			*/
243			public function getCreatedAt()
244			{
245			return $this->data->createdAt;
246			}
247
248			/**
249			* Returns when the last update occurred.
250			*
251			* @return \DateTime
252			*/
253			public function getUpdatedAt()
254			{
255			return $this->data->updatedAt;
256			}
257
258			/**
259			* Returns the funding instrument.
260			*
261			* @return stdClass
262			*/
263			public function getFundingInstrument()
264			{
265			//todo: return a funding instrument object
266			return $this->data->fundingInstrument;
267			}
268
269			/**
270			* Get href to Boleto
271			* *.
272			*
273			* @return stdClass
274			*/
275			public function getHrefBoleto()
276			{
277			return $this->getIfSet('_links')->payBoleto->redirectHref;
278			}
279
280			/**
281			* Get LineCode to Boleto
282			* *.
283			*
284			* @return stdClass
285			*/
286			public function getLineCodeBoleto()
287			{
288			return $this->getIfSet('fundingInstrument')->boleto->lineCode;
289			}
290
291			/**
292			* Get href from print to Boleto
293			* *.
294			*
295			* @return stdClass
296			*/
297			public function getHrefPrintBoleto()
298			{
299			return $this->getIfSet('_links')->payBoleto->printHref;
300			}
301
302			/**
303			* Get Expirate Date to Boleto
304			* *.
305			*
306			* @return stdClass
307			*/
308			public function getExpirationDateBoleto()
309			{
310			return $this->getIfSet('fundingInstrument')->boleto->expirationDate;
311			}
312
313			/**
314			* Returns payment amount.
315			*
316			* @return stdClass
317			*/
318			public function getAmount()
319			{
320			return $this->data->amount;
321			}
322
323			/**
324			* Returns escrow.
325			*
326			* @return stdClass
327			*/
328			public function getEscrow()
329			{
330			return reset($this->data->escrows);
331			}
332
333			/**
334			* Returns installment count.
335			*
336			* @return stdClass
337			*/
338			public function getInstallmentCount()
339			{
340			return $this->data->installmentCount;
341			}
342
343			/**
344			* Set means of payment.
345			*
346			* @param \stdClass $fundingInstrument
347			*
348			* @return $this
349			*/
350			public function setFundingInstrument(stdClass $fundingInstrument)
351			{
352			$this->data->fundingInstrument = $fundingInstrument;
353
354			return $this;
355			}
356
357			/**
358			* Set billet.
359			*
360			* @param \DateTime\|string $expirationDate Expiration date of a billet.
361			* @param string $logoUri Logo of billet.
362			* @param array $instructionLines Instructions billet.
363			*
364			* @return $this
365			*/
366			public function setBoleto($expirationDate, $logoUri, array $instructionLines = [])
367			{
368			$keys = ['first', 'second', 'third'];
369
370			if (empty($instructionLines)) {
371			//Avoid warning in array_combine
372			$instructionLines = ['', '', ''];
373			}
374
375			if ($expirationDate instanceof \DateTime) {
376			$expirationDate = $expirationDate->format('Y-m-d');
377			}
378
379			$this->data->fundingInstrument->method = self::METHOD_BOLETO;
380			$this->data->fundingInstrument->boleto = new stdClass();
381			$this->data->fundingInstrument->boleto->expirationDate = $expirationDate;
382			$this->data->fundingInstrument->boleto->instructionLines = array_combine($keys, $instructionLines);
383			$this->data->fundingInstrument->boleto->logoUri = $logoUri;
384
385			return $this;
386			}
387
388			/**
389			* Set credit card holder.
390			*
391			* @param \Moip\Resource\Customer $holder
392			*/
393			private function setCreditCardHolder(Customer $holder)
394			{
395			$birthdate = $holder->getBirthDate();
396			if ($birthdate instanceof \DateTime) {
397			$birthdate = $birthdate->format('Y-m-d');
398			}
399			$this->data->fundingInstrument->creditCard->holder = new stdClass();
400			$this->data->fundingInstrument->creditCard->holder->fullname = $holder->getFullname();
401			$this->data->fundingInstrument->creditCard->holder->birthdate = $birthdate;
402			$this->data->fundingInstrument->creditCard->holder->taxDocument = new stdClass();
403			$this->data->fundingInstrument->creditCard->holder->taxDocument->type = $holder->getTaxDocumentType();
404			$this->data->fundingInstrument->creditCard->holder->taxDocument->number = $holder->getTaxDocumentNumber();
405			$this->data->fundingInstrument->creditCard->holder->phone = new stdClass();
406			$this->data->fundingInstrument->creditCard->holder->phone->countryCode = $holder->getPhoneCountryCode();
407			$this->data->fundingInstrument->creditCard->holder->phone->areaCode = $holder->getPhoneAreaCode();
408			$this->data->fundingInstrument->creditCard->holder->phone->number = $holder->getPhoneNumber();
409			$this->data->fundingInstrument->creditCard->holder->billingAddress = $holder->getBillingAddress();
410			}
411
412			/**
413			* Set credit cardHash.
414			*
415			* @param string $hash Credit card hash encripted using Moip.js
416			* @param \Moip\Resource\Customer $holder
417			* @param bool $store Flag to know if credit card should be saved.
418			*
419			* @return $this
420			*/
421			public function setCreditCardHash($hash, Customer $holder, $store = true)
422			{
423			$this->data->fundingInstrument->method = self::METHOD_CREDIT_CARD;
424			$this->data->fundingInstrument->creditCard = new stdClass();
425			$this->data->fundingInstrument->creditCard->hash = $hash;
426			$this->data->fundingInstrument->creditCard->store = $store;
427			$this->setCreditCardHolder($holder);
428
429			return $this;
430			}
431
432			/**
433			* Set credit card
434			* Credit card used in a payment.
435			* The card when returned within a parent resource is presented in its minimum representation.
436			*
437			* @param int $expirationMonth Card expiration month
438			* @param int $expirationYear Year of card expiration.
439			* @param string $number Card number.
440			* @param int $cvc Card Security Code.
441			* @param \Moip\Resource\Customer $holder
442			* @param bool $store Flag to know if credit card should be saved.
443			*
444			* @return $this
445			*/
446			public function setCreditCard($expirationMonth, $expirationYear, $number, $cvc, Customer $holder, $store = true)
447			{
448			$this->data->fundingInstrument->method = self::METHOD_CREDIT_CARD;
449			$this->data->fundingInstrument->creditCard = new stdClass();
450			$this->data->fundingInstrument->creditCard->expirationMonth = $expirationMonth;
451			$this->data->fundingInstrument->creditCard->expirationYear = $expirationYear;
452			$this->data->fundingInstrument->creditCard->number = $number;
453			$this->data->fundingInstrument->creditCard->cvc = $cvc;
454			$this->data->fundingInstrument->creditCard->store = $store;
455			$this->setCreditCardHolder($holder);
456
457			return $this;
458			}
459
460			/**
461			* Sets data from a previously saved credit card
462			* Credit card used in a payment.
463			* Used when the credit card was saved with the customer and the payment made in a future date.
464			*
465			* @param string $creditCardId MoIP's Credit Card Id.
466			* @param int $cvc Card Security Code.
467			*
468			* @return $this
469			*/
470			public function setCreditCardSaved($creditCardId, $cvc)
471			{
472			$this->data->fundingInstrument = new stdClass();
473			$this->data->fundingInstrument->method = self::METHOD_CREDIT_CARD;
474			$this->data->fundingInstrument->creditCard = new stdClass();
475			$this->data->fundingInstrument->creditCard->id = $creditCardId;
476			$this->data->fundingInstrument->creditCard->cvc = $cvc;
477
478			return $this;
479			}
480
481			/**
482			* Set installment count.
483			*
484			* @param int $installmentCount
485			*
486			* @return $this
487			*/
488			public function setInstallmentCount($installmentCount)
489			{
490			$this->data->installmentCount = $installmentCount;
491
492			return $this;
493			}
494
495			/**
496			* Set statement descriptor.
497			*
498			* @param string $statementDescriptor
499			*
500			* @return $this
501			*/
502			public function setStatementDescriptor($statementDescriptor)
503			{
504			$this->data->statementDescriptor = $statementDescriptor;
505
506			return $this;
507			}
508
509			/**
510			* Set payment means made available by banks.
511			*
512			* @param string $bankNumber Bank number. Possible values: 001, 237, 341, 041.
513			* @param \DateTime\|string $expirationDate Date of expiration debit.
514			* @param string $returnUri Return Uri.
515			*
516			* @return $this
517			*/
518			public function setOnlineBankDebit($bankNumber, $expirationDate, $returnUri)
519			{
520			if ($expirationDate instanceof \DateTime) {
521			$expirationDate = $expirationDate->format('Y-m-d');
522			}
523			$this->data->fundingInstrument->method = self::METHOD_ONLINE_BANK_DEBIT;
524			$this->data->fundingInstrument->onlineBankDebit = new stdClass();
525			$this->data->fundingInstrument->onlineBankDebit->bankNumber = $bankNumber;
526			$this->data->fundingInstrument->onlineBankDebit->expirationDate = $expirationDate;
527			$this->data->fundingInstrument->onlineBankDebit->returnUri = $returnUri;
528
529			return $this;
530			}
531
532			/**
533			* Set Multiorders.
534			*
535			* @param \Moip\Resource\Multiorders $multiorder
536			*
537			* @return $this
538			*/
539			public function setMultiorder(Multiorders $multiorder)
540			{
541			$this->multiorder = $multiorder;
542
543			return $this;
544			}
545
546			/**
547			* Set order.
548			*
549			* @param \Moip\Resource\Orders $order
550			*
551			* @return $this
552			*/
553			public function setOrder(Orders $order)
554			{
555			$this->order = $order;
556
557			return $this;
558			}
559
560			/**
561			* Turns on a delay on credit card payment capture (pre-authorization).
562			*
563			* @return $this
564			*/
565			public function setDelayCapture()
566			{
567			$this->data->delayCapture = true;
568
569			return $this;
570			}
571
572			/**
573			* Set escrow to a payment.
574			*
575			* @param string $description
576			*
577			* @return $this
578			*/
579			public function setEscrow($description)
580			{
581			$this->data->escrow = new stdClass();
582			$this->data->escrow->description = $description;
583
584			return $this;
585			}
586
587			/**
588			* Capture a pre-authorized amount on a credit card payment.
589			*
590			* @throws \Exception
591			*
592			* @return Payment
593			*/
594			public function capture()
595			{
596			if (is_null($this->order)) {
597			throw new \Exception('Sorry, multipayment capture is not available on this version');
598			}
599			$path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, self::PATH, $this->getId(), 'capture');
600
601			$response = $this->httpRequest($path, Requests::POST, $this);
602
603			return $this->populate($response);
604			}
605
606			/**
607			* Avoid a pre-authorized amount on a credit card payment.
608			*
609			* @throws \Exception
610			*
611			* @return Payment
612			*/
613			public function avoid()
614			{
615			if (is_null($this->order)) {
616			throw new \Exception('Sorry, multipayment capture is not available on this version');
617			}
618			$path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, self::PATH, $this->getId(), 'void');
619
620			$response = $this->httpRequest($path, Requests::POST, $this);
621
622			return $this->populate($response);
623			}
624
625			/**
626			* Authorize a payment (Available only in sandbox to credit card payment with status IN_ANALYSIS and billet payment with status WAITING).
627			*
628			* @return bool
629			*/
630			public function authorize($amount = null)
631			{
632			if (is_null($amount)) {
633			$amount = $this->getAmount()->total;
634			}
635			$path = sprintf('/%s/%s?payment_id=%s&amount=%s', self::SIMULATOR_PATH, 'authorize', $this->getId(), $amount);
636			$response = $this->httpRequest($path, Requests::GET);
637
638			if (empty($response)) {
639			return true;
640			}
641
642			return false;
643			}
644			}
645

moip / moip-sdk-php

Push — master ( 4a5840...1f0278 )

Payment::getLineCodeBoleto() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like