JohnConde\Authnet\AuthnetWebhook

Complexity

Total Complexity

13

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

97.56%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	4
A	__toString()	0	16	1
A	__get()	0	4	1
A	isValid()	0	6	2
A	getRequestId()	0	4	1
A	getAllHeaders()	0	14	4

<?php

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

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

Filename "AuthnetWebhook.php" doesn't match the expected filename "authnetwebhook.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;

/**
 * Handles a Webhook notification from the Authorize.Net Webhooks 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/
 */
class AuthnetWebhook
{

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

    /**

Missing short description in doc comment

     * @var object  SimpleXML object representing the Webhook notification
     */
    private $webhook;

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

Private member variable "webhook" must contain a leading underscore

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

    /**

Missing short description in doc comment

     * @var string  JSON string that is the Webhook notification sent by Authorize.Net
     */
    private $webhookJson;

Private member variable "webhookJson" must contain a leading underscore

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

    /**

Missing short description in doc comment

     * @var array  HTTP headers sent with the notification
     */
    private $headers;

Private member variable "headers" must contain a leading underscore

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

    /**

Missing short description in doc comment

     * @var string  Authorize.Net Signature Key
     */
    private $signature;

Private member variable "signature" must contain a leading underscore

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

    /**
     * Creates the response object with the response json returned from the API call
     *
     * @param  string $signature Authorize.Net Signature Key

Parameter comment must end with a full stop

     * @param  string $payload   Webhook Notification sent by Authorize.Net

Parameter comment must end with a full stop

     * @param  array  $headers   HTTP headers sent with Webhook. Optional if PHP is run as an Apache module

Parameter comment must end with a full stop

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

     * @throws AuthnetInvalidCredentialsException

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 __construct(string $signature, string $payload, array $headers = [])

Expected 2 blank lines before function; 1 found

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

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

    {

Opening brace should be on the same line as the declaration

        $this->signature   = $signature;
        $this->webhookJson = $payload;
        $this->headers     = $headers;
        if (empty($this->headers)) {
            $this->headers = $this->getAllHeaders();
        }

No blank line found after control structure

        if (empty($this->signature)) {
            throw new AuthnetInvalidCredentialsException('You have not configured your signature properly.');

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

        }

No blank line found after control structure

        if (($this->webhook = json_decode($this->webhookJson, 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 sent in the Webhook notification');
        }

No blank line found after control structure

        $this->headers = array_change_key_case($this->headers, CASE_UPPER);
    }

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-webhook">'."\n";

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

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

        $output .= '<caption>Authorize.Net Webhook</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 HTTP Headers</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 .= var_export($this->headers)."\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 .= '<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->webhookJson."\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 Webhook notification
     *
     * @param  string $var

Missing parameter comment

     * @return string          requested variable from the API call response

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

     */
    public function __get($var)

Type hint "string" missing for $var

    {

Opening brace should be on the same line as the declaration

        return $this->webhook->{$var};
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __get()

    /**
     * Validates a webhook signature to determine if the webhook is valid
     *
     * @return bool

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

     */
    public function isValid() : bool
    {

Opening brace should be on the same line as the declaration

        $hashedBody = strtoupper(hash_hmac('sha512', $this->webhookJson, $this->signature));
        return (isset($this->headers['X-ANET-SIGNATURE']) &&

Boolean operators are not allowed outside of control structure conditions

            strtoupper(explode('=', $this->headers['X-ANET-SIGNATURE'])[1]) === $hashedBody);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end isValid()

    /**
     * Validates a webhook signature to determine if the webhook is valid
     *
     * @return string|null
     */
    public function getRequestId() : ?string
    {

Opening brace should be on the same line as the declaration

        return $this->headers['X-REQUEST-ID'] ?? 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 getRequestId()

    /**
     * Retrieves all HTTP headers of a given request
     *
     * @return array
     */
    protected function getAllHeaders() : array
    {

Opening brace should be on the same line as the declaration

        if (function_exists('apache_request_headers')) {
            $headers = apache_request_headers();
        } else {
            $headers = [];
            foreach ($_SERVER as $key => $value) {
                if (strpos($key, 'HTTP_') === 0) {
                    $headers[str_replace('_', '-', substr($key, 5))] = $value;
                }
            }
        }

No blank line found after control structure

        return $headers;
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getAllHeaders()

}

Expected //end class

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