AppStateESS/InternshipInventory

View on GitHub
class/DataProvider/Curl.php

Summary

Maintainability
A
2 hrs
Test Coverage

The class Curl has 19 fields. Consider redesigning Curl to keep the number of fields under 15.
Open

class Curl {

    const DEFAULT_TIMEOUT = 30;

    public $curl;
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

TooManyFields

Since: 0.1

Classes that have too many fields could be redesigned to have fewer fields, possibly through some nested object grouping of some of the information. For example, a class with city/state/zip fields could instead have one Address field.

Example

class Person {
   protected $one;
   private $two;
   private $three;
   [... many more fields ...]
}

Source https://phpmd.org/rules/codesize.html#toomanyfields

Method exec has 32 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function exec($ch = null)
    {

        if ($ch === null) {
            $this->rawResponse = curl_exec($this->curl);
Severity: Minor
Found in class/DataProvider/Curl.php - About 1 hr to fix

Function exec has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

    public function exec($ch = null)
    {

        if ($ch === null) {
            $this->rawResponse = curl_exec($this->curl);
Severity: Minor
Found in class/DataProvider/Curl.php - About 55 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

The method exec() has an NPath complexity of 384. The configured NPath complexity threshold is 200.
Open

    public function exec($ch = null)
    {

        if ($ch === null) {
            $this->rawResponse = curl_exec($this->curl);
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

NPathComplexity

Since: 0.1

The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

Example

class Foo {
    function bar() {
        // lots of complicated code
    }
}

Source https://phpmd.org/rules/codesize.html#npathcomplexity

The method exec() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10.
Open

    public function exec($ch = null)
    {

        if ($ch === null) {
            $this->rawResponse = curl_exec($this->curl);
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CyclomaticComplexity

Since: 0.1

Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

Example

// Cyclomatic Complexity = 11
class Foo {
1   public function example() {
2       if ($a == $b) {
3           if ($a1 == $b1) {
                fiddle();
4           } elseif ($a2 == $b2) {
                fiddle();
            } else {
                fiddle();
            }
5       } elseif ($c == $d) {
6           while ($c == $d) {
                fiddle();
            }
7        } elseif ($e == $f) {
8           for ($n = 0; $n < $h; $n++) {
                fiddle();
            }
        } else {
            switch ($z) {
9               case 1:
                    fiddle();
                    break;
10              case 2:
                    fiddle();
                    break;
11              case 3:
                    fiddle();
                    break;
                default:
                    fiddle();
                    break;
            }
        }
    }
}

Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

Missing class import via use statement (line '62', column '23').
Open

            throw new \ErrorException('cURL library is not loaded');
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

MissingImport

Since: 2.7.0

Importing all external classes in a file through use statements makes them clearly visible.

Example

function make() {
    return new \stdClass();
}

Source http://phpmd.org/rules/cleancode.html#MissingImport

The method exec uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

        } else {
            $this->rawResponse = curl_multi_getcontent($ch);
            $this->curlErrorMessage = curl_error($ch);
        }
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

ElseExpression

Since: 1.4.0

An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

Example

class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

Source https://phpmd.org/rules/cleancode.html#elseexpression

Reference to undeclared property \Intern\DataProvider\Curl->httpErrorMessage (Did you mean expr->httpErrorMesasge)
Open

                $this->httpErrorMessage = $this->responseHeaders['Status-Line'];
Severity: Minor
Found in class/DataProvider/Curl.php by phan

Reference to undeclared property \Intern\DataProvider\Curl->httpErrorMessage (Did you mean expr->httpErrorMesasge)
Open

        $this->httpErrorMessage = '';
Severity: Minor
Found in class/DataProvider/Curl.php by phan

Reference to undeclared property \Intern\DataProvider\Curl->httpErrorMessage (Did you mean expr->httpErrorMesasge)
Open

        $this->errorMessage = $this->curlError ? $this->curlErrorMessage : $this->httpErrorMessage;
Severity: Minor
Found in class/DataProvider/Curl.php by phan

Avoid variables with short names like $id. Configured minimum length is 3.
Open

    public $id = null;
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

ShortVariable

Since: 0.2

Detects when a field, local, or parameter has a very short name.

Example

class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

Source https://phpmd.org/rules/naming.html#shortvariable

The parameter $base_url is not named in camelCase.
Open

    public function __construct($base_url = null)
    {
        if (!extension_loaded('curl')) {
            throw new \ErrorException('cURL library is not loaded');
        }
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseParameterName

Since: 0.2

It is considered best practice to use the camelCase notation to name parameters.

Example

class ClassName {
    public function doSomething($user_name) {
    }
}

Source

Avoid variables with short names like $ch. Configured minimum length is 3.
Open

    public function exec($ch = null)
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

ShortVariable

Since: 0.2

Detects when a field, local, or parameter has a very short name.

Example

class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

Source https://phpmd.org/rules/naming.html#shortvariable

The parameter $base_url is not named in camelCase.
Open

    private function initialize($base_url = null) {
        $this->id = uniqid('', true);
        //        $this->setDefaultUserAgent();
        //        $this->setDefaultTimeout();
        $this->setOpt(CURLINFO_HEADER_OUT, true);
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseParameterName

Since: 0.2

It is considered best practice to use the camelCase notation to name parameters.

Example

class ClassName {
    public function doSomething($user_name) {
    }
}

Source

The parameter $mixed_data is not named in camelCase.
Open

    private function buildUrl($url, $mixed_data = '') {
        $query_string = '';
        if (!empty($mixed_data)) {
            $query_mark = strpos($url, '?') > 0 ? '&' : '?';
            if (is_string($mixed_data)) {
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseParameterName

Since: 0.2

It is considered best practice to use the camelCase notation to name parameters.

Example

class ClassName {
    public function doSomething($user_name) {
    }
}

Source

The parameter $mixed_data is not named in camelCase.
Open

    public function setUrl($url, $mixed_data = '') {
        $this->url = $this->buildUrl($url, $mixed_data);
        $this->setOpt(CURLOPT_URL, $this->url);
    }
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseParameterName

Since: 0.2

It is considered best practice to use the camelCase notation to name parameters.

Example

class ClassName {
    public function doSomething($user_name) {
    }
}

Source

The variable $base_url is not named in camelCase.
Open

    public function __construct($base_url = null)
    {
        if (!extension_loaded('curl')) {
            throw new \ErrorException('cURL library is not loaded');
        }
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $mixed_data is not named in camelCase.
Open

    private function buildUrl($url, $mixed_data = '') {
        $query_string = '';
        if (!empty($mixed_data)) {
            $query_mark = strpos($url, '?') > 0 ? '&' : '?';
            if (is_string($mixed_data)) {
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $required_options is not named in camelCase.
Open

    public function setOpt($option, $value) {
        $required_options = array(
            CURLOPT_RETURNTRANSFER => 'CURLOPT_RETURNTRANSFER',
        );

Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $query_mark is not named in camelCase.
Open

    private function buildUrl($url, $mixed_data = '') {
        $query_string = '';
        if (!empty($mixed_data)) {
            $query_mark = strpos($url, '?') > 0 ? '&' : '?';
            if (is_string($mixed_data)) {
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $required_options is not named in camelCase.
Open

    public function setOpt($option, $value) {
        $required_options = array(
            CURLOPT_RETURNTRANSFER => 'CURLOPT_RETURNTRANSFER',
        );

Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $mixed_data is not named in camelCase.
Open

    private function buildUrl($url, $mixed_data = '') {
        $query_string = '';
        if (!empty($mixed_data)) {
            $query_mark = strpos($url, '?') > 0 ? '&' : '?';
            if (is_string($mixed_data)) {
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $mixed_data is not named in camelCase.
Open

    private function buildUrl($url, $mixed_data = '') {
        $query_string = '';
        if (!empty($mixed_data)) {
            $query_mark = strpos($url, '?') > 0 ? '&' : '?';
            if (is_string($mixed_data)) {
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $query_string is not named in camelCase.
Open

    private function buildUrl($url, $mixed_data = '') {
        $query_string = '';
        if (!empty($mixed_data)) {
            $query_mark = strpos($url, '?') > 0 ? '&' : '?';
            if (is_string($mixed_data)) {
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $query_string is not named in camelCase.
Open

    private function buildUrl($url, $mixed_data = '') {
        $query_string = '';
        if (!empty($mixed_data)) {
            $query_mark = strpos($url, '?') > 0 ? '&' : '?';
            if (is_string($mixed_data)) {
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $mixed_data is not named in camelCase.
Open

    public function setUrl($url, $mixed_data = '') {
        $this->url = $this->buildUrl($url, $mixed_data);
        $this->setOpt(CURLOPT_URL, $this->url);
    }
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $query_mark is not named in camelCase.
Open

    private function buildUrl($url, $mixed_data = '') {
        $query_string = '';
        if (!empty($mixed_data)) {
            $query_mark = strpos($url, '?') > 0 ? '&' : '?';
            if (is_string($mixed_data)) {
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $query_string is not named in camelCase.
Open

    private function buildUrl($url, $mixed_data = '') {
        $query_string = '';
        if (!empty($mixed_data)) {
            $query_mark = strpos($url, '?') > 0 ? '&' : '?';
            if (is_string($mixed_data)) {
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $query_mark is not named in camelCase.
Open

    private function buildUrl($url, $mixed_data = '') {
        $query_string = '';
        if (!empty($mixed_data)) {
            $query_mark = strpos($url, '?') > 0 ? '&' : '?';
            if (is_string($mixed_data)) {
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $query_string is not named in camelCase.
Open

    private function buildUrl($url, $mixed_data = '') {
        $query_string = '';
        if (!empty($mixed_data)) {
            $query_mark = strpos($url, '?') > 0 ? '&' : '?';
            if (is_string($mixed_data)) {
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $base_url is not named in camelCase.
Open

    private function initialize($base_url = null) {
        $this->id = uniqid('', true);
        //        $this->setDefaultUserAgent();
        //        $this->setDefaultTimeout();
        $this->setOpt(CURLINFO_HEADER_OUT, true);
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $required_options is not named in camelCase.
Open

    public function setOpt($option, $value) {
        $required_options = array(
            CURLOPT_RETURNTRANSFER => 'CURLOPT_RETURNTRANSFER',
        );

Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $mixed_data is not named in camelCase.
Open

    private function buildUrl($url, $mixed_data = '') {
        $query_string = '';
        if (!empty($mixed_data)) {
            $query_mark = strpos($url, '?') > 0 ? '&' : '?';
            if (is_string($mixed_data)) {
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $mixed_data is not named in camelCase.
Open

    private function buildUrl($url, $mixed_data = '') {
        $query_string = '';
        if (!empty($mixed_data)) {
            $query_mark = strpos($url, '?') > 0 ? '&' : '?';
            if (is_string($mixed_data)) {
Severity: Minor
Found in class/DataProvider/Curl.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

There are no issues that match your filters.

Category
Status