RattfieldNz\Shodan\Libraries\Curl\Curl

Complexity

Total Complexity

5

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	2
A	execute()	0	10	1
A	_setDefaultHeaders()	0	5	1
A	getData()	0	9	1

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

Tag value indented incorrectly; expected 1 space but found 2

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

Opening brace should be on the same line as the declaration

    private $_data;

Line indented incorrectly; expected 2 spaces, found 4

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

Missing member variable doc comment

Class property $_data should use lowerCamel naming without underscores

    private $_defaultHeaders;

Line indented incorrectly; expected 2 spaces, found 4

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

Missing member variable doc comment

Class property $_defaultHeaders should use lowerCamel naming without underscores

    private $_timeout;

Line indented incorrectly; expected 2 spaces, found 4

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

Missing member variable doc comment

Class property $_timeout should use lowerCamel naming without underscores

    private $_curl;

Line indented incorrectly; expected 2 spaces, found 4

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

Missing member variable doc comment

Class property $_curl should use lowerCamel naming without underscores

    /**

Line indented incorrectly; expected 2 spaces, found 4

     * Curl constructor.
     *
     * Set the needed properties to do a CURL request.
     *
     * @param Data $data    Data to use when executing cURL.

Data types in @param tags need to be fully namespaced

Parameter comment must be on the next line

     * @param int  $timeout Timeout in seconds to complete a CURL request. Default is 10.

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

Expected 1 spaces after parameter type; 2 found

Parameter comment must be on the next line

     *
     * @throws \ErrorException Will throw an exception if PHP ext-curl is not installed.

@throws comment must be on the next line

     */
    public function __construct(Data $data, int $timeout = 10)

Line indented incorrectly; expected 2 spaces, found 4

    {

Opening brace should be on the same line as the declaration

        if (!extension_loaded('curl')) {

Line indented incorrectly; expected 4 spaces, found 8

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

            throw new \ErrorException(

Line indented incorrectly; expected 6 spaces, found 12

                '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

            );
        }

Line indented incorrectly; expected 4 spaces, found 8

        $this->_curl = new PhpCurl();

Line indented incorrectly; expected 4 spaces, found 8

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

        $this->_data = $data;

Line indented incorrectly; expected 4 spaces, found 8

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

        $this->_timeout = $timeout;

Line indented incorrectly; expected 4 spaces, found 8

        $this->_setDefaultHeaders();

Line indented incorrectly; expected 4 spaces, found 8

    }

Line indented incorrectly; expected 2 spaces, found 4

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    /**

Line indented incorrectly; expected 2 spaces, found 4

     * Execute a CURL request, and return current object for further processing.
     *
     * @return PhpCurl

Description for the @return value is missing

Data types in @return tags need to be fully namespaced

     */
    public function execute(): PhpCurl

Line indented incorrectly; expected 2 spaces, found 4

    {

Opening brace should be on the same line as the declaration

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

Line indented incorrectly; expected 4 spaces, found 8

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

Line indented incorrectly; expected 4 spaces, found 8

        $this->_curl->setOpt(CURLOPT_HTTPHEADER, $this->_defaultHeaders);

Line indented incorrectly; expected 4 spaces, found 8

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

Line indented incorrectly; expected 4 spaces, found 8

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

Line indented incorrectly; expected 4 spaces, found 8

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

Line indented incorrectly; expected 4 spaces, found 8

        return $this->_curl;

Line indented incorrectly; expected 4 spaces, found 8

    }

Line indented incorrectly; expected 2 spaces, found 4

Expected 1 blank line before closing function brace; 0 found

Expected //end execute()

    /**

Line indented incorrectly; expected 2 spaces, found 4

     * Get the data retrieved from executing CURL request, in JSON format.
     *
     * @return string

Description for the @return value is missing

     *
     * @see \RattfieldNz\SafeUrls\Libraries\Curl\Curl->execute().

Trailing punctuation for @see references is not allowed.

     */
    public function getData()

Line indented incorrectly; expected 2 spaces, found 4

    {

Opening brace should be on the same line as the declaration

        $dataObject = $this->execute();

Line indented incorrectly; expected 4 spaces, found 8

        $data = [

Line indented incorrectly; expected 4 spaces, found 8

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

Short array syntax is not allowed

            'status'   => $dataObject->getHttpStatus(),

Array indentation error, expected 10 spaces but found 12

            'response' => json_decode($dataObject->response, true),

Array indentation error, expected 10 spaces but found 12

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

        ];

        return json_encode($data);

Line indented incorrectly; expected 4 spaces, found 8

    }

Line indented incorrectly; expected 2 spaces, found 4

Expected 1 blank line before closing function brace; 0 found

Expected //end getData()

    /**

Line indented incorrectly; expected 2 spaces, found 4

     * Sets the default headers to use for CURL request.
     *
     * @return void

If there is no return value for a function, there must not be a @return tag.

Description for the @return value is missing

     */
    private function _setDefaultHeaders(): void

Line indented incorrectly; expected 2 spaces, found 4

Private method name "Curl::_setDefaultHeaders" is not in lowerCamel format

    {

Opening brace should be on the same line as the declaration

        $this->_defaultHeaders = [

Line indented incorrectly; expected 4 spaces, found 8

Short array syntax is not allowed

            'Content-Type: application/json',

Array indentation error, expected 10 spaces but found 12

            'Connection: Keep-Alive',

Array indentation error, expected 10 spaces but found 12

        ];
    }

Line indented incorrectly; expected 2 spaces, found 4

Expected 1 blank line 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.