Sign upLogin

AppStateESS/InternshipInventory

View on GitHub
Star
class/AffiliationAgreementFactory.php

Summary

Maintainability
A
1 hr
Test Coverage

Method save has 31 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static function save(AffiliationAgreement $agreement)
    {
        if(!isset($agreement) || is_null($agreement)){
            throw new \InvalidArgumentException('Missing agreement object');
        }
Severity: Minor
Found in class/AffiliationAgreementFactory.php - About 1 hr to fix

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

            throw new \InvalidArgumentException('AffiliationAgreement ID must be greater than zero.');
Severity: Minor
Found in class/AffiliationAgreementFactory.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 '38', column '23').
Open

            throw new \InvalidArgumentException('AffiliationAgreement ID is required.');
Severity: Minor
Found in class/AffiliationAgreementFactory.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 '45', column '19').
Open

        $db = new \PHPWS_DB('intern_affiliation_agreement');
Severity: Minor
Found in class/AffiliationAgreementFactory.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 '82', column '23').
Open

            throw new \InvalidArgumentException('Missing agreement object');
Severity: Minor
Found in class/AffiliationAgreementFactory.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 'Intern\PdoFactory' in method 'save'.
Open

        $db = PdoFactory::getPdoInstance();
Severity: Minor
Found in class/AffiliationAgreementFactory.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 '\PHPWS_Error' in method 'getAffiliationById'.
Open

        if(\PHPWS_Error::logIfError($result)){
Severity: Minor
Found in class/AffiliationAgreementFactory.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

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

        } else {
            $values = array('id' => $id,
                        'name' => $agreement->getName(),
                        'beginDate' => $agreement->getBeginDate(),
                        'endDate' => $agreement->getEndDate(),
Severity: Minor
Found in class/AffiliationAgreementFactory.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

Call to method __construct from undeclared class \PHPWS_DB
Open

        $db = new \PHPWS_DB('intern_affiliation_agreement');
Severity: Critical
Found in class/AffiliationAgreementFactory.php by phan

Call to method logIfError from undeclared class \PHPWS_Error
Open

        if(\PHPWS_Error::logIfError($result)){
Severity: Critical
Found in class/AffiliationAgreementFactory.php by phan

Saw possibly unextractable annotation for a fragment of comment '* @param AffiliationAgreement': after AffiliationAgreement, did not see an element name (will guess based on comment order)
Open

     * @param AffiliationAgreement
Severity: Info
Found in class/AffiliationAgreementFactory.php by phan

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

    public static function save(AffiliationAgreement $agreement)
Severity: Minor
Found in class/AffiliationAgreementFactory.php by phan

Saw misspelled annotation @returns. Did you mean @return?
Open

     * @returns AffiliationAgreement
Severity: Info
Found in class/AffiliationAgreementFactory.php by phan

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

    public static function save(AffiliationAgreement $agreement)
Severity: Minor
Found in class/AffiliationAgreementFactory.php by phan

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

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

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

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

Call to method addWhere from undeclared class \PHPWS_DB
Open

        $db->addWhere('id', $id);
Severity: Critical
Found in class/AffiliationAgreementFactory.php by phan

Call to method __construct from undeclared class \Intern\DatabaseException
Open

            throw new DatabaseException($result->toString());
Severity: Critical
Found in class/AffiliationAgreementFactory.php by phan

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

    public static function save(AffiliationAgreement $agreement)
Severity: Minor
Found in class/AffiliationAgreementFactory.php by phan

Call to method select from undeclared class \PHPWS_DB
Open

        $result = $db->select('row');
Severity: Critical
Found in class/AffiliationAgreementFactory.php by phan

Returning type null but getAffiliationById() is declared to return \Intern\AffiliationAgreement
Open

            return null;
Severity: Minor
Found in class/AffiliationAgreementFactory.php by phan

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

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

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

    public static function getAffiliationById($id)
Severity: Minor
Found in class/AffiliationAgreementFactory.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 = new \PHPWS_DB('intern_affiliation_agreement');
Severity: Minor
Found in class/AffiliationAgreementFactory.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 = PdoFactory::getPdoInstance();
Severity: Minor
Found in class/AffiliationAgreementFactory.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

        $id = $agreement->getId();
Severity: Minor
Found in class/AffiliationAgreementFactory.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