railpage/railpagecore

View on GitHub
lib/Warnings/Warning.php

Summary

Maintainability
C
7 hrs
Test Coverage

Method validate has 28 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private function validate() {

        if (!$this->Recipient instanceof User) {
            throw new Exception("Cannot validate warning level adjustment - no or invalid recipient provided");
        }
Severity: Minor
Found in lib/Warnings/Warning.php - About 1 hr to fix

    Method commit has 27 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function commit() {
    
            $this->validate();
    
            $data = array(
    Severity: Minor
    Found in lib/Warnings/Warning.php - About 1 hr to fix

      Function validate has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          private function validate() {
      
              if (!$this->Recipient instanceof User) {
                  throw new Exception("Cannot validate warning level adjustment - no or invalid recipient provided");
              }
      Severity: Minor
      Found in lib/Warnings/Warning.php - About 35 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 '128', column '13').
      Open

          public function __construct($id = null) {
      
              parent::__construct();
      
              if (!$id = filter_var($id, FILTER_VALIDATE_INT)) {
      Severity: Minor
      Found in lib/Warnings/Warning.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 '120', column '14').
      Open

          public function __construct($id = null) {
      
              parent::__construct();
      
              if (!$id = filter_var($id, FILTER_VALIDATE_INT)) {
      Severity: Minor
      Found in lib/Warnings/Warning.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 25 locations. Consider refactoring.
      Open

              if (!filter_var($this->level, FILTER_VALIDATE_INT)) {
                  throw new Exception("Cannot validate warning level adjustment - no new warning level provided");
              }
      Severity: Major
      Found in lib/Warnings/Warning.php and 24 other locations - About 1 hr to fix
      lib/Downloads/Download.php on lines 313..315
      lib/Events/Event.php on lines 425..427
      lib/Events/Events.php on lines 130..132
      lib/Images/Competition.php on lines 624..626
      lib/Images/Competition.php on lines 654..656
      lib/Images/Competition.php on lines 823..825
      lib/Images/Competition.php on lines 860..862
      lib/Images/Favourites.php on lines 112..114
      lib/Images/Favourites.php on lines 178..180
      lib/Jobs/Classification.php on lines 80..82
      lib/Locations/Location.php on lines 406..408
      lib/Locations/Location.php on lines 410..412
      lib/Locos/Locomotive.php on lines 622..624
      lib/Locos/Locomotive.php on lines 626..628
      lib/Locos/Locomotive.php on lines 897..899
      lib/News/Article.php on lines 361..363
      lib/News/Article.php on lines 834..836
      lib/Newsletters/Newsletters.php on lines 135..137
      lib/PrivateMessages/Message.php on lines 244..246
      lib/PrivateMessages/Message.php on lines 452..454
      lib/Railcams/Photo.php on lines 330..332
      lib/Railcams/Storage.php on lines 224..226
      lib/Sightings/Sighting.php on lines 133..135
      lib/Users/Group.php on lines 236..238

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

      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

                  throw new Exception(
                      sprintf(
                          "Cannot add warning to this user (ID %d, Username %s). Disallowed by system policy.",
                          $this->Recipient->id, 
                          $this->Recipient->username
      Severity: Minor
      Found in lib/Warnings/Warning.php and 1 other location - About 1 hr to fix
      lib/Images/Competition.php on lines 430..430

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

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

              if (!$this->Date instanceof DateTime) {
                  $this->Date = new DateTime;
              }
      Severity: Major
      Found in lib/Warnings/Warning.php and 13 other locations - About 50 mins to fix
      lib/Content/Page.php on lines 172..174
      lib/Downloads/Download.php on lines 285..287
      lib/Gallery/Image.php on lines 177..179
      lib/Gallery/Image.php on lines 326..328
      lib/Glossary/Entry.php on lines 266..268
      lib/Ideas/Idea.php on lines 252..254
      lib/Images/Collection.php on lines 192..194
      lib/Locations/Correction.php on lines 172..174
      lib/Locos/Correction.php on lines 183..185
      lib/News/Article.php on lines 778..780
      lib/Notifications/Notification.php on lines 187..189
      lib/Railcams/Camera.php on lines 363..365
      lib/Railcams/Footage.php on lines 143..145

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

      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

                  $this->Date = new DateTime("@" . $row['warn_date']);
      Severity: Major
      Found in lib/Warnings/Warning.php and 2 other locations - About 40 mins to fix
      lib/Feedback/FeedbackItem.php on lines 132..132
      lib/Gallery/Image.php on lines 174..174

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

          public function setRecipient(User $userObject) {
      
              $this->Recipient = $userObject;
      
              return $this;
      Severity: Major
      Found in lib/Warnings/Warning.php and 24 other locations - About 40 mins to fix
      lib/Feedback/Feedback.php on lines 52..56
      lib/Gallery/Album.php on lines 279..285
      lib/Gallery/Album.php on lines 317..323
      lib/Gallery/Image.php on lines 278..284
      lib/Gallery/Image.php on lines 460..466
      lib/Glossary/Entry.php on lines 302..306
      lib/Locations/Correction.php on lines 118..124
      lib/News/Article.php on lines 941..945
      lib/Prerender/Prerender.php on lines 89..94
      lib/Railcams/Footage.php on lines 89..95
      lib/Railcams/Photo.php on lines 143..147
      lib/Railcams/Storage.php on lines 95..101
      lib/Railcams/Storage.php on lines 110..116
      lib/SiteMessages/SiteMessage.php on lines 206..210
      lib/Timetables/Timetables.php on lines 52..56
      lib/Timetables/Timetables.php on lines 64..68
      lib/Timetables/Timetables.php on lines 76..80
      lib/Users/SockpuppetManager.php on lines 61..67
      lib/Warnings/Warning.php on lines 267..273
      lib/AppCore.php on lines 401..407
      lib/AppCore.php on lines 416..422
      lib/AppCore.php on lines 431..437
      lib/AppCore.php on lines 463..469
      lib/AppCore.php on lines 478..484

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

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

          public function setIssuer(User $userObject) {
      
              $this->Issuer = $userObject;
      
              return $this;
      Severity: Major
      Found in lib/Warnings/Warning.php and 24 other locations - About 40 mins to fix
      lib/Feedback/Feedback.php on lines 52..56
      lib/Gallery/Album.php on lines 279..285
      lib/Gallery/Album.php on lines 317..323
      lib/Gallery/Image.php on lines 278..284
      lib/Gallery/Image.php on lines 460..466
      lib/Glossary/Entry.php on lines 302..306
      lib/Locations/Correction.php on lines 118..124
      lib/News/Article.php on lines 941..945
      lib/Prerender/Prerender.php on lines 89..94
      lib/Railcams/Footage.php on lines 89..95
      lib/Railcams/Photo.php on lines 143..147
      lib/Railcams/Storage.php on lines 95..101
      lib/Railcams/Storage.php on lines 110..116
      lib/SiteMessages/SiteMessage.php on lines 206..210
      lib/Timetables/Timetables.php on lines 52..56
      lib/Timetables/Timetables.php on lines 64..68
      lib/Timetables/Timetables.php on lines 76..80
      lib/Users/SockpuppetManager.php on lines 61..67
      lib/Warnings/Warning.php on lines 249..255
      lib/AppCore.php on lines 401..407
      lib/AppCore.php on lines 416..422
      lib/AppCore.php on lines 431..437
      lib/AppCore.php on lines 463..469
      lib/AppCore.php on lines 478..484

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

      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

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

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

      There are no issues that match your filters.

      Category
      Status