hnhdigital-os/laravel-folder-watcher

View on GitHub

Showing 33 of 33 total issues

Avoid too many return statements within this method.
Open

                return $this->listProcesses();
Severity: Major
Found in src/FolderWatcherCommand.php - About 30 mins to fix

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

        private function runCommand($file_path, $delete = false)
    Severity: Minor
    Found in src/FolderWatcherCommand.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

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

        private function listProcesses()
        {
            $this->cleanProcessList();
            $data = $this->getProcessList();
    
    
    Severity: Minor
    Found in src/FolderWatcherCommand.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

    Avoid unused local variables such as '$hex'.
    Open

            $hex = $event_detail['mask'];
    Severity: Minor
    Found in src/FolderWatcherCommand.php by phpmd

    UnusedLocalVariable

    Since: 0.2

    Detects when a local variable is declared and/or assigned, but not used.

    Example

    class Foo {
        public function doSomething()
        {
            $i = 5; // Unused
        }
    }

    Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable

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

        private function loadFolderWatchers($config_file)
        {
            if (!file_exists($config_file_path = $config_file)) {
                $config_file_path = base_path().'/'.$config_file;
    
    
    Severity: Minor
    Found in src/FolderWatcherCommand.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 using empty try-catch blocks in removeWatchPath.
    Open

                } catch (\Exception $exception) {
                }
    Severity: Minor
    Found in src/FolderWatcherCommand.php by phpmd

    EmptyCatchBlock

    Since: 2.7.0

    Usually empty try-catch is a bad idea because you are silently swallowing an error condition and then continuing execution. Occasionally this may be the right thing to do, but often it's a sign that a developer saw an exception, didn't know what to do about it, and so used an empty catch to silence the problem.

    Example

    class Foo {
    
      public function bar()
      {
          try {
              // ...
          } catch (Exception $e) {} // empty catch block
      }
    }

    Source https://phpmd.org/rules/design.html#emptycatchblock

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

        private function loadFolderWatchers($config_file)
        {
            if (!file_exists($config_file_path = $config_file)) {
                $config_file_path = base_path().'/'.$config_file;
    
    
    Severity: Minor
    Found in src/FolderWatcherCommand.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

    getUserHome accesses the super-global variable $_SERVER.
    Open

        private function getUserHome()
        {
            // Linux home directory
            $home = getenv('HOME');
    
    
    Severity: Minor
    Found in src/FolderWatcherCommand.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

    getUserHome accesses the super-global variable $_SERVER.
    Open

        private function getUserHome()
        {
            // Linux home directory
            $home = getenv('HOME');
    
    
    Severity: Minor
    Found in src/FolderWatcherCommand.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

    getWorkingDirectory accesses the super-global variable $_SERVER.
    Open

        private function getWorkingDirectory($file_name)
        {
            $path = env('XDG_RUNTIME_DIR') ? env('XDG_RUNTIME_DIR') : $this->getUserHome();
            $path = empty($path) ? $_SERVER['TMPDIR'] : $path;
            $path .= '/'.$file_name;
    Severity: Minor
    Found in src/FolderWatcherCommand.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

    getUserHome accesses the super-global variable $_SERVER.
    Open

        private function getUserHome()
        {
            // Linux home directory
            $home = getenv('HOME');
    
    
    Severity: Minor
    Found in src/FolderWatcherCommand.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

    Avoid using Bluora\LaravelFolderWatcher\count() function in while loops.
    Open

            while (count($this->track_watches)) {
                // Check the inotify instance for any change events.
                $events = inotify_read($this->watcher);
    
                // One or many events occured.
    Severity: Minor
    Found in src/FolderWatcherCommand.php by phpmd

    CountInLoopExpression

    Since: 2.7.0

    Using count/sizeof in loops expressions is considered bad practice and is a potential source of many bugs, especially when the loop manipulates an array, as count happens on each iteration.

    Example

    class Foo {
    
      public function bar()
      {
        $array = array();
    
        for ($i = 0; count($array); $i++) {
          // ...
        }
      }
    }

    Source https://phpmd.org/rules/design.html#countinloopexpression

    getUserHome accesses the super-global variable $_SERVER.
    Open

        private function getUserHome()
        {
            // Linux home directory
            $home = getenv('HOME');
    
    
    Severity: Minor
    Found in src/FolderWatcherCommand.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

    Severity
    Category
    Status
    Source
    Language