mambax7/publisher

View on GitHub
class/FileHandler.php

Summary

Maintainability
B
5 hrs
Test Coverage

getAllFiles accesses the super-global variable $GLOBALS.
Open

    public function getAllFiles($itemId = 0, $status = -1, $limit = 0, $start = 0, $sort = 'datesub', $order = 'DESC', $category = [])
    {
        $files = [];

        $this->table_link = $this->db->prefix($this->helper->getDirname() . '_items');
Severity: Minor
Found in class/FileHandler.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

getAllFiles accesses the super-global variable $GLOBALS.
Open

    public function getAllFiles($itemId = 0, $status = -1, $limit = 0, $start = 0, $sort = 'datesub', $order = 'DESC', $category = [])
    {
        $files = [];

        $this->table_link = $this->db->prefix($this->helper->getDirname() . '_items');
Severity: Minor
Found in class/FileHandler.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

Function getAllFiles has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

    public function getAllFiles($itemId = 0, $status = -1, $limit = 0, $start = 0, $sort = 'datesub', $order = 'DESC', $category = [])
    {
        $files = [];

        $this->table_link = $this->db->prefix($this->helper->getDirname() . '_items');
Severity: Minor
Found in class/FileHandler.php - About 2 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

Method getAllFiles has 45 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function getAllFiles($itemId = 0, $status = -1, $limit = 0, $start = 0, $sort = 'datesub', $order = 'DESC', $category = [])
    {
        $files = [];

        $this->table_link = $this->db->prefix($this->helper->getDirname() . '_items');
Severity: Minor
Found in class/FileHandler.php - About 1 hr to fix

    Method getAllFiles has 7 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        public function getAllFiles($itemId = 0, $status = -1, $limit = 0, $start = 0, $sort = 'datesub', $order = 'DESC', $category = [])
    Severity: Major
    Found in class/FileHandler.php - About 50 mins to fix

      The method getAllFiles() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10.
      Open

          public function getAllFiles($itemId = 0, $status = -1, $limit = 0, $start = 0, $sort = 'datesub', $order = 'DESC', $category = [])
          {
              $files = [];
      
              $this->table_link = $this->db->prefix($this->helper->getDirname() . '_items');
      Severity: Minor
      Found in class/FileHandler.php by phpmd

      CyclomaticComplexity

      Since: 0.1

      Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

      Example

      // Cyclomatic Complexity = 11
      class Foo {
      1   public function example() {
      2       if ($a == $b) {
      3           if ($a1 == $b1) {
                      fiddle();
      4           } elseif ($a2 == $b2) {
                      fiddle();
                  } else {
                      fiddle();
                  }
      5       } elseif ($c == $d) {
      6           while ($c == $d) {
                      fiddle();
                  }
      7        } elseif ($e == $f) {
      8           for ($n = 0; $n < $h; $n++) {
                      fiddle();
                  }
              } else {
                  switch ($z) {
      9               case 1:
                          fiddle();
                          break;
      10              case 2:
                          fiddle();
                          break;
      11              case 3:
                          fiddle();
                          break;
                      default:
                          fiddle();
                          break;
                  }
              }
          }
      }

      Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

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

          public function delete(\XoopsObject $file, $force = false) //delete(&$file, $force = false)
      Severity: Minor
      Found in class/FileHandler.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

      Missing class import via use statement (line '132', column '46').
      Open

                          $criteriaStatus->add(new \Criteria('o.status', $v), 'OR');
      Severity: Minor
      Found in class/FileHandler.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '144', column '48').
      Open

                          $criteriaCategory->add(new \Criteria('l.categoryid', $cat), 'OR');
      Severity: Minor
      Found in class/FileHandler.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '128', column '39').
      Open

                  $criteriaStatus     = new \CriteriaCompo();
      Severity: Minor
      Found in class/FileHandler.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '136', column '42').
      Open

                      $criteriaStatus->add(new \Criteria('o.status', $status), 'OR');
      Severity: Minor
      Found in class/FileHandler.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '147', column '35').
      Open

                  $criteriaItemid = new \Criteria('o.itemid', $itemId);
      Severity: Minor
      Found in class/FileHandler.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '148', column '35').
      Open

                  $criteria       = new \CriteriaCompo();
      Severity: Minor
      Found in class/FileHandler.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '139', column '40').
      Open

                  $criteriaCategory    = new \CriteriaCompo();
      Severity: Minor
      Found in class/FileHandler.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Avoid using static access to class 'XoopsModules\Publisher\Helper' in method '__construct'.
      Open

              $this->helper = $helper ?? Helper::getInstance();
      Severity: Minor
      Found in class/FileHandler.php by phpmd

      StaticAccess

      Since: 1.4.0

      Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

      Example

      class Foo
      {
          public function bar()
          {
              Bar::baz();
          }
      }

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

      The property $table_link is not named in camelCase.
      Open

      class FileHandler extends \XoopsPersistableObjectHandler
      {
          private const TABLE = 'publisher_files';
          private const ENTITY = File::class;
          private const ENTITYNAME = 'File';
      Severity: Minor
      Found in class/FileHandler.php by phpmd

      CamelCasePropertyName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name attributes.

      Example

      class ClassName {
          protected $property_name;
      }

      Source

      Avoid variables with short names like $db. Configured minimum length is 3.
      Open

          public function __construct(\XoopsDatabase $db = null, Helper $helper = null)
      Severity: Minor
      Found in class/FileHandler.php by phpmd

      ShortVariable

      Since: 0.2

      Detects when a field, local, or parameter has a very short name.

      Example

      class Something {
          private $q = 15; // VIOLATION - Field
          public static function main( array $as ) { // VIOLATION - Formal
              $r = 20 + $this->q; // VIOLATION - Local
              for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                  $r += $this->q;
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#shortvariable

      A file should declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it should execute logic with side effects, but should not do both. The first symbol is defined on line 39 and the first side effect is on line 25.
      Open

      <?php
      Severity: Minor
      Found in class/FileHandler.php by phpcodesniffer

      There are no issues that match your filters.

      Category
      Status