Omnipay\FirstAtlanticCommerce\Message\AuthorizeRequest

Complexity

Total Complexity

20

Size/Duplication

Total Lines	220
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	6
Bugs	1	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	generateSignature()	0	11	1
B	getData()	0	79	6
B	formatCountry()	0	24	5
A	formatState()	0	11	2
A	formatPostcode()	0	11	2
A	getEndpoint()	0	4	1
A	getTransactionCode()	0	4	2
A	newResponse()	0	4	1

<?php

namespace Omnipay\FirstAtlanticCommerce\Message;

use Alcohol\ISO3166;
use Omnipay\Common\Exception\InvalidRequestException;
use Omnipay\FirstAtlanticCommerce\Message\AbstractRequest;

/**
 * FACPG2 Authorize Request
 */
class AuthorizeRequest extends AbstractRequest
{
    /**

Tabs must be used to indent lines; spaces are not allowed

     * @var string;

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    protected $requestName = 'AuthorizeRequest';

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * Transaction code (flag as a authorization)

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @var int;

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    protected $transactionCode = 0;

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * Returns the signature for the request.

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @return string base64 encoded sha1 hash of the merchantPassword, merchantId,

Tabs must be used to indent lines; spaces are not allowed

     *    acquirerId, transactionId, amount and currency code.

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    protected function generateSignature()

Tabs must be used to indent lines; spaces are not allowed

The function name generateSignature is in camel caps, but expected generate_signature instead as per the coding standard.

    {

Tabs must be used to indent lines; spaces are not allowed

        $signature  = $this->getMerchantPassword();

Tabs must be used to indent lines; spaces are not allowed

        $signature .= $this->getMerchantId();

Tabs must be used to indent lines; spaces are not allowed

        $signature .= $this->getAcquirerId();

Tabs must be used to indent lines; spaces are not allowed

        $signature .= $this->getTransactionId();

Tabs must be used to indent lines; spaces are not allowed

        $signature .= $this->formatAmount();

Tabs must be used to indent lines; spaces are not allowed

        $signature .= $this->getCurrencyNumeric();

Tabs must be used to indent lines; spaces are not allowed

        return base64_encode( sha1($signature, true) );

Tabs must be used to indent lines; spaces are not allowed

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * Validate and construct the data for the request

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @return array

Consider making the return type a bit more specific; maybe use array<string,array>.

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    public function getData()

Tabs must be used to indent lines; spaces are not allowed

The function name getData is in camel caps, but expected get_data instead as per the coding standard.

    {

Tabs must be used to indent lines; spaces are not allowed

        $this->validate('merchantId', 'merchantPassword', 'acquirerId', 'transactionId', 'amount', 'currency', 'card');

Tabs must be used to indent lines; spaces are not allowed

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

        // Check for AVS and require billingAddress1 and billingPostcode

Tabs must be used to indent lines; spaces are not allowed

        if ( $this->getRequireAvsCheck() )

Tabs must be used to indent lines; spaces are not allowed

Opening brace should be on the same line as the declaration

        {

Tabs must be used to indent lines; spaces are not allowed

            $this->getCard()->validate('billingAddress1', 'billingPostcode');

The call to CreditCard::validate() has too many arguments starting with 'billingAddress1'.

Tabs must be used to indent lines; spaces are not allowed

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

        }

Tabs must be used to indent lines; spaces are not allowed

        // Tokenized cards require the CVV and nothing else, token replaces the card number

Tabs must be used to indent lines; spaces are not allowed

        if ( $this->getCardReference() )

Tabs must be used to indent lines; spaces are not allowed

Opening brace should be on the same line as the declaration

        {

Tabs must be used to indent lines; spaces are not allowed

            $this->validate('cardReference');

Tabs must be used to indent lines; spaces are not allowed

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

            $this->getCard()->validate('cvv', 'expiryMonth', 'expiryYear');

The call to CreditCard::validate() has too many arguments starting with 'cvv'.

Tabs must be used to indent lines; spaces are not allowed

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

            $cardDetails = [

Tabs must be used to indent lines; spaces are not allowed

                'CardCVV2'       => $this->getCard()->getCvv(),

Tabs must be used to indent lines; spaces are not allowed

                'CardExpiryDate' => $this->getCard()->getExpiryDate('my'),

Tabs must be used to indent lines; spaces are not allowed

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

                'CardNumber'     => $this->getCardReference()

Tabs must be used to indent lines; spaces are not allowed

            ];

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

        else

Tabs must be used to indent lines; spaces are not allowed

        {

Tabs must be used to indent lines; spaces are not allowed

            $this->getCard()->validate();

Tabs must be used to indent lines; spaces are not allowed

            $cardDetails = [

Tabs must be used to indent lines; spaces are not allowed

                'CardCVV2'       => $this->getCard()->getCvv(),

Tabs must be used to indent lines; spaces are not allowed

                'CardExpiryDate' => $this->getCard()->getExpiryDate('my'),

Tabs must be used to indent lines; spaces are not allowed

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

                'CardNumber'     => $this->getCard()->getNumber(),

Tabs must be used to indent lines; spaces are not allowed

                'IssueNumber'    => $this->getCard()->getIssueNumber()

Tabs must be used to indent lines; spaces are not allowed

            ];

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

        // Only pass the StartDate if year/month are set otherwise it returns 1299

Tabs must be used to indent lines; spaces are not allowed

        if ( $this->getCard()->getStartYear() && $this->getCard()->getStartMonth() )

Tabs must be used to indent lines; spaces are not allowed

Opening brace should be on the same line as the declaration

        {

Tabs must be used to indent lines; spaces are not allowed

            $cardDetails['StartDate'] = $this->getCard()->getStartDate('my');

Tabs must be used to indent lines; spaces are not allowed

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

        }

Tabs must be used to indent lines; spaces are not allowed

        $transactionDetails = [

Tabs must be used to indent lines; spaces are not allowed

            'AcquirerId'       => $this->getAcquirerId(),

Tabs must be used to indent lines; spaces are not allowed

            'Amount'           => $this->formatAmount(),

Tabs must be used to indent lines; spaces are not allowed

            'Currency'         => $this->getCurrencyNumeric(),

Tabs must be used to indent lines; spaces are not allowed

            'CurrencyExponent' => $this->getCurrencyDecimalPlaces(),

Tabs must be used to indent lines; spaces are not allowed

            'IPAddress'        => $this->getClientIp(),

Tabs must be used to indent lines; spaces are not allowed

            'MerchantId'       => $this->getMerchantId(),

Tabs must be used to indent lines; spaces are not allowed

            'OrderNumber'      => $this->getTransactionId(),

Tabs must be used to indent lines; spaces are not allowed

            'Signature'        => $this->generateSignature(),

Tabs must be used to indent lines; spaces are not allowed

            'SignatureMethod'  => 'SHA1',

Tabs must be used to indent lines; spaces are not allowed

            'TransactionCode'  => $this->getTransactionCode()

Tabs must be used to indent lines; spaces are not allowed

        ];

Tabs must be used to indent lines; spaces are not allowed

        $billingDetails = [

Tabs must be used to indent lines; spaces are not allowed

            'BillToAddress'     => $this->getCard()->getAddress1(),

Tabs must be used to indent lines; spaces are not allowed

            'BillToZipPostCode' => $this->formatPostcode(),

Tabs must be used to indent lines; spaces are not allowed

            'BillToFirstName'   => $this->getCard()->getFirstName(),

Tabs must be used to indent lines; spaces are not allowed

            'BillToLastName'    => $this->getCard()->getLastName(),

Tabs must be used to indent lines; spaces are not allowed

            'BillToCity'        => $this->getCard()->getCity(),

Tabs must be used to indent lines; spaces are not allowed

            'BillToCountry'     => $this->formatCountry(),

Tabs must be used to indent lines; spaces are not allowed

            'BillToEmail'       => $this->getCard()->getEmail(),

Tabs must be used to indent lines; spaces are not allowed

            'BillToTelephone'   => $this->getCard()->getPhone(),

Tabs must be used to indent lines; spaces are not allowed

            'BillToFax'         => $this->getCard()->getFax()

Tabs must be used to indent lines; spaces are not allowed

        ];

Tabs must be used to indent lines; spaces are not allowed

        // FAC only accepts two digit state abbreviations from the USA

Tabs must be used to indent lines; spaces are not allowed

        if ( $billingDetails['BillToCountry'] == 840 )

Tabs must be used to indent lines; spaces are not allowed

Opening brace should be on the same line as the declaration

        {

Tabs must be used to indent lines; spaces are not allowed

            $billingDetails['BillToState'] = $this->formatState();

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

        $data = [

Tabs must be used to indent lines; spaces are not allowed

            'TransactionDetails' => $transactionDetails,

Tabs must be used to indent lines; spaces are not allowed

            'CardDetails'        => $cardDetails,

Tabs must be used to indent lines; spaces are not allowed

            'BillingDetails'     => $billingDetails

Tabs must be used to indent lines; spaces are not allowed

        ];

Tabs must be used to indent lines; spaces are not allowed

        return $data;

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * Returns the country as the numeric ISO 3166-1 code

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @throws Omnipay\Common\Exception\InvalidRequestException

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @return int ISO 3166-1 numeric country

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    protected function formatCountry()

Tabs must be used to indent lines; spaces are not allowed

The function name formatCountry is in camel caps, but expected format_country instead as per the coding standard.

    {

Tabs must be used to indent lines; spaces are not allowed

        $country = $this->getCard()->getCountry();

Tabs must be used to indent lines; spaces are not allowed

        if ( !is_null($country) && !is_numeric($country) )

Tabs must be used to indent lines; spaces are not allowed

Opening brace should be on the same line as the declaration

Expected 1 space after "!"; 0 found

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

        {

Tabs must be used to indent lines; spaces are not allowed

            $iso3166 = new ISO3166;

Tabs must be used to indent lines; spaces are not allowed

            if ( strlen($country) == 2 )

Tabs must be used to indent lines; spaces are not allowed

Found "== 2". Use Yoda Condition checks, you must

Opening brace should be on the same line as the declaration

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

            {

Tabs must be used to indent lines; spaces are not allowed

                $country = $iso3166->getByAlpha2($country)['numeric'];

Tabs must be used to indent lines; spaces are not allowed

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

            }

Tabs must be used to indent lines; spaces are not allowed

            elseif ( strlen($country) == 3 )

Tabs must be used to indent lines; spaces are not allowed

Found "== 3". Use Yoda Condition checks, you must

Opening brace should be on the same line as the declaration

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

            {

Tabs must be used to indent lines; spaces are not allowed

                $country = $iso3166->getByAlpha3($country)['numeric'];

Tabs must be used to indent lines; spaces are not allowed

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

            }

Tabs must be used to indent lines; spaces are not allowed

            else

Tabs must be used to indent lines; spaces are not allowed

            {

Tabs must be used to indent lines; spaces are not allowed

                throw new InvalidRequestException("The country parameter must be ISO 3166-1 numeric, aplha2 or alpha3.");

Tabs must be used to indent lines; spaces are not allowed

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

The string literal The country parameter must be ISO 3166-1 numeric, aplha2 or alpha3. does not require double quotes, as per coding-style, please use single quotes.

            }

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

        return $country;

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * Returns the billing state if its a US abbreviation or throws an exception

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @throws Omnipay\Common\Exception\InvalidRequestException

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @return string State abbreviation

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    public function formatState()

Tabs must be used to indent lines; spaces are not allowed

The function name formatState is in camel caps, but expected format_state instead as per the coding standard.

    {

Tabs must be used to indent lines; spaces are not allowed

        $state = $this->getCard()->getState();

Tabs must be used to indent lines; spaces are not allowed

        if ( strlen($state) != 2 )

Tabs must be used to indent lines; spaces are not allowed

Found "!= 2". Use Yoda Condition checks, you must

Opening brace should be on the same line as the declaration

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

        {

Tabs must be used to indent lines; spaces are not allowed

            throw new InvalidRequestException("The state must be a two character abbreviation.");

Tabs must be used to indent lines; spaces are not allowed

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

The string literal The state must be a two character abbreviation. does not require double quotes, as per coding-style, please use single quotes.

        }

Tabs must be used to indent lines; spaces are not allowed

        return $state;

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * Returns the postal code sanitizing dashes and spaces and throws exceptions with other

Tabs must be used to indent lines; spaces are not allowed

     * non-alphanumeric characters

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @throws Omnipay\Common\Exception\InvalidRequestException

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @return string Postal code

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    public function formatPostcode()

Tabs must be used to indent lines; spaces are not allowed

The function name formatPostcode is in camel caps, but expected format_postcode instead as per the coding standard.

    {

Tabs must be used to indent lines; spaces are not allowed

        $postal = preg_replace( '/[\s\-]/', '', $this->getCard()->getPostcode() );

Tabs must be used to indent lines; spaces are not allowed

        if ( preg_match('/[^a-z0-9]/i', $postal) )

Tabs must be used to indent lines; spaces are not allowed

Opening brace should be on the same line as the declaration

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

        {

Tabs must be used to indent lines; spaces are not allowed

            throw new InvalidRequestException("The postal code must be alpha-numeric.");

Tabs must be used to indent lines; spaces are not allowed

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

The string literal The postal code must be alpha-numeric. does not require double quotes, as per coding-style, please use single quotes.

        }

Tabs must be used to indent lines; spaces are not allowed

        return $postal;

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * Returns endpoint for authorize requests

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @return string Endpoint URL

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    protected function getEndpoint()

Tabs must be used to indent lines; spaces are not allowed

The function name getEndpoint is in camel caps, but expected get_endpoint instead as per the coding standard.

    {

Tabs must be used to indent lines; spaces are not allowed

        return parent::getEndpoint() . 'Authorize';

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * Returns the transaction code based on the AVS check requirement

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @return int Transaction Code

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    protected function getTransactionCode()

Tabs must be used to indent lines; spaces are not allowed

The function name getTransactionCode is in camel caps, but expected get_transaction_code instead as per the coding standard.

    {

Tabs must be used to indent lines; spaces are not allowed

        return $this->getRequireAvsCheck() ? $this->transactionCode + 1 : $this->transactionCode;

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * Return the authorize response object

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @param \SimpleXMLElement $xml Response xml object

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @return AuthorizeResponse

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    protected function newResponse($xml)

Tabs must be used to indent lines; spaces are not allowed

The function name newResponse is in camel caps, but expected new_response instead as per the coding standard.

    {

Tabs must be used to indent lines; spaces are not allowed

        return new AuthorizeResponse($this, $xml);

The return type of return new \Omnipay\FirstAtlanticCommerce\Message\AuthorizeResponse($this, $xml); (Omnipay\FirstAtlanticCommerce\Message\AuthorizeResponse) is incompatible with the return type declared by the abstract method Omnipay\FirstAtlanticCommerce\Message\AbstractRequest::newResponse of type Omnipay\FirstAtlanticCommerce\Message\ResponseInterface.

Tabs must be used to indent lines; spaces are not allowed

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

    }

Tabs must be used to indent lines; spaces are not allowed

}