rattfieldnz / shodan

src/Libraries/Curl/Curl.php

<?php

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

This file is missing a doc comment.

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

Filename "Curl.php" doesn't match the expected filename "curl.php"

Missing file doc comment

namespace RattfieldNz\Shodan\Libraries\Curl;

use Curl\Curl as PhpCurl;
use RattfieldNz\Shodan\Libraries\Data\Data;

/**
 * Class Curl.
 *
 * @category PHP

@category tag is not allowed in class comment

 *
 * @author  Rob Attfield <emailme@robertattfield.com>

@author tag is not allowed in class comment

 * @license https://github.com/rattfieldnz/shodan/blob/master/LICENSE MIT

@license tag is not allowed in class comment

 */

Missing @package tag in class comment

Missing @link tag in class comment

class Curl
{

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

    private $_data;

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

Missing member variable doc comment

    private $_defaultHeaders;

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

Missing member variable doc comment

    private $_timeout;

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

Missing member variable doc comment

    private $_curl;

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

Missing member variable doc comment

    /**
     * Curl constructor.
     *
     * Set the needed properties to do a CURL request.
     *
     * @param Data $data    Data to use when executing cURL.
     * @param int  $timeout Timeout in seconds to complete a CURL request. Default is 10.

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

     *
     * @throws \ErrorException Will throw an exception if PHP ext-curl is not installed.
     */
    public function __construct(Data $data, int $timeout = 10)

Expected 2 blank lines before function; 1 found

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

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

    {

Opening brace should be on the same line as the declaration

        if (!extension_loaded('curl')) {

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

            throw new \ErrorException(
                'The cURL extensions is not loaded, make sure you have installed the cURL extension: https://php.net/manual/curl.setup.php'

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

            );
        }

        $this->_curl = new PhpCurl();

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

        $this->_data = $data;

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

        $this->_timeout = $timeout;
        $this->_setDefaultHeaders();
    }

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

Expected 2 blank lines after function; 1 found

    /**
     * Execute a CURL request, and return current object for further processing.
     *
     * @return PhpCurl
     */
    public function execute(): PhpCurl
    {

Opening brace should be on the same line as the declaration

        $this->_curl->setOpt(CURLOPT_RETURNTRANSFER, true);

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

        $this->_curl->setOpt(CURLOPT_CONNECTTIMEOUT, $this->_timeout);
        $this->_curl->setOpt(CURLOPT_HTTPHEADER, $this->_defaultHeaders);
        $this->_curl->setOpt(CURLOPT_SSL_VERIFYPEER, false);

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

        $this->_curl->setOpt(CURLOPT_SSL_VERIFYHOST, false);

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

        $this->_curl->get($this->_data->shodanApiUrl());

        return $this->_curl;
    }

Expected 1 blank line before closing function brace; 0 found

Expected //end execute()

Expected 2 blank lines after function; 1 found

    /**
     * Get the data retrieved from executing CURL request, in JSON format.
     *
     * @return array
     *
     * @see \RattfieldNz\SafeUrls\Libraries\Curl\Curl->execute().
     */
    public function getData()
    {

Opening brace should be on the same line as the declaration

        $dataObject = $this->execute();

        $status = $dataObject->getHttpStatus();

        $response = $dataObject->error_code != 0 ?

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

Variable "error_code" is not in valid camel caps format

Operator != prohibited; use !== instead

Expected 1 space after "?"; newline found

Inline IF statements are not allowed

Inline shorthand IF statement must be declared on a single line

            ['message' => $dataObject->error_message] :

Short array syntax is not allowed

Variable "error_message" is not in valid camel caps format

Expected 1 space after ":"; newline found

            json_decode($dataObject->response, true);

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

It seems like $dataObject->response can also be of type boolean and null; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

        $data = [

Short array syntax is not allowed

            'status'   => $status,

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

            'response' => $response,

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

        ];

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

        return $data;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getData()

    /**
     * Sets the default headers to use for CURL request.
     *
     * @return void
     */
    private function _setDefaultHeaders(): void
    {

Opening brace should be on the same line as the declaration

        $this->_defaultHeaders = [

Short array syntax is not allowed

            'Content-Type: application/json',

This array value does not seem to be aligned correcty; expected 34 spaces, but found 12.

            'Connection: Keep-Alive',

This array value does not seem to be aligned correcty; expected 34 spaces, but found 12.

        ];

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

    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end _setDefaultHeaders()

}

Expected //end class

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