railpage/railpagecore

View on GitHub
lib/Links/Category.php

Summary

Maintainability
B
5 hrs
Test Coverage

Function __construct has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

        public function __construct($category_id = false, $recurse = true) {
            parent::__construct(); 
            
            if (filter_var($category_id, FILTER_VALIDATE_INT)) {
                $this->id = $category_id;
Severity: Minor
Found in lib/Links/Category.php - About 1 hr 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 __construct has a boolean flag argument $category_id, which is a certain sign of a Single Responsibility Principle violation.
Open

        public function __construct($category_id = false, $recurse = true) {
Severity: Minor
Found in lib/Links/Category.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

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

The method getLinks has a boolean flag argument $sort, which is a certain sign of a Single Responsibility Principle violation.
Open

        public function getLinks($category_id = false, $sort = false, $direction = false) {
Severity: Minor
Found in lib/Links/Category.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

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

The method getLinks has a boolean flag argument $direction, which is a certain sign of a Single Responsibility Principle violation.
Open

        public function getLinks($category_id = false, $sort = false, $direction = false) {
Severity: Minor
Found in lib/Links/Category.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

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

The method __construct has a boolean flag argument $recurse, which is a certain sign of a Single Responsibility Principle violation.
Open

        public function __construct($category_id = false, $recurse = true) {
Severity: Minor
Found in lib/Links/Category.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

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

The method getLinks has a boolean flag argument $category_id, which is a certain sign of a Single Responsibility Principle violation.
Open

        public function getLinks($category_id = false, $sort = false, $direction = false) {
Severity: Minor
Found in lib/Links/Category.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

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

Avoid assigning values to variables in if clauses and the like (line '157', column '18').
Open

        public static function CreateCategory($category_id) {
            
            $Database = (new AppCore)->getDatabaseConnection(); 
            $Redis = AppCore::getRedis(); 
            
Severity: Minor
Found in lib/Links/Category.php by phpmd

IfStatementAssignment

Since: 2.7.0

Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

Example

class Foo
{
    public function bar($flag)
    {
        if ($foo = 'bar') { // possible typo
            // ...
        }
        if ($baz = 0) { // always false
            // ...
        }
    }
}

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

Avoid assigning values to variables in if clauses and the like (line '96', column '22').
Open

        public function __construct($category_id = false, $recurse = true) {
            parent::__construct(); 
            
            if (filter_var($category_id, FILTER_VALIDATE_INT)) {
                $this->id = $category_id;
Severity: Minor
Found in lib/Links/Category.php by phpmd

IfStatementAssignment

Since: 2.7.0

Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

Example

class Foo
{
    public function bar($flag)
    {
        if ($foo = 'bar') { // possible typo
            // ...
        }
        if ($baz = 0) { // always false
            // ...
        }
    }
}

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

Avoid assigning values to variables in if clauses and the like (line '183', column '17').
Open

        private static function getIdFromSlug($slug) {
            
            $Database = (new AppCore)->getDatabaseConnection(); 
            $Redis = AppCore::getRedis(); 
            
Severity: Minor
Found in lib/Links/Category.php by phpmd

IfStatementAssignment

Since: 2.7.0

Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

Example

class Foo
{
    public function bar($flag)
    {
        if ($foo = 'bar') { // possible typo
            // ...
        }
        if ($baz = 0) { // always false
            // ...
        }
    }
}

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

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

            } else {
                $this->id = self::getIdFromSlug($category_id); 
            }
Severity: Minor
Found in lib/Links/Category.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

Avoid unused parameters such as '$category_id'.
Open

        public function getLinks($category_id = false, $sort = false, $direction = false) {
Severity: Minor
Found in lib/Links/Category.php by phpmd

UnusedFormalParameter

Since: 0.2

Avoid passing parameters to methods or constructors and then not using those parameters.

Example

class Foo
{
    private function bar($howdy)
    {
        // $howdy is not used
    }
}

Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

Avoid unused parameters such as '$sort'.
Open

        public function getLinks($category_id = false, $sort = false, $direction = false) {
Severity: Minor
Found in lib/Links/Category.php by phpmd

UnusedFormalParameter

Since: 0.2

Avoid passing parameters to methods or constructors and then not using those parameters.

Example

class Foo
{
    private function bar($howdy)
    {
        // $howdy is not used
    }
}

Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

Avoid unused parameters such as '$direction'.
Open

        public function getLinks($category_id = false, $sort = false, $direction = false) {
Severity: Minor
Found in lib/Links/Category.php by phpmd

UnusedFormalParameter

Since: 0.2

Avoid passing parameters to methods or constructors and then not using those parameters.

Example

class Foo
{
    private function bar($howdy)
    {
        // $howdy is not used
    }
}

Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

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

            if (!filter_var($this->id, FILTER_VALIDATE_INT)) {
                throw new Exception("Cannot get links from a link category - invalid category ID given"); 
                return false;
            }
Severity: Major
Found in lib/Links/Category.php and 2 other locations - About 1 hr to fix
lib/Locos/Liveries/Livery.php on lines 178..181
lib/Locos/Locomotive.php on lines 446..449

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 38.

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

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

            if (!filter_var($category_id, FILTER_VALIDATE_INT)) {
                $category_id = self::getIdFromSlug($category_id) ;
            }
Severity: Major
Found in lib/Links/Category.php and 2 other locations - About 1 hr to fix
lib/Locations/Factory.php on lines 36..38
lib/Locos/Factory.php on lines 45..47

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 34.

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

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

        public function getLinks($category_id = false, $sort = false, $direction = false) {
            if (!filter_var($this->id, FILTER_VALIDATE_INT)) {
                throw new Exception("Cannot get links from a link category - invalid category ID given"); 
                return false;
            }
Severity: Major
Found in lib/Links/Category.php and 14 other locations - About 55 mins to fix
lib/Downloads/Download.php on lines 384..403
lib/Images/ImageFactory.php on lines 30..90
lib/Images/Images.php on lines 95..126
lib/Locations/Locations.php on lines 356..397
lib/Locos/Factory.php on lines 90..123
lib/Locos/LocoClass.php on lines 1038..1061
lib/Locos/Locomotive.php on lines 327..354
lib/Locos/Locomotive.php on lines 711..745
lib/Locos/Locomotive.php on lines 806..817
lib/Locos/Locomotive.php on lines 1118..1144
lib/Locos/Locos.php on lines 995..1019
lib/Modules/Modules.php on lines 91..112
lib/Notifications/Notification.php on lines 465..484
lib/Users/Utility/PasswordUtility.php on lines 68..96

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 28.

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

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

            $this->links = $this->db->fetchAll($query, $this->id);
Severity: Minor
Found in lib/Links/Category.php and 1 other location - About 35 mins to fix
lib/Users/Group.php on lines 393..393

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 22.

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

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

                    $row = $this->db->fetchRow("SELECT * FROM nuke_links_categories WHERE cid = ?", $this->id); 
Severity: Major
Found in lib/Links/Category.php and 6 other locations - About 30 mins to fix
lib/Gallery/Image.php on lines 263..263
lib/Gallery/Image.php on lines 401..401
lib/Images/Camera.php on lines 158..158
lib/Locos/Date.php on lines 147..147
lib/News/Topic.php on lines 348..348
lib/Railcams/Footage.php on lines 164..164

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 20.

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

The parameter $category_id is not named in camelCase.
Open

        public function __construct($category_id = false, $recurse = true) {
            parent::__construct(); 
            
            if (filter_var($category_id, FILTER_VALIDATE_INT)) {
                $this->id = $category_id;
Severity: Minor
Found in lib/Links/Category.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 $category_id is not named in camelCase.
Open

        public function getLinks($category_id = false, $sort = false, $direction = false) {
            if (!filter_var($this->id, FILTER_VALIDATE_INT)) {
                throw new Exception("Cannot get links from a link category - invalid category ID given"); 
                return false;
            }
Severity: Minor
Found in lib/Links/Category.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 $category_id is not named in camelCase.
Open

        public static function CreateCategory($category_id) {
            
            $Database = (new AppCore)->getDatabaseConnection(); 
            $Redis = AppCore::getRedis(); 
            
Severity: Minor
Found in lib/Links/Category.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

Function closing brace must go on the next line following the body; found 1 blank lines before brace
Open

        }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Function closing brace must go on the next line following the body; found 1 blank lines before brace
Open

        }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            if (filter_var($this->id, FILTER_VALIDATE_INT)) {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public static function CreateCategory($category_id) {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public function __construct($category_id = false, $recurse = true) {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            if (!filter_var($this->id, FILTER_VALIDATE_INT)) {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public $id;
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public $parent;
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 12 spaces, found 16
Open

                }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 12 spaces, found 16
Open

                if ($this->parent_id > 0 && $recurse) {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        private static function getIdFromSlug($slug) {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            if (filter_var($category_id, FILTER_VALIDATE_INT)) {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 12 spaces, found 16
Open

                }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public $slug; 
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public $links = array();
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public function getLinks($category_id = false, $sort = false, $direction = false) {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            if (!$Category = $Redis->fetch($key)) {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public $desc;
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            if (!filter_var($category_id, FILTER_VALIDATE_INT)) {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            if ($id = $Redis->fetch($key)) {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public $name;
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public $url;
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public $parent_id;
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 16 spaces, found 20
Open

                    if (!empty($row)) {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            if (!filter_var($category_id, FILTER_VALIDATE_INT)) {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 0 spaces, found 4
Open

    }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 0 spaces, found 4
Open

    class Category extends Links {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 12 spaces, found 16
Open

                if (!$row = $this->Memcached->fetch($this->mckey)) {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 16 spaces, found 20
Open

                    }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        }
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            } else {
Severity: Minor
Found in lib/Links/Category.php by phpcodesniffer

There are no issues that match your filters.

Category
Status