Sign upLogin

railpage/railpagecore

View on GitHub
Star
lib/News/Utility/ArticleUtility.php

Summary

Maintainability
B
4 hrs
Test Coverage

Function FormatArticleText has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

        public static function FormatArticleText($Article, $section = "lead") {
            
            $Memcached = AppCore::GetMemcached(); 
            
            $cachekey = $section == "lead" ? Article::CACHE_KEY_FORMAT_LEAD : Article::CACHE_KEY_FORMAT_PARAGRAPHS;
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php - About 25 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 updateUserArticleView has a boolean flag argument $User, which is a certain sign of a Single Responsibility Principle violation.
Open

        public static function updateUserArticleView(Article $Article, $User = false) {
Severity: Minor
Found in lib/News/Utility/ArticleUtility.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 '91', column '18').
Open

        public static function FormatArticleText($Article, $section = "lead") {
            
            $Memcached = AppCore::GetMemcached(); 
            
            $cachekey = $section == "lead" ? Article::CACHE_KEY_FORMAT_LEAD : Article::CACHE_KEY_FORMAT_PARAGRAPHS;
Severity: Minor
Found in lib/News/Utility/ArticleUtility.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

            $query = sprintf("INSERT INTO nuke_stories_view (story_id, user_id, viewed) VALUES (%d, %d, CURRENT_TIMESTAMP()) ON DUPLICATE KEY UPDATE viewed = CURRENT_TIMESTAMP()",
                $Database->quote(intval($Article->id)),
                $Database->quote(intval($User->id))
            );
Severity: Major
Found in lib/News/Utility/ArticleUtility.php and 1 other location - About 1 hr to fix
lib/Forums/Utility/ForumsUtility.php on lines 52..55

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

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

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

            if (!$User instanceof User || $User->id == 0 || $User->guest) {
                return;
            }
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php and 1 other location - About 55 mins to fix
lib/Forums/Utility/ForumsUtility.php on lines 46..48

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

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 (is_object($text)) {
                        $text = $text->__toString(); 
                    }
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php and 2 other locations - About 35 mins to fix
lib/Formatting/EmoticonsUtility.php on lines 75..77
lib/ContentUtility.php on lines 85..87

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

                    $text = str_replace($whitespace_find, $whitespace_replace, $text);
Severity: Major
Found in lib/News/Utility/ArticleUtility.php and 7 other locations - About 30 mins to fix
lib/Formatting/BbcodeUtility.php on lines 109..109
lib/Formatting/BbcodeUtility.php on lines 124..124
lib/Formatting/MultimediaUtility.php on lines 191..191
lib/Images/Exif.php on lines 230..230
lib/Links/Links.php on lines 305..305
lib/News/Base.php on lines 347..347
lib/AppCore.php on lines 700..700

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 $User is not named in camelCase.
Open

        public static function getReadArticlesForUser($User) {
            
            if (!$User instanceof User || $User->id == 0 || $User->guest) {
                return array(); 
            }
Severity: Minor
Found in lib/News/Utility/ArticleUtility.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 $Article is not named in camelCase.
Open

        public static function FormatArticleText($Article, $section = "lead") {
            
            $Memcached = AppCore::GetMemcached(); 
            
            $cachekey = $section == "lead" ? Article::CACHE_KEY_FORMAT_LEAD : Article::CACHE_KEY_FORMAT_PARAGRAPHS;
Severity: Minor
Found in lib/News/Utility/ArticleUtility.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 $Article is not named in camelCase.
Open

        public static function updateUserArticleView(Article $Article, $User = false) {
            
            if (!$User instanceof User || $User->id == 0 || $User->guest) {
                return;
            }
Severity: Minor
Found in lib/News/Utility/ArticleUtility.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 $User is not named in camelCase.
Open

        public static function updateUserArticleView(Article $Article, $User = false) {
            
            if (!$User instanceof User || $User->id == 0 || $User->guest) {
                return;
            }
Severity: Minor
Found in lib/News/Utility/ArticleUtility.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/News/Utility/ArticleUtility.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/News/Utility/ArticleUtility.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/News/Utility/ArticleUtility.php by phpcodesniffer

Blank line found at start of control structure
Open

            if (!$text = $Memcached->Fetch($cachekey)) {
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Blank line found at end of control structure
Open
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Blank line found at end of control structure
Open
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Blank line found at start of control structure
Open

                if (function_exists("format_post")) {
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 12 spaces, found 16
Open

                }
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 0 spaces, found 4
Open

    class ArticleUtility {
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 0 spaces, found 4
Open

    }
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public static function getReadArticlesForUser($User) {
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public static function FormatArticleText($Article, $section = "lead") {
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            }
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            if (!$User instanceof User || $User->id == 0 || $User->guest) {
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 12 spaces, found 16
Open

                if (function_exists("format_post")) {
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            if (!$text = $Memcached->Fetch($cachekey)) {
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 16 spaces, found 20
Open

                    if (is_object($text)) {
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        }
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 16 spaces, found 20
Open

                    }
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        }
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            }
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        }
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            if (!$User instanceof User || $User->id == 0 || $User->guest) {
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Opening parenthesis of a multi-line function call must be the last content on the line
Open

            $query = sprintf("INSERT INTO nuke_stories_view (story_id, user_id, viewed) VALUES (%d, %d, CURRENT_TIMESTAMP()) ON DUPLICATE KEY UPDATE viewed = CURRENT_TIMESTAMP()",
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 8 spaces, found 12
Open

            }
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public static function updateUserArticleView(Article $Article, $User = false) {
Severity: Minor
Found in lib/News/Utility/ArticleUtility.php by phpcodesniffer

There are no issues that match your filters.

Category
Status