JohnConde\Authnet\AuthnetJsonRequest

Complexity

Total Complexity

16

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

85.19%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	__toString()	0	18	2
A	__set()	0	4	1
A	__call()	0	20	2
A	process()	0	14	5
A	setProcessHandler()	0	4	1
A	getRawRequest()	0	4	1
A	makeRequest()	0	11	3

<?php

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

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

Filename "AuthnetJsonRequest.php" doesn't match the expected filename "authnetjsonrequest.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 JohnConde\Authnet;

use \Curl\Curl;

/**
 * Creates a request to the Authorize.Net JSON endpoints.
 *
 * @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/
 *
 * @method AuthnetJsonResponse createTransactionRequest(array $array)
 * @method AuthnetJsonResponse sendCustomerTransactionReceiptRequest(array $array)
 * @method AuthnetJsonResponse ARBCancelSubscriptionRequest(array $array)
 * @method AuthnetJsonResponse ARBCreateSubscriptionRequest(array $array)
 * @method AuthnetJsonResponse ARBGetSubscriptionStatusRequest(array $array)
 * @method AuthnetJsonResponse ARBUpdateSubscriptionRequest(array $array)
 * @method AuthnetJsonResponse getAUJobDetailsRequest(array $array)
 * @method AuthnetJsonResponse getAUJobSummaryRequest(array $array)
 * @method AuthnetJsonResponse createCustomerPaymentProfileRequest(array $array)
 * @method AuthnetJsonResponse createCustomerProfileRequest(array $array)
 * @method AuthnetJsonResponse createCustomerProfileTransactionRequest_authCapture(array $array)
 * @method AuthnetJsonResponse createCustomerProfileTransactionRequest_authOnly(array $array)
 * @method AuthnetJsonResponse createCustomerProfileTransactionRequest_captureOnly(array $array)
 * @method AuthnetJsonResponse createCustomerProfileTransactionRequest_priorAuthCapture(array $array)

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

 * @method AuthnetJsonResponse createCustomerProfileTransactionRequest_refund(array $array)
 * @method AuthnetJsonResponse createCustomerProfileTransactionRequest_void(array $array)
 * @method AuthnetJsonResponse createCustomerShippingAddressRequest(array $array)
 * @method AuthnetJsonResponse deleteCustomerPaymentProfileRequest(array $array)
 * @method AuthnetJsonResponse deleteCustomerProfileRequest(array $array)
 * @method AuthnetJsonResponse deleteCustomerShippingAddressRequest(array $array)
 * @method AuthnetJsonResponse getCustomerPaymentProfileRequest(array $array)
 * @method AuthnetJsonResponse getCustomerProfileIdsRequest(array $array)
 * @method AuthnetJsonResponse getCustomerProfileRequest(array $array)
 * @method AuthnetJsonResponse getCustomerShippingAddressRequest(array $array)
 * @method AuthnetJsonResponse getHostedPaymentPageRequest(array $array)
 * @method AuthnetJsonResponse getHostedProfilePageRequest(array $array)
 * @method AuthnetJsonResponse getMerchantDetailsRequest(array $array)
 * @method AuthnetJsonResponse getUnsettledTransactionListRequest(array $array)
 * @method AuthnetJsonResponse updateCustomerPaymentProfileRequest(array $array)
 * @method AuthnetJsonResponse updateCustomerProfileRequest(array $array)
 * @method AuthnetJsonResponse updateCustomerShippingAddressRequest(array $array)
 * @method AuthnetJsonResponse updateHeldTransactionRequest(array $array)
 * @method AuthnetJsonResponse updateSplitTenderGroupRequest(array $array)
 * @method AuthnetJsonResponse validateCustomerPaymentProfileRequest(array $array)
 * @method AuthnetJsonResponse getBatchStatisticsRequest(array $array)
 * @method AuthnetJsonResponse getSettledBatchListRequest(array $array)
 * @method AuthnetJsonResponse getTransactionDetailsRequest(array $array)
 * @method AuthnetJsonResponse getTransactionListRequest(array $array)
 */
class AuthnetJsonRequest
{

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

    /**

Missing short description in doc comment

     * @var int     Maximum number of retires making HTTP request before failure
     */
    private const MAX_RETRIES = 3;

    /**

Missing short description in doc comment

     * @var string  Authorize.Net API login ID
     */
    private $login;

Private member variable "login" must contain a leading underscore

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

    /**

Missing short description in doc comment

     * @var string  Authorize.Net API Transaction Key
     */
    private $transactionKey;

Private member variable "transactionKey" must contain a leading underscore

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

    /**

Missing short description in doc comment

     * @var string  URL endpoint for processing a transaction
     */
    private $url;

Private member variable "url" must contain a leading underscore

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

    /**

Missing short description in doc comment

     * @var string  JSON formatted API request
     */
    private $requestJson;

Private member variable "requestJson" must contain a leading underscore

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

    /**

Missing short description in doc comment

     * @var object  Wrapper object representing an endpoint
     */
    private $processor;

Private member variable "processor" must contain a leading underscore

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

    /**
     * Creates the request object by setting the Authorize.Net credentials and URL of the endpoint to be used

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

     * for the API call.
     *
     * @param string $login          Authorize.Net API login ID

Parameter comment must end with a full stop

     * @param string $transactionKey Authorize.Net API Transaction Key

Parameter comment must end with a full stop

     * @param string $api_url        URL endpoint for processing a transaction

Parameter comment must end with a full stop

     */
    public function __construct(string $login, string $transactionKey, string $api_url)

Expected 2 blank lines before function; 1 found

Variable "api_url" is not in valid camel caps format

$api_url does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    {

Opening brace should be on the same line as the declaration

        $this->login          = $login;
        $this->transactionKey = $transactionKey;
        $this->url            = $api_url;

Variable "api_url" is not in valid camel caps format

$api_url does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    /**
     * Outputs the account credentials, endpoint URL, and request 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-request">'."\n";

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

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

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

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

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

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

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

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

        $output .= '<tr><td><b>API Login ID</b></td><td>'.$this->login.'</td></tr>'."\n";

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

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

        $output .= '<tr><td><b>Transaction Key</b></td><td>'.$this->transactionKey.'</td></tr>'."\n";

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

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

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

        $output .= '<tr><td><b>Authnet Server URL</b></td><td>'.$this->url.'</td></tr>'."\n";

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

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

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

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

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

        if (!empty($this->requestJson)) {

Expected 1 space(s) after NOT operator; 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->requestJson."\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

        }

No blank line found after control structure

        $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()

    /**
     * The __set() method should never be used as all values to be made in the API call must be passed as an array

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

     *
     * @param  string $name  unused

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

     * @param  mixed  $value unused

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

     * @throws AuthnetCannotSetParamsException

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

Comment missing for @throws tag in function comment

     */

Missing @return tag in function comment

    public function __set($name, $value)

The method parameter $name is never used

The method parameter $value is never used

Type hint "string" missing for $name

    {

Opening brace should be on the same line as the declaration

        throw new AuthnetCannotSetParamsException(sprintf('You cannot set parameters directly in %s.', __CLASS__));

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

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __set()

    /**
     * Magic method that dynamically creates our API call based on the name of the method in the client code and

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

     * the array passed as its parameter.
     *
     * @param  string $api_call name of the API call to be made

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

     * @param  array  $args     the array to be passed to the API

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

     * @return AuthnetJsonResponse

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

     * @throws AuthnetCurlException

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

Comment missing for @throws tag in function comment

     * @throws AuthnetInvalidJsonException

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

Comment missing for @throws tag in function comment

     */
    public function __call($api_call, array $args)

Type hint "string" missing for $api_call

Variable "api_call" is not in valid camel caps format

$api_call does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    {

Opening brace should be on the same line as the declaration

        $authentication = [
            'merchantAuthentication' => [

This array key does not seem to be aligned correctly; expected 27 spaces, but found 12.

Each line in an array declaration must end in a comma

                'name'           => $this->login,

This array key does not seem to be aligned correctly; expected 41 spaces, but found 16.

                'transactionKey' => $this->transactionKey,

This array key does not seem to be aligned correctly; expected 41 spaces, but found 16.

            ]

The closing parenthesis does not seem to be aligned correctly; expected 40 space(s), but found 12.

        ];

The closing parenthesis does not seem to be aligned correctly; expected 26 space(s), but found 8.

        $call = [];

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

        if (count($args)) {
            $call = $args[0];
        }

No blank line found after control structure

        $parameters = [

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

            $api_call => $authentication + $call

This array key does not seem to be aligned correctly; expected 23 spaces, but found 12.

Variable "api_call" is not in valid camel caps format

Each line in an array declaration must end in a comma

Operation must be bracketed

$api_call does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        ];

The closing parenthesis does not seem to be aligned correctly; expected 22 space(s), but found 8.

        $this->requestJson = json_encode($parameters);

        $response = $this->process();
        return new AuthnetJsonResponse($response);
    }

Expected //end __call()

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

    /**
     * Makes POST request with retry logic.
     */

Missing @return tag in function comment

    private function makeRequest() : void

Private method name "AuthnetJsonRequest::makeRequest" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        $retries = 0;
        while ($retries < self::MAX_RETRIES) {
            $this->processor->post($this->url, $this->requestJson);
            if (!$this->processor->error) {

Expected 1 space(s) after NOT operator; 0 found

                break;
            }

No blank line found after control structure

            $retries++;
        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end makeRequest()

    /**
     * Tells the handler to make the API call to Authorize.Net.
     *
     * @return string  JSON string containing API response
     * @throws AuthnetCurlException

Comment missing for @throws tag in function comment

     */
    private function process() : string

Private method name "AuthnetJsonRequest::process" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        $this->makeRequest();
        if (!$this->processor->error && isset($this->processor->response)) {

Expected 1 space(s) after NOT operator; 0 found

            return $this->processor->response;
        }

No blank line found after control structure

        $error_message = null;

Variable "error_message" is not in valid camel caps format

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

$error_message does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $error_code    = null;

Variable "error_code" is not in valid camel caps format

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

$error_code does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        if ($this->processor->error_code || $this->processor->error_message) {
            $error_message = $this->processor->error_message;

Variable "error_message" is not in valid camel caps format

$error_message does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            $error_code    = $this->processor->error_code;

Variable "error_code" is not in valid camel caps format

$error_code does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        }

No blank line found after control structure

        throw new AuthnetCurlException(sprintf('Connection error: %s (%s)', $error_message, $error_code));

Variable "error_message" is not in valid camel caps format

Variable "error_code" is not in valid camel caps format

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

$error_message does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end process()

    /**
     * Sets the handler to be used to handle our API call. Mainly used for unit testing as Curl is used by default.

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

     *
     * @param Curl $processor

Missing parameter comment

     */

Missing @return tag in function comment

    public function setProcessHandler($processor) : void

Type hint "Curl" missing for $processor

    {

Opening brace should be on the same line as the declaration

        $this->processor = $processor;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setProcessHandler()

    /**
     * Gets the request sent to Authorize.Net in JSON format for logging purposes.
     *
     * @return string transaction request sent to Authorize.Net in JSON format
     */
    public function getRawRequest() : string
    {

Opening brace should be on the same line as the declaration

        return $this->requestJson;
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getRawRequest()

}

Expected //end class

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