rattfieldnz / shodan

src/Shodan.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 "Shodan.php" doesn't match the expected filename "shodan.php"

Missing file doc comment

namespace RattfieldNz\Shodan;

use ErrorException;
use RattfieldNz\Shodan\Libraries\Curl\Curl;
use RattfieldNz\Shodan\Libraries\Data\Data;

/**
 * Class Shodan.
 *
 * @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 Shodan
{

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

    private $_url;

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

Missing member variable doc comment

    private $_results;

Missing member variable doc comment

    private $_data;

Missing member variable doc comment

    public function __construct()

Expected 2 blank lines before function; 1 found

Missing doc comment for function __construct()

    {

Opening brace should be on the same line as the declaration

        $this->_results = null;

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

    /**
     * Add URL to be checked with Shodan API.
     *
     * @param string $url The URL to be checked.
     *
     * @return Shodan.

The doc comment Shodan. at position 0 could not be parsed: Unknown type name 'Shodan.' at position 0 in Shodan..

     */
    public function setUrl(string $url)
    {

Opening brace should be on the same line as the declaration

        $this->_url = $url;

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

        $this->_data = new Data($this->_url);

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setUrl()

    /**
     * Checks a given URL with Shodan API.
     *
     * @throws ErrorException

Comment missing for @throws tag in function comment

     *
     * @return Shodan
     */
    public function check()
    {

Opening brace should be on the same line as the declaration

        $error = [

Short array syntax is not allowed

            'status'   => 500,

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

            'response' => 'URL cannot be null.',

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

        ];

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

        $this->_results = empty($this->getUrl()) || empty($this->_data) ?

The value of a boolean operation must not be assigned to a variable

Boolean operators are not allowed outside of control structure conditions

Expected 1 space after "?"; newline found

Inline IF statements are not allowed

Inline shorthand IF statement must be declared on a single line

            $error : (new Curl($this->_data))->getData();

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end check()

    /**
     * Get current URL.
     *
     * @return string|null
     */
    public function getUrl()
    {

Opening brace should be on the same line as the declaration

        return $this->_url;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getUrl()

    /**
     * Get results of Shodan API call.
     *
     * @param bool $jsonEncode Encode results as JSON, or

Expected "boolean" but found "bool" for parameter type

     *                         return as associative array.
     *
     * @return mixed|null
     */
    public function getResults(bool $jsonEncode = false)

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

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

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

    {

Opening brace should be on the same line as the declaration

        if (empty($this->_results)) {
            return;

Function return type is not void, but function is returning void here

        }

        return $jsonEncode === false ?

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

Expected 1 space after "?"; newline found

Inline IF statements are not allowed

Inline shorthand IF statement must be declared on a single line

            $this->_results : json_encode($this->_results);
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getResults()

}

Expected //end class

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