railpage/railpagecore

View on GitHub
lib/Glossary/Glossary.php

Summary

Maintainability
C
7 hrs
Test Coverage

Function lookupText has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    public function lookupText($text) {
        
        $cachekey = sprintf("railpage:glossary.lookup.text=%s", md5($text)); 
        
        if ($id = $this->Redis->fetch($cachekey)) {
Severity: Minor
Found in lib/Glossary/Glossary.php - About 45 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

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

    public function lookupText($text) {
        
        $cachekey = sprintf("railpage:glossary.lookup.text=%s", md5($text)); 
        
        if ($id = $this->Redis->fetch($cachekey)) {
Severity: Minor
Found in lib/Glossary/Glossary.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

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

    public function getNewEntries($num = 10) {
        
        $query = "SELECT id FROM glossary WHERE status = ? ORDER BY date DESC LIMIT 0, ?";
        
        foreach ($this->db->fetchAll($query, array(Entry::STATUS_APPROVED, $num)) as $row) {
Severity: Major
Found in lib/Glossary/Glossary.php and 1 other location - About 2 hrs to fix
lib/Glossary/Glossary.php on lines 67..75

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

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

    public function getPendingEntries($num = 100) {
        
        $query = "SELECT id FROM glossary WHERE status = ? ORDER BY date DESC LIMIT 0, ?";
        
        foreach ($this->db->fetchAll($query, array(Entry::STATUS_UNAPPROVED, $num)) as $row) {
Severity: Major
Found in lib/Glossary/Glossary.php and 1 other location - About 2 hrs to fix
lib/Glossary/Glossary.php on lines 50..58

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

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 22 locations. Consider refactoring.
Open

                $this->Redis->save($cachekey, $id, strtotime("+1 year")); 
Severity: Major
Found in lib/Glossary/Glossary.php and 21 other locations - About 40 mins to fix
lib/Chronicle/Chronicle.php on lines 119..119
lib/Config/Base.php on lines 40..40
lib/Config/Base.php on lines 111..111
lib/Downloads/Download.php on lines 530..530
lib/Images/Images.php on lines 110..110
lib/Links/Links.php on lines 94..94
lib/Links/Links.php on lines 129..129
lib/Locations/Country.php on lines 179..179
lib/Locations/Country.php on lines 180..180
lib/Locations/Location.php on lines 811..811
lib/Locations/Locations.php on lines 76..76
lib/Locations/Locations.php on lines 127..127
lib/Locations/Locations.php on lines 161..161
lib/Locations/Locations.php on lines 474..474
lib/Locos/Locomotive.php on lines 1227..1227
lib/Locos/Locomotive.php on lines 1538..1538
lib/Locos/Locos.php on lines 238..238
lib/PrivateMessages/Folder.php on lines 259..259
lib/Users/Base.php on lines 82..82
lib/Users/Timeline.php on lines 241..241
lib/Place.php on lines 600..600

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

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 6 locations. Consider refactoring.
Open

        $cachekey = sprintf("railpage:glossary.lookup.text=%s", md5($text)); 
Severity: Major
Found in lib/Glossary/Glossary.php and 5 other locations - About 40 mins to fix
lib/Downloads/DownloadsFactory.php on lines 34..34
lib/Images/Collage.php on lines 229..229
lib/Images/Utility/Finder.php on lines 757..757
lib/Timetables/Train.php on lines 279..279
lib/Url.php on lines 115..115

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

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 4 locations. Consider refactoring.
Open

        if (isset($id) && filter_var($id, FILTER_VALIDATE_INT)) {
            return new Entry($id); 
        }
Severity: Major
Found in lib/Glossary/Glossary.php and 3 other locations - About 30 mins to fix
lib/Images/Images.php on lines 113..115
lib/Images/Images.php on lines 161..166
lib/News/Topic.php on lines 105..109

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

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

Blank line found at end of control structure
Open

                
Severity: Minor
Found in lib/Glossary/Glossary.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/Glossary/Glossary.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/Glossary/Glossary.php by phpcodesniffer

There are no issues that match your filters.

Category
Status