RattfieldNz\Shodan\Libraries\Data\Data

Complexity

Total Complexity

6

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Test Coverage

Coverage

100%

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	10	3

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

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

    private $_ip;

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

Missing member variable doc comment

    private $_url;

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

Missing member variable doc comment

    public function __construct(string $url)

Missing doc comment for function __construct()

Expected 2 blank lines before function; 1 found

    {

Opening brace should be on the same line as the declaration

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

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

    }

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

Expected 2 blank lines after function; 1 found

    /**
     * Get Shodan API URL with key.
     *
     * @return string
     */
    public function shodanApiUrl()
    {

Opening brace should be on the same line as the declaration

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

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

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

Concat operator must not be surrounded by spaces

            Config::shodanApiKey();
    }

Expected 1 blank line before closing function brace; 0 found

Expected //end shodanApiUrl()

Expected 2 blank lines after function; 1 found

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

Missing parameter comment

     *
     * @return string|null
     */
    public function getIp(string $url)
    {

Opening brace should be on the same line as the declaration

        $domain = parse_url($url);
        if (empty($domain['host'])) {
            return;

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

        }

        $ip = gethostbyname($domain['host']);

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

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.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getIp()

    /**
     * Returns URL set when initialising Data object.
     *
     * @return string
     */
    public function getUrl()
    {

Opening brace should be on the same line as the declaration

        return $this->_url;
    }

Expected 2 blank lines 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.