RattfieldNz\Shodan\Libraries\Data\Data

Complexity

Total Complexity

5

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	shodanApiUrl()	0	4	1
A	__construct()	0	4	1
A	getUrl()	0	3	1
A	getIp()	0	6	2

<?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 "Data.php" doesn't match the expected filename "data.php"

Missing file doc comment

namespace RattfieldNz\Shodan\Libraries\Data;

use RattfieldNz\Shodan\Libraries\Config\Config;

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

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

Opening brace should be on the same line as the declaration

    private $_ip;

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 $_ip should use lowerCamel naming without underscores

    private $_url;

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 $_url should use lowerCamel naming without underscores

    public function __construct(string $url)

Line indented incorrectly; expected 2 spaces, found 4

Missing doc comment for function __construct()

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        $this->_url = $url;

Line indented incorrectly; expected 4 spaces, found 8

        $this->_ip = $this->getIp($this->_url);

Line indented incorrectly; expected 4 spaces, found 8

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

    }

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

     * Get Shodan API URL with key.
     *
     * @return string

Description for the @return value is missing

     */
    public function shodanApiUrl()

Line indented incorrectly; expected 2 spaces, found 4

    {

Opening brace should be on the same line as the declaration

        return 'https://api.shodan.io/shodan/host/'.$this->_ip.'?key='.

Line indented incorrectly; expected 4 spaces, found 8

Concat operator must be surrounded by a single space

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

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

            Config::shodanApiKey();
    }

Line indented incorrectly; expected 2 spaces, found 4

Expected 1 blank line before closing function brace; 0 found

Expected //end shodanApiUrl()

    /**

Line indented incorrectly; expected 2 spaces, found 4

     * Get IPv4 address from a URL.
     *
     * @param string $url

Missing parameter comment

     *
     * @return string|null

Description for the @return value is missing

     */
    public function getIp(string $url): string

Line indented incorrectly; expected 2 spaces, found 4

    {

Opening brace should be on the same line as the declaration

        $domain = parse_url($url)['host'];

Line indented incorrectly; expected 4 spaces, found 8

        $ip = gethostbyname($domain);

Line indented incorrectly; expected 4 spaces, found 8

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

        return filter_var($ip, FILTER_VALIDATE_IP) ? $ip : null;

The expression return filter_var($ip, RattfieldNz\Shodan\Libraries\Data\FILTER_VALIDATE_IP) ? $ip : null could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

Line indented incorrectly; expected 4 spaces, found 8

Inline IF statements are not allowed

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

    }

Line indented incorrectly; expected 2 spaces, found 4

Expected 1 blank line before closing function brace; 0 found

Expected //end getIp()

    /**

Line indented incorrectly; expected 2 spaces, found 4

     * Returns URL set when initialising Data object.
     *
     * @return string

Description for the @return value is missing

     */
    public function getUrl()

Line indented incorrectly; expected 2 spaces, found 4

    {

Opening brace should be on the same line as the declaration

        return $this->_url;

Line indented incorrectly; expected 4 spaces, found 8

    }

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

}

Expected //end class

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