AppStateESS/InternshipInventory

View on GitHub
class/InternshipFactory.php

Summary

Maintainability
A
2 hrs
Test Coverage

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

            throw new \InvalidArgumentException('Internship ID must be greater than zero.');
Severity: Minor
Found in class/InternshipFactory.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

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

            throw new \InvalidArgumentException('Internship ID is required.');
Severity: Minor
Found in class/InternshipFactory.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

Avoid using static access to class '\phpws2\Database' in method 'getInternshipById'.
Open

        $db = Database::newDB();
Severity: Minor
Found in class/InternshipFactory.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

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

Avoid using static access to class '\phpws2\Database' in method 'getPendingInternshipsByTerm'.
Open

        $db = Database::newDB();
Severity: Minor
Found in class/InternshipFactory.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

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

@throws type of getInternshipById has undeclared type \Intern\InternshipNotFoundException (Did you mean class \Intern\Exception\InternshipNotFoundException)
Open

    public static function getInternshipById($id)
Severity: Minor
Found in class/InternshipFactory.php by phan

@throws type of getPendingInternshipsByTerm has undeclared type \Intern\InvalidArgumentException (Did you mean class \InvalidArgumentException)
Open

    public static function getPendingInternshipsByTerm(Term $term)
Severity: Minor
Found in class/InternshipFactory.php by phan

@throws type of getInternshipById has undeclared type \Intern\Exception (Did you mean class \Exception)
Open

    public static function getInternshipById($id)
Severity: Minor
Found in class/InternshipFactory.php by phan

Call to method newDB from undeclared class \phpws2\Database
Open

        $db = Database::newDB();
Severity: Critical
Found in class/InternshipFactory.php by phan

@throws type of getInternshipById has undeclared type \Intern\InvalidArgumentException (Did you mean class \InvalidArgumentException)
Open

    public static function getInternshipById($id)
Severity: Minor
Found in class/InternshipFactory.php by phan

Doc-block of $term in getPendingInternshipsByTerm contains phpdoc param type int which is incompatible with the param type \Intern\Term declared in the signature
Open

     * @param int $term
Severity: Minor
Found in class/InternshipFactory.php by phan

Call to method newDB from undeclared class \phpws2\Database
Open

        $db = Database::newDB();
Severity: Critical
Found in class/InternshipFactory.php by phan

Similar blocks of code found in 3 locations. Consider refactoring.
Open

    public static function getInternshipById($id)
    {
        if(is_null($id) || !isset($id)){
            throw new \InvalidArgumentException('Internship ID is required.');
        }
Severity: Major
Found in class/InternshipFactory.php and 2 other locations - About 2 hrs to fix
class/SubHostFactory.php on lines 26..43
class/SupervisorFactory.php on lines 26..43

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 127.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

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

        $db = Database::newDB();
Severity: Minor
Found in class/InternshipFactory.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

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

        $db = Database::newDB();
Severity: Minor
Found in class/InternshipFactory.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

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

    public static function getInternshipById($id)
Severity: Minor
Found in class/InternshipFactory.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

There are no issues that match your filters.

Category
Status