TikiWiki/tiki-manager

View on GitHub
src/Command/SetupWatchManagerCommand.php

Summary

Maintainability
C
7 hrs
Test Coverage

execute accesses the super-global variable $_ENV.
Open

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $email = $input->getOption('email');

        if (empty($email) || ! filter_var($email, FILTER_VALIDATE_EMAIL)) {

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

execute accesses the super-global variable $_ENV.
Open

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $email = $input->getOption('email');

        if (empty($email) || ! filter_var($email, FILTER_VALIDATE_EMAIL)) {

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

Method interact has 36 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function interact(InputInterface $input, OutputInterface $output)
    {
        $helper = $this->getHelper('question');
        $email = $input->getOption('email');
        if (empty($email) || ! filter_var($email, FILTER_VALIDATE_EMAIL)) {
Severity: Minor
Found in src/Command/SetupWatchManagerCommand.php - About 1 hr to fix

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

        protected function execute(InputInterface $input, OutputInterface $output)
        {
            $email = $input->getOption('email');
    
            if (empty($email) || ! filter_var($email, FILTER_VALIDATE_EMAIL)) {
    Severity: Minor
    Found in src/Command/SetupWatchManagerCommand.php - About 1 hr to fix

      Missing class import via use statement (line '55', column '31').
      Open

                          throw new \RuntimeException('Please insert a valid email address.');

      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 '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
      Open

              $instancesInfo = CommandHelper::getInstancesInfo($instances);

      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

      Avoid using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
      Open

                          $selectedInstances = CommandHelper::validateInstanceSelection($answer, $instances);

      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

      Avoid using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
      Open

              $instances = CommandHelper::getInstances('all', true);

      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

      Avoid using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'execute'.
      Open

              list($hours, $minutes) = CommandHelper::validateTimeInput($time);

      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

      Avoid using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
      Open

                          $excludeInstance = implode(',', CommandHelper::getInstanceIds($selectedInstances));

      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

      Avoid using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
      Open

                  $question = CommandHelper::getQuestion('Email address to contact');

      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

      Avoid using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
      Open

                      return CommandHelper::validateTimeInput($answer);

      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

      Avoid using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
      Open

                  CommandHelper::renderInstancesTable($output, $instancesInfo);

      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

      Possibly zero references to use statement for classlike/namespace App (\TikiManager\Config\App)
      Open

      use TikiManager\Config\App;

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

              if (isset($instancesInfo) && empty($input->getOption('exclude'))) {
                  CommandHelper::renderInstancesTable($output, $instancesInfo);
                  $this->io->newLine();
                  $this->io->writeln('<comment>In case you want to ignore more than one instance, please use a comma (,) between the values</comment>');
      
      
      Severity: Major
      Found in src/Command/SetupWatchManagerCommand.php and 2 other locations - About 3 hrs to fix
      src/Command/SetupBackupManagerCommand.php on lines 67..84
      src/Command/WatchInstanceCommand.php on lines 62..77

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

      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 (empty($email) || ! filter_var($email, FILTER_VALIDATE_EMAIL)) {
                  $question = CommandHelper::getQuestion('Email address to contact');
                  $question->setValidator(function ($value) {
                      if (! filter_var($value, FILTER_VALIDATE_EMAIL)) {
                          throw new \RuntimeException('Please insert a valid email address.');
      Severity: Major
      Found in src/Command/SetupWatchManagerCommand.php and 1 other location - About 1 hr to fix
      src/Command/WatchInstanceCommand.php on lines 48..57

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

      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