Authnetjson\AuthnetWebhooksRequest

Complexity

Total Complexity

20

Size/Duplication

Total Lines	310
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	deleteWebhook()	0	5	1
A	updateWebhook()	0	12	1
A	testWebhook()	0	6	1
A	post()	0	4	1
A	get()	0	4	1
A	getRawRequest()	0	3	1
A	getWebhook()	0	5	1
A	__toString()	0	17	2
A	delete()	0	4	1
A	put()	0	4	1
A	getByUrl()	0	4	1
A	handleResponse()	0	9	2
A	__construct()	0	3	1
A	createWebhooks()	0	12	1
A	getEventTypes()	0	5	1
A	getWebhooks()	0	5	1
A	getNotificationHistory()	0	11	1
A	setProcessHandler()	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 "AuthnetWebhooksRequest.php" doesn't match the expected filename "authnetwebhooksrequest.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;

use Authnetjson\Exception\AuthnetCurlException;
use Authnetjson\Exception\AuthnetInvalidJsonException;
use Curl\Curl;

/**
 * Creates a request to the Authorize.Net Webhooks 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/features/webhooks.html
 */
class AuthnetWebhooksRequest
{

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

    /**

Missing short description in doc comment

     * @var string  Base URL for processing a webhook
     */
    private $url;

Expected 1 blank line(s) before first member var; 0 found

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  Endpoint for processing a webhook
     */
    private $endpoint;

Private member variable "endpoint" must contain a leading underscore

Private member variable "endpoint" 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 $api_url URL endpoint for processing a transaction

Parameter comment must end with a full stop

     */
    public function __construct(string $api_url)

Expected 2 blank lines before function; 1 found

Variable "api_url" is not in valid camel caps format

    {

Opening brace should be on the same line as the declaration

        $this->url = $api_url;

Variable "api_url" is not in valid camel caps format

    }

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(): string
    {

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>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

        } else {
            $output .= '<tr><td colspan="2" style="text-align: center;"><pre>N/A</pre></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 103 characters

        }

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

    /**
     * Creates a new webhook
     *
     * @param  array  $webhooks   Array of webhooks to be created or modified

Parameter comment must end with a full stop

     * @param  string $webhookUrl URL of where webhook notifications will be sent

Parameter comment must end with a full stop

     * @param  string $status     Status of webhooks to be created or modified [active/inactive]

Parameter comment must end with a full stop

     * @return AuthnetWebhooksResponse

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

     * @throws AuthnetInvalidJsonException

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

Comment missing for @throws tag in function comment

     * @throws AuthnetCurlException

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

Comment missing for @throws tag in function comment

     */
    public function createWebhooks(array $webhooks, string $webhookUrl, string $status = 'active'): object

Incorrect spacing between argument "$status" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$status"; expected 0 but found 1

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

    {

Opening brace should be on the same line as the declaration

        $this->endpoint = 'webhooks';

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

        $this->url = sprintf('%s%s', $this->url, $this->endpoint);

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

        $request = [

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

            'url'        => $webhookUrl,

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

            'eventTypes' => $webhooks,

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

            'status'     => $status

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

Each line in an array declaration must end in a comma

        ];

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

        $this->requestJson = json_encode($request);
        $response = $this->post($this->url, $this->requestJson);

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

        return new AuthnetWebhooksResponse($response);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end createWebhooks()

    /**
     * Sends a test ping to a URL for (a) designated webhook(s)
     *
     * @param  string $webhookId Webhook ID to be tested

Parameter comment must end with a full stop

     * @throws AuthnetCurlException

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 testWebhook(string $webhookId): void
    {

Opening brace should be on the same line as the declaration

        $this->endpoint = 'webhooks';

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

        $this->url = sprintf('%s%s/%s/pings', $this->url, $this->endpoint, $webhookId);

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

        $this->requestJson = json_encode([]);
        $this->post($this->url, $this->requestJson);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end testWebhook()

    /**
     * Gets all of the available event types
     *
     * @return AuthnetWebhooksResponse
     * @throws AuthnetCurlException

Comment missing for @throws tag in function comment

     * @throws AuthnetInvalidJsonException

Comment missing for @throws tag in function comment

     */
    public function getEventTypes(): object
    {

Opening brace should be on the same line as the declaration

        $this->endpoint = 'eventtypes';
        $this->url = sprintf('%s%s', $this->url, $this->endpoint);

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

        return $this->getByUrl($this->url);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getEventTypes()

    /**
     * List all of your webhooks
     *
     * @return AuthnetWebhooksResponse
     * @throws AuthnetCurlException

Comment missing for @throws tag in function comment

     * @throws AuthnetInvalidJsonException

Comment missing for @throws tag in function comment

     */
    public function getWebhooks(): object
    {

Opening brace should be on the same line as the declaration

        $this->endpoint = 'webhooks';
        $this->url = sprintf('%s%s', $this->url, $this->endpoint);

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

        return $this->getByUrl($this->url);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getWebhooks()

    /**
     * Get a webhook
     *
     * @param  string $webhookId Webhook ID to be retrieved

Parameter comment must end with a full stop

     * @return AuthnetWebhooksResponse

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 getWebhook(string $webhookId): object
    {

Opening brace should be on the same line as the declaration

        $this->endpoint = 'webhooks';
        $this->url = sprintf('%s%s/%s', $this->url, $this->endpoint, $webhookId);

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

        return $this->getByUrl($this->url);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getWebhook()

    /**
     * GET API request
     *
     * @param  string $url API endpoint to hit

Parameter comment must end with a full stop

     * @return object

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

     */
    private function getByUrl(string $url): object

Private method name "AuthnetWebhooksRequest::getByUrl" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        $response = $this->get($url);
        return new AuthnetWebhooksResponse($response);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getByUrl()

    /**
     * Updates webhook event types
     *
     * @param  string $webhookId  Webhook ID to be modified

Parameter comment must end with a full stop

     * @param  string $webhookUrl URL of where webhook notifications will be sent

Parameter comment must end with a full stop

     * @param  array  $eventTypes Array of event types to be added/removed

Parameter comment must end with a full stop

     * @param  string $status     Status of webhooks to be modified [active/inactive]

Parameter comment must end with a full stop

     * @return AuthnetWebhooksResponse

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

     * @throws AuthnetInvalidJsonException

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

Comment missing for @throws tag in function comment

     * @throws AuthnetCurlException

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

Comment missing for @throws tag in function comment

     */
    public function updateWebhook(string $webhookId, string $webhookUrl, array $eventTypes, string $status = 'active'): object

Incorrect spacing between argument "$status" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$status"; expected 0 but found 1

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

    {

Opening brace should be on the same line as the declaration

        $this->endpoint = 'webhooks';

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

        $this->url = sprintf('%s%s/%s', $this->url, $this->endpoint, $webhookId);

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

        $request = [

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

            'url'        => $webhookUrl,

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

            'eventTypes' => $eventTypes,

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

            'status'     => $status

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

Each line in an array declaration must end in a comma

        ];

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

        $this->requestJson = json_encode($request);
        $response = $this->put($this->url, $this->requestJson);

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

        return new AuthnetWebhooksResponse($response);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end updateWebhook()

    /**
     * Delete a webhook
     *
     * @param  string $webhookId Webhook ID to be deleted

Parameter comment must end with a full stop

     * @throws AuthnetCurlException

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 deleteWebhook(string $webhookId): void
    {

Opening brace should be on the same line as the declaration

        $this->endpoint = 'webhooks';
        $this->url = sprintf('%s%s/%s', $this->url, $this->endpoint, $webhookId);

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

        $this->delete($this->url);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end deleteWebhook()

    /**
     * Retrieve Notification History
     *
     * @param  int $limit  Default: 1000

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

Parameter comment must end with a full stop

     * @param  int $offset Default: 0

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

Parameter comment must end with a full stop

     * @return AuthnetWebhooksResponse

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

     * @throws AuthnetInvalidJsonException

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

Comment missing for @throws tag in function comment

     * @throws AuthnetCurlException

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

Comment missing for @throws tag in function comment

     */
    public function getNotificationHistory(int $limit = 1000, int $offset = 0): object

Incorrect spacing between argument "$limit" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$limit"; expected 0 but found 1

Incorrect spacing between argument "$offset" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$offset"; expected 0 but found 1

    {

Opening brace should be on the same line as the declaration

        $this->endpoint = 'notifications';
        $this->url = sprintf('%s%s', $this->url, $this->endpoint);

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

        $response = $this->get(

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

            $this->url, [
            'offset' => $offset,

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

            'limit'  => $limit

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

Each line in an array declaration must end in a comma

            ]

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

        );
        return new AuthnetWebhooksResponse($response);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getNotificationHistory()

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

Comment missing for @throws tag in function comment

     */
    private function handleResponse(): string

Private method name "AuthnetWebhooksRequest::handleResponse" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        if (!$this->processor->error) {

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

            return $this->processor->response;
        }

No blank line found after control structure

        $response = json_decode($this->processor->response, false);

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

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

        $error_message = sprintf('(%u) %s: %s', $response->status, $response->reason, $response->message);

Variable "error_message" is not in valid camel caps format

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

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

Variable "error_message" is not in valid camel caps format

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end handleResponse()

    /**
     * Make GET request via Curl
     *
     * @param  string $url

Missing parameter comment

     * @param  array  $params

Missing parameter comment

     * @return string

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

     *
     * @codeCoverageIgnore
     */
    private function get(string $url, array $params = []): string

Private method name "AuthnetWebhooksRequest::get" must be prefixed with an underscore

Incorrect spacing between argument "$params" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$params"; expected 0 but found 1

    {

Opening brace should be on the same line as the declaration

        $this->processor->get($url, $params);
        return $this->handleResponse();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end get()

    /**
     * Make POST request via Curl
     *
     * @param  string $url     API endpoint

Parameter comment must end with a full stop

     * @param  string $request JSON request payload

Parameter comment must end with a full stop

     * @return string

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

     *
     * @codeCoverageIgnore
     */
    private function post(string $url, string $request): string

Private method name "AuthnetWebhooksRequest::post" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        $this->processor->post($url, $request);
        return $this->handleResponse();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end post()

    /**
     * Make PUT request via Curl
     *
     * @param  string $url     API endpoint

Parameter comment must end with a full stop

     * @param  string $request JSON request payload

Parameter comment must end with a full stop

     * @return string

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

     *
     * @codeCoverageIgnore
     */
    private function put(string $url, string $request): string

Private method name "AuthnetWebhooksRequest::put" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        $this->processor->put($url, $request, true);

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

        return $this->handleResponse();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end put()

    /**
     * Make DELETE request via Curl
     *
     * @param  string $url API endpoint

Parameter comment must end with a full stop

     * @return string

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

     *
     * @codeCoverageIgnore
     */
    private function delete(string $url): string

Private method name "AuthnetWebhooksRequest::delete" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        $this->processor->delete($url, [], true);

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

        return $this->handleResponse();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end delete()

    /**
     * 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(Curl $processor): void
    {

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.