veksa/carrot-api

View on GitHub
src/Api.php

Summary

Maintainability
F
5 days
Test Coverage
F
0%

File Api.php has 593 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php
namespace Veksa\Carrot;

use Veksa\Carrot\Exceptions\Exception;
use Veksa\Carrot\Exceptions\HttpException;
Severity: Major
Found in src/Api.php - About 1 day to fix

    Api has 31 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class Api
    {
        /**
         * HTTP codes
         *
    Severity: Minor
    Found in src/Api.php - About 3 hrs to fix

      Method sendConversationMessage has 39 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function sendConversationMessage(
              $id,
              $message,
              $type = 'note',
              $botName = 'Bot',
      Severity: Minor
      Found in src/Api.php - About 1 hr to fix

        Function getConversations has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
        Open

            public function getConversations(
                $userId = null,
                $limit = 20,
                $offset = 0,
                $closed = null,
        Severity: Minor
        Found in src/Api.php - About 1 hr 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 sendConversationMessage has 9 arguments (exceeds 4 allowed). Consider refactoring.
        Open

                $id,
                $message,
                $type = 'note',
                $botName = 'Bot',
                $fromUser = false,
        Severity: Major
        Found in src/Api.php - About 1 hr to fix

          Function sendConversationMessage has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
          Open

              public function sendConversationMessage(
                  $id,
                  $message,
                  $type = 'note',
                  $botName = 'Bot',
          Severity: Minor
          Found in src/Api.php - About 1 hr 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 deleteTag has 26 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public function deleteTag($id, $tag, $fromAdminId = null, $botName = 'Bot', $randomId = 0)
              {
                  if ($this->isEmptyId($id)) {
                      throw new InvalidArgumentException;
                  }
          Severity: Minor
          Found in src/Api.php - About 1 hr to fix

            Method addTag has 26 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                public function addTag($id, $tag, $fromAdminId = null, $botName = 'Bot', $randomId = 0)
                {
                    if ($this->isEmptyId($id)) {
                        throw new InvalidArgumentException;
                    }
            Severity: Minor
            Found in src/Api.php - About 1 hr to fix

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

                      $userId = null,
                      $limit = 20,
                      $offset = 0,
                      $closed = null,
                      $assigned = null,
              Severity: Minor
              Found in src/Api.php - About 45 mins to fix

                Method setTyping has 5 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                    public function setTyping($id, $message, $botName = null, $fromUser = false, $fromAdmin = 0)
                Severity: Minor
                Found in src/Api.php - About 35 mins to fix

                  Method assignConversation has 5 arguments (exceeds 4 allowed). Consider refactoring.
                  Open

                      public function assignConversation($id, $adminId, $fromAdminId = null, $botName = 'Bot', $randomId = 0)
                  Severity: Minor
                  Found in src/Api.php - About 35 mins to fix

                    Method deleteTag has 5 arguments (exceeds 4 allowed). Consider refactoring.
                    Open

                        public function deleteTag($id, $tag, $fromAdminId = null, $botName = 'Bot', $randomId = 0)
                    Severity: Minor
                    Found in src/Api.php - About 35 mins to fix

                      Method getLeads has 5 arguments (exceeds 4 allowed). Consider refactoring.
                      Open

                          public function getLeads($filters = [], $prop = '$last_seen', $order = 'desc', $limit = 20, $offset = 0)
                      Severity: Minor
                      Found in src/Api.php - About 35 mins to fix

                        Method addTag has 5 arguments (exceeds 4 allowed). Consider refactoring.
                        Open

                            public function addTag($id, $tag, $fromAdminId = null, $botName = 'Bot', $randomId = 0)
                        Severity: Minor
                        Found in src/Api.php - About 35 mins to fix

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

                              public function setProps($id, $props, $isSystem = true)
                              {
                                  if ($this->isEmptyString($id)) {
                                      throw new InvalidArgumentException;
                                  }
                          Severity: Minor
                          Found in src/Api.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

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

                              public function deleteTag($id, $tag, $fromAdminId = null, $botName = 'Bot', $randomId = 0)
                              {
                                  if ($this->isEmptyId($id)) {
                                      throw new InvalidArgumentException;
                                  }
                          Severity: Minor
                          Found in src/Api.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

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

                              public function assignConversation($id, $adminId, $fromAdminId = null, $botName = 'Bot', $randomId = 0)
                              {
                                  if ($this->isEmptyId($id)) {
                                      throw new InvalidArgumentException;
                                  }
                          Severity: Minor
                          Found in src/Api.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

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

                              public function addTag($id, $tag, $fromAdminId = null, $botName = 'Bot', $randomId = 0)
                              {
                                  if ($this->isEmptyId($id)) {
                                      throw new InvalidArgumentException;
                                  }
                          Severity: Minor
                          Found in src/Api.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

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

                              public function deleteProps($id, $props, $isSystem = true)
                              {
                                  if ($this->isEmptyString($id)) {
                                      throw new InvalidArgumentException;
                                  }
                          Severity: Minor
                          Found in src/Api.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

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

                              public function addTag($id, $tag, $fromAdminId = null, $botName = 'Bot', $randomId = 0)
                              {
                                  if ($this->isEmptyId($id)) {
                                      throw new InvalidArgumentException;
                                  }
                          Severity: Major
                          Found in src/Api.php and 1 other location - About 5 hrs to fix
                          src/Api.php on lines 754..790

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

                          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 deleteTag($id, $tag, $fromAdminId = null, $botName = 'Bot', $randomId = 0)
                              {
                                  if ($this->isEmptyId($id)) {
                                      throw new InvalidArgumentException;
                                  }
                          Severity: Major
                          Found in src/Api.php and 1 other location - About 5 hrs to fix
                          src/Api.php on lines 701..737

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

                          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 deleteProps($id, $props, $isSystem = true)
                              {
                                  if ($this->isEmptyString($id)) {
                                      throw new InvalidArgumentException;
                                  }
                          Severity: Major
                          Found in src/Api.php and 1 other location - About 4 hrs to fix
                          src/Api.php on lines 878..904

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

                          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 setProps($id, $props, $isSystem = true)
                              {
                                  if ($this->isEmptyString($id)) {
                                      throw new InvalidArgumentException;
                                  }
                          Severity: Major
                          Found in src/Api.php and 1 other location - About 4 hrs to fix
                          src/Api.php on lines 917..943

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

                          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