RattfieldNz\Shodan\Libraries\Config\Config

Complexity

Total Complexity

4

Size/Duplication

Total Lines	27
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	curlTimeout()	0	5	2
A	shodanApiKey()	0	5	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 "Config.php" doesn't match the expected filename "config.php"

Missing file doc comment

namespace RattfieldNz\Shodan\Libraries\Config;

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

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

    // Default timeout for API call.
    public const DEFAULT_TIMEOUT = 10;

    /**
     * Retrieve the Shodan API key.
     *
     * @return mixed|string|null The Google API key.
     */
    public static function shodanApiKey()

Expected 2 blank lines before function; 1 found

    {

Opening brace should be on the same line as the declaration

        $key = config('shodan.shodan.api_key');

        return !empty($key) ? $key : null;

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

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

    /**
     * Retrieve set CURL timeout from config, in seconds.
     *
     * @return int CURL timeout. Default is 10.

Expected "integer" but found "int" for function return type

     */
    public static function curlTimeout(): int
    {

Opening brace should be on the same line as the declaration

        $timeout = config('shodan.shodan.timeout');

        return !empty($timeout) ? intval($timeout) : self::DEFAULT_TIMEOUT;

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

Inline IF statements are not allowed

    }

Expected 1 blank line before closing function brace; 0 found

Expected //end curlTimeout()

Expected 2 blank lines after function; 0 found

}

Expected //end class

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