phplib/REST/Alerts.php

Summary

Maintainability
D
2 days
Test Coverage

Function setAlertFields has a Cognitive Complexity of 27 (exceeds 5 allowed). Consider refactoring.
Open

    private function setAlertFields($data, $fields, $alog_action, $slog_action, $a=0, $b=0) {
        if(!$this->allowUpdate()) {
            throw new ForbiddenException;
        }

Severity: Minor
Found in phplib/REST/Alerts.php - About 3 hrs 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

File Alerts.php has 299 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace FOO;

/**
Severity: Minor
Found in phplib/REST/Alerts.php - About 3 hrs to fix

    Alerts_REST has 24 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class Alerts_REST extends Models_REST {
        const SLOG_TYPE = SLog::T_ALERT;
    
        public static $MODEL = 'Alert';
        public static $CREATABLE = [];
    Severity: Minor
    Found in phplib/REST/Alerts.php - About 2 hrs to fix

      Method setAlertFields has 57 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function setAlertFields($data, $fields, $alog_action, $slog_action, $a=0, $b=0) {
              if(!$this->allowUpdate()) {
                  throw new ForbiddenException;
              }
      
      
      Severity: Major
      Found in phplib/REST/Alerts.php - About 2 hrs to fix

        Method whitelistAlerts has 29 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function whitelistAlerts($data) {
                if(!$this->allowUpdate()) {
                    throw new ForbiddenException;
                }
        
        
        Severity: Minor
        Found in phplib/REST/Alerts.php - About 1 hr to fix

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

              public function sendAlerts($data) {
                  if(!$this->allowUpdate()) {
                      throw new ForbiddenException;
                  }
          
          
          Severity: Minor
          Found in phplib/REST/Alerts.php - About 1 hr to fix

            Method setAlertFields has 6 arguments (exceeds 4 allowed). Consider refactoring.
            Open

                private function setAlertFields($data, $fields, $alog_action, $slog_action, $a=0, $b=0) {
            Severity: Minor
            Found in phplib/REST/Alerts.php - About 45 mins to fix

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

                  public function whitelistAlerts($data) {
                      if(!$this->allowUpdate()) {
                          throw new ForbiddenException;
                      }
              
              
              Severity: Minor
              Found in phplib/REST/Alerts.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

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

                  public function sendAlerts($data) {
                      if(!$this->allowUpdate()) {
                          throw new ForbiddenException;
                      }
              
              
              Severity: Minor
              Found in phplib/REST/Alerts.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 too many return statements within this method.
              Open

                              return self::format($this->read($get));
              Severity: Major
              Found in phplib/REST/Alerts.php - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                                return self::format($this->update($get, $data));
                Severity: Major
                Found in phplib/REST/Alerts.php - About 30 mins to fix

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

                      public function bootstrapAlerts($get) {
                          if(!$this->allowRead()) {
                              throw new ForbiddenException;
                          }
                  
                  
                  Severity: Minor
                  Found in phplib/REST/Alerts.php and 1 other location - About 45 mins to fix
                  phplib/REST/Alerts.php on lines 120..130

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

                  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 getIds($get) {
                          if(!$this->allowRead()) {
                              throw new ForbiddenException;
                          }
                  
                  
                  Severity: Minor
                  Found in phplib/REST/Alerts.php and 1 other location - About 45 mins to fix
                  phplib/REST/Alerts.php on lines 132..142

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

                  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

                  There are no issues that match your filters.

                  Category
                  Status