Authnetjson\AuthnetJsonResponse

Complexity

Total Complexity

29

Size/Duplication

Total Lines	248
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	11	1
A	getError()	0	11	3
A	getTransactionResponses()	0	3	1
A	isApproved()	0	3	2
A	checkTransactionStatus()	0	8	2
A	__get()	0	3	1
A	getErrorText()	0	3	1
A	isPrePaidCard()	0	3	1
A	isDeclined()	0	3	2
A	getRawResponse()	0	3	1
B	__construct()	0	16	8
A	isError()	0	3	1
A	getErrorCode()	0	3	1
A	getTransactionResponseField()	0	6	2
A	isSuccessful()	0	3	1
A	getErrorMessage()	0	3	1

<?php

Class found in ".php" file; use ".inc" extension instead

The PHP open tag does not have a corresponding PHP close tag

Filename "AuthnetJsonResponse.php" doesn't match the expected filename "authnetjsonresponse.php"

declare(strict_types=1);

/**

Block comments must be started with /*

 * This file is part of the AuthnetJSON package.
 *
 * (c) John Conde <stymiee@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Authnetjson;

/**
 * Adapter for the Authorize.Net JSON API
 *
 * @package   AuthnetJSON
 * @author    John Conde <stymiee@gmail.com>
 * @copyright John Conde <stymiee@gmail.com>
 * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
 * @link      https://github.com/stymiee/authnetjson
 * @see       https://developer.authorize.net/api/reference/
 *
 * @property object  $messages
 * @property string  $directResponse
 * @property string  $validationDirectResponseList
 * @property object  $transactionResponse
 *
 * @method null createTransactionRequest(array $array)                                 process a payment

This line exceeds maximum limit of 100 characters; contains 104 characters

 * @method null sendCustomerTransactionReceiptRequest(array $array)                    get a list of unsettled transactions

This line exceeds maximum limit of 100 characters; contains 123 characters

 * @method null ARBCancelSubscriptionRequest(array $array)                             cancel a subscription

This line exceeds maximum limit of 100 characters; contains 108 characters

 * @method null ARBCreateSubscriptionRequest(array $array)                             create a subscription

This line exceeds maximum limit of 100 characters; contains 108 characters

 * @method null ARBGetSubscriptionStatusRequest(array $array)                          get a subscription's status

This line exceeds maximum limit of 100 characters; contains 114 characters

 * @method null ARBUpdateSubscriptionRequest(array $array)                             update a subscription

This line exceeds maximum limit of 100 characters; contains 108 characters

 * @method null createCustomerPaymentProfileRequest(array $array)                      create a payment profile

This line exceeds maximum limit of 100 characters; contains 111 characters

 * @method null createCustomerProfileRequest(array $array)                             create a customer profile

This line exceeds maximum limit of 100 characters; contains 112 characters

 * @method null createCustomerProfileTransactionRequest_authCapture(array $array)      process an Authorization and Capture transaction (Sale)

This line exceeds maximum limit of 100 characters; contains 142 characters

 * @method null createCustomerProfileTransactionRequest_authOnly(array $array)         process an Authorization Only transaction

This line exceeds maximum limit of 100 characters; contains 128 characters

 * @method null createCustomerProfileTransactionRequest_captureOnly(array $array)      process a Capture Only transaction

This line exceeds maximum limit of 100 characters; contains 121 characters

 * @method null createCustomerProfileTransactionRequest_priorAuthCapture(array $array) process a Prior Authorization Capture transaction

This line exceeds maximum limit of 100 characters; contains 136 characters

 * @method null createCustomerProfileTransactionRequest_refund(array $array)           process a Refund (credit)

This line exceeds maximum limit of 100 characters; contains 112 characters

 * @method null createCustomerProfileTransactionRequest_void(array $array)             void a transaction

This line exceeds maximum limit of 100 characters; contains 105 characters

 * @method null createCustomerShippingAddressRequest(array $array)                     create a shipping profile

This line exceeds maximum limit of 100 characters; contains 112 characters

 * @method null deleteCustomerPaymentProfileRequest(array $array)                      delete a payment profile

This line exceeds maximum limit of 100 characters; contains 111 characters

 * @method null deleteCustomerProfileRequest(array $array)                             delete a customer profile

This line exceeds maximum limit of 100 characters; contains 112 characters

 * @method null deleteCustomerShippingAddressRequest(array $array)                     delete a shipping profile

This line exceeds maximum limit of 100 characters; contains 112 characters

 * @method null getCustomerPaymentProfileRequest(array $array)                         retrieve a payment profile

This line exceeds maximum limit of 100 characters; contains 113 characters

 * @method null getCustomerProfileIdsRequest(array $array)                             retrieve a list of profile IDs

This line exceeds maximum limit of 100 characters; contains 117 characters

 * @method null getCustomerProfileRequest(array $array)                                retrieve a customer profile

This line exceeds maximum limit of 100 characters; contains 114 characters

 * @method null getCustomerShippingAddressRequest(array $array)                        retrieve a shipping address

This line exceeds maximum limit of 100 characters; contains 114 characters

 * @method null getHostedProfilePageRequest(array $array)                              retrieve a hosted payment page token

This line exceeds maximum limit of 100 characters; contains 123 characters

 * @method null updateCustomerPaymentProfileRequest(array $array)                      update a customer profile

This line exceeds maximum limit of 100 characters; contains 112 characters

 * @method null updateCustomerProfileRequest(array $array)                             update a customer profile

This line exceeds maximum limit of 100 characters; contains 112 characters

 * @method null updateCustomerShippingAddressRequest(array $array)                     update a shipping address

This line exceeds maximum limit of 100 characters; contains 112 characters

 * @method null updateSplitTenderGroupRequest(array $array)                            update a split tender transaction

This line exceeds maximum limit of 100 characters; contains 120 characters

 * @method null validateCustomerPaymentProfileRequest(array $array)                    validate a payment profile

This line exceeds maximum limit of 100 characters; contains 113 characters

 * @method null getBatchStatisticsRequest(array $array)                                get a summary of a settled batch

This line exceeds maximum limit of 100 characters; contains 119 characters

 * @method null getSettledBatchListRequest(array $array)                               get a list of settled batches

This line exceeds maximum limit of 100 characters; contains 116 characters

 * @method null getTransactionDetailsRequest(array $array)                             get the details of a transaction

This line exceeds maximum limit of 100 characters; contains 119 characters

 * @method null getTransactionListRequest(array $array)                                get a list of transaction in a batch

This line exceeds maximum limit of 100 characters; contains 123 characters

 * @method null getUnsettledTransactionListRequest(array $array)                       get a list of unsettled transactions

This line exceeds maximum limit of 100 characters; contains 123 characters

 */
class AuthnetJsonResponse
{

Opening brace should be on the same line as the declaration for class AuthnetJsonResponse

    /**

Missing short description in doc comment

     * @const Indicates the status code of an approved transaction
     */
    public const STATUS_APPROVED = 1;

    /**

Missing short description in doc comment

     * @const Indicates the status code of an declined transaction
     */
    public const STATUS_DECLINED = 2;

    /**

Missing short description in doc comment

     * @const Indicates the status code of an transaction which has encountered an error
     */
    public const STATUS_ERROR = 3;

    /**

Missing short description in doc comment

     * @const Indicates the status code of a transaction held for review
     */
    public const STATUS_HELD = 4;

    /**

Missing short description in doc comment

     * @const Indicates the status code of a transaction held for review
     */
    public const STATUS_PAYPAL_NEED_CONSENT = 5;

    /**

Missing short description in doc comment

     * @var object  SimpleXML object representing the API response
     */
    private $response;

Private member variable "response" must contain a leading underscore

Private member variable "response" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @var string  JSON string that is the response sent by Authorize.Net
     */
    private $responseJson;

Private member variable "responseJson" must contain a leading underscore

Private member variable "responseJson" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @var object  TransactionResponse
     */
    private $transactionInfo;

Private member variable "transactionInfo" must contain a leading underscore

Private member variable "transactionInfo" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @var array  TransactionResponse
     */
    private $transactionInfoArray;

Private member variable "transactionInfoArray" must contain a leading underscore

Private member variable "transactionInfoArray" must be prefixed with an underscore

    /**
     * Creates the response object with the response json returned from the API call
     *
     * @param  string $responseJson Response from Authorize.Net

Parameter comment must end with a full stop

     * @throws AuthnetInvalidJsonException

Tag @throws cannot be grouped with parameter tags in a doc comment

Comment missing for @throws tag in function comment

     */
    public function __construct(string $responseJson)

Expected 2 blank lines before function; 1 found

    {

Opening brace should be on the same line as the declaration

        $this->responseJson = preg_replace('/[\x00-\x1F\x80-\xFF]/', '', $responseJson);
        if (($this->response = json_decode($this->responseJson, false)) === null) {

Variable assignment found within a condition. Did you mean to do a comparison ?

Assignments must be the first block of code on a line

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of false please use FALSE.

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of null please use NULL.

            throw new AuthnetInvalidJsonException('Invalid JSON returned by the API');
        }

        if ($this->directResponse || $this->validationDirectResponseList || isset($this->response->validationDirectResponse)) {

This line exceeds maximum limit of 100 characters; contains 127 characters

            $response = $this->directResponse ?: $this->validationDirectResponseList ?: $this->response->validationDirectResponse;

The value of a comparison must not be assigned to a variable

Inline IF statements are not allowed

Inline shorthand IF statement requires brackets around comparison

This line exceeds maximum limit of 100 characters; contains 130 characters

            if (is_array($response)) {
                $this->transactionInfoArray = array_map(static function ($r) {

The opening parenthesis of a multi-line function call should be the last content on the line.

                    return new TransactionResponse($r);
                }, $response);

For multi-line function calls, the closing parenthesis should be on a new line.

            } else {
                $this->transactionInfo = new TransactionResponse($response);

Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

                $this->transactionInfoArray = [$this->transactionInfo];
            }
        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    /**
     * Outputs the response JSON in a human readable format
     *
     * @return string  HTML table containing debugging information
     */
    public function __toString()
    {

Opening brace should be on the same line as the declaration

        $output  = '<table id="authnet-response">'."\n";

Expected at least 1 space before "."; 0 found

Expected at least 1 space after "."; 0 found

        $output .= '<caption>Authorize.Net Response</caption>'."\n";

Expected at least 1 space before "."; 0 found

Expected at least 1 space after "."; 0 found

        $output .= '<tr><th colspan="2"><b>Response JSON</b></th></tr>'."\n";

Expected at least 1 space before "."; 0 found

Expected at least 1 space after "."; 0 found

        $output .= '<tr><td colspan="2"><pre>'."\n";

Expected at least 1 space before "."; 0 found

Expected at least 1 space after "."; 0 found

        $output .= $this->responseJson."\n";

Expected at least 1 space before "."; 0 found

Expected at least 1 space after "."; 0 found

        $output .= '</pre></td></tr>'."\n";

Expected at least 1 space before "."; 0 found

Expected at least 1 space after "."; 0 found

        $output .= '</table>';

        return $output;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __toString()

    /**
     * Gets a response variable from the API response
     *
     * @param  string $var unused

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

     * @return string requested variable from the API call response

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function __get(string $var)
    {

Opening brace should be on the same line as the declaration

        return $this->response->{$var} ?? null;

Operation must be bracketed

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of null please use NULL.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __get()

    /**
     * Checks if the API call is not in an error state
     *
     * @return bool    Whether the transaction was in an successful state

Expected "boolean" but found "bool" for function return type

     */
    public function isSuccessful(): bool
    {

Opening brace should be on the same line as the declaration

        return strtolower($this->messages->resultCode) === 'ok';
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end isSuccessful()

    /**
     * Checks if the API is reporting an error with the API call
     *
     * @return bool    Whether the transaction was in an error state

Expected "boolean" but found "bool" for function return type

     */
    public function isError(): bool
    {

Opening brace should be on the same line as the declaration

        return strtolower($this->messages->resultCode) === 'error';
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end isError()

    /**
     * Checks if a transaction was approved
     *
     * @return bool     true if the transaction is approved

Expected "boolean" but found "bool" for function return type

     */
    public function isApproved(): bool
    {

Opening brace should be on the same line as the declaration

        return $this->isSuccessful() && $this->checkTransactionStatus(self::STATUS_APPROVED);

Boolean operators are not allowed outside of control structure conditions

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end isApproved()

    /**
     * Checks if a transaction was completed using a prepaid card
     *
     * @return bool     true if the transaction was completed using a prepaid card

Expected "boolean" but found "bool" for function return type

     */
    public function isPrePaidCard(): bool
    {

Opening brace should be on the same line as the declaration

        return isset($this->transactionResponse->prePaidCard);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end isPrePaidCard()

    /**
     * Checks if a transaction was declined
     *
     * @return bool     true if the transaction is declined

Expected "boolean" but found "bool" for function return type

     */
    public function isDeclined(): bool
    {

Opening brace should be on the same line as the declaration

        return $this->isSuccessful() && $this->checkTransactionStatus(self::STATUS_DECLINED);

Boolean operators are not allowed outside of control structure conditions

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end isDeclined()

    /**
     * Check to see if the ResponseCode matches the expected value
     *
     * @param  int $status

Missing parameter comment

Expected "integer" but found "int" for parameter type

     * @return bool Check to see if the ResponseCode matches the expected value

Tag @return cannot be grouped with parameter tags in a doc comment

Expected "boolean" but found "bool" for function return type

     */
    protected function checkTransactionStatus(int $status): bool
    {

Opening brace should be on the same line as the declaration

        if ($this->transactionInfo instanceof TransactionResponse) {
            $match = (int) $this->transactionInfo->getTransactionResponseField('ResponseCode') === $status;

The value of a comparison must not be assigned to a variable

A cast statement should not be followed as per the coding-style.

This line exceeds maximum limit of 100 characters; contains 107 characters

        } else {
            $match = (int) $this->transactionResponse->responseCode === $status;

The value of a comparison must not be assigned to a variable

A cast statement should not be followed as per the coding-style.

        }

No blank line found after control structure

        return $match;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end checkTransactionStatus()

    /**
     * Gets the transaction response field for AIM and CIM transactions.
     *
     * @param  mixed $field Name or key of the transaction field to be retrieved

Parameter comment must end with a full stop

     * @return string Transaction field to be retrieved

Tag @return cannot be grouped with parameter tags in a doc comment

     * @throws AuthnetTransactionResponseCallException

Tag @throws cannot be grouped with parameter tags in a doc comment

Comment missing for @throws tag in function comment

     */
    public function getTransactionResponseField($field): string
    {

Opening brace should be on the same line as the declaration

        if ($this->transactionInfo instanceof TransactionResponse) {
            return $this->transactionInfo->getTransactionResponseField($field);

The expression return $this->transactionInfo->getTransactionResponseField($field) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

        }

No blank line found after control structure

        throw new AuthnetTransactionResponseCallException('This API call does not have any transaction response data');

This line exceeds maximum limit of 100 characters; contains 119 characters

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getTransactionResponseField()

    /**
     * Returns the results of a test charge for each payment account provided when created a customer profile

This line exceeds maximum limit of 100 characters; contains 109 characters

     *
     * @return array
     */
    public function getTransactionResponses(): array
    {

Opening brace should be on the same line as the declaration

        return $this->transactionInfoArray;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getTransactionResponses()

    /**
     * Gets the transaction response from Authorize.Net in JSON format for logging purposes
     *
     * @return string transaction response from Authorize.Net in JSON format
     */
    public function getRawResponse(): string
    {

Opening brace should be on the same line as the declaration

        return $this->responseJson;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getRawResponse()

    /**
     * An alias of self::getErrorText()
     *
     * @return string Error response from Authorize.Net
     */
    public function getErrorMessage(): string
    {

Opening brace should be on the same line as the declaration

        return $this->getErrorText();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getErrorMessage()

    /**
     * If an error has occurred, returns the error message
     *
     * @return string Error response from Authorize.Net
     */
    public function getErrorText(): string
    {

Opening brace should be on the same line as the declaration

        return $this->getError('text');
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getErrorText()

    /**
     * If an error has occurred, returns the error message
     *
     * @return string Error response from Authorize.Net
     */
    public function getErrorCode(): string
    {

Opening brace should be on the same line as the declaration

        return $this->getError('code');
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getErrorCode()

    /**

Missing short description in doc comment

     * @param  string $type Whether to get the error code or text

Parameter comment must end with a full stop

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    private function getError(string $type): string

Private method name "AuthnetJsonResponse::getError" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        $msg = '';
        if ($this->isError()) {
            $prop = sprintf('error%s', ucfirst($type));
            $msg = $this->messages->message[0]->{$type};

Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

            if (@$this->transactionResponse->errors[0]->{$prop}) {

Silencing errors is discouraged; found: @$this->transactionResponse...

                $msg = $this->transactionResponse->errors[0]->{$prop};
            }
        }

No blank line found after control structure

        return $msg;
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getError()

}

Expected //end class

As per coding style, files should not end with a newline character.