educach/dsb-client

View on GitHub
src/Educa/DSB/Client/ApiClient/ClientV2.php

Summary

Maintainability
F
4 days
Test Coverage

File ClientV2.php has 493 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

/**
 * @file
 * Contains \Educa\DSB\Client\ApiClient\ClientV2.
Severity: Minor
Found in src/Educa/DSB/Client/ApiClient/ClientV2.php - About 7 hrs to fix

    ClientV2 has 21 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class ClientV2 extends AbstractClient
    {
    
        protected $tokenExpiresOn;
    
    
    Severity: Minor
    Found in src/Educa/DSB/Client/ApiClient/ClientV2.php - About 2 hrs to fix

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

          public function authenticate()
          {
              if (!file_exists($this->privateKeyPath)) {
                  throw new ClientAuthenticationException("Private key could not be loaded. Is the path correct ?");
              }
      Severity: Minor
      Found in src/Educa/DSB/Client/ApiClient/ClientV2.php - About 1 hr to fix

        Method postDescription has 43 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function postDescription($json, $catalogs = array(), $previewImage = false)
            {
                if (empty($this->tokenKey)) {
                    throw new ClientAuthenticationException("No token found. Cannot create a LOM description without a token.");
                }
        Severity: Minor
        Found in src/Educa/DSB/Client/ApiClient/ClientV2.php - About 1 hr to fix

          Function postDescription has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
          Open

              public function postDescription($json, $catalogs = array(), $previewImage = false)
              {
                  if (empty($this->tokenKey)) {
                      throw new ClientAuthenticationException("No token found. Cannot create a LOM description without a token.");
                  }
          Severity: Minor
          Found in src/Educa/DSB/Client/ApiClient/ClientV2.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 getPartner has 33 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public function getPartner($partner = null)
              {
                  if (empty($this->tokenKey)) {
                      throw new ClientAuthenticationException("No token found. Cannot load a partner without a token.");
                  }
          Severity: Minor
          Found in src/Educa/DSB/Client/ApiClient/ClientV2.php - About 1 hr to fix

            Method getPartnerStatistics has 32 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                public function getPartnerStatistics(
                    $partnerId,
                    $from,
                    $to,
                    $aggregationMethod = 'day',
            Severity: Minor
            Found in src/Educa/DSB/Client/ApiClient/ClientV2.php - About 1 hr to fix

              Method search has 30 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  public function search(
                      $query = '',
                      array $useFacets = [],
                      array $filters = [],
                      array $additionalFields = [],
              Severity: Minor
              Found in src/Educa/DSB/Client/ApiClient/ClientV2.php - About 1 hr to fix

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

                    public function putDescription($id, $json, $catalogs = array())
                    {
                        if (empty($this->tokenKey)) {
                            throw new ClientAuthenticationException("No token found. Cannot update a LOM description without a token.");
                        }
                Severity: Minor
                Found in src/Educa/DSB/Client/ApiClient/ClientV2.php - About 1 hr to fix

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

                      public function authenticate()
                      {
                          if (!file_exists($this->privateKeyPath)) {
                              throw new ClientAuthenticationException("Private key could not be loaded. Is the path correct ?");
                          }
                  Severity: Minor
                  Found in src/Educa/DSB/Client/ApiClient/ClientV2.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 getPartnerStatistics has 7 arguments (exceeds 4 allowed). Consider refactoring.
                  Open

                          $partnerId,
                          $from,
                          $to,
                          $aggregationMethod = 'day',
                          $lomId = null,
                  Severity: Major
                  Found in src/Educa/DSB/Client/ApiClient/ClientV2.php - About 50 mins to fix

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

                            $query = '',
                            array $useFacets = [],
                            array $filters = [],
                            array $additionalFields = [],
                            $offset = 0,
                    Severity: Major
                    Found in src/Educa/DSB/Client/ApiClient/ClientV2.php - About 50 mins to fix

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

                              $partnerId,
                              $from,
                              $to,
                              $aggregationMethod = 'day',
                              $lomId = null,
                      Severity: Major
                      Found in src/Educa/DSB/Client/ApiClient/ClientV2.php - About 50 mins to fix

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

                            public function putDescription($id, $json, $catalogs = array())
                            {
                                if (empty($this->tokenKey)) {
                                    throw new ClientAuthenticationException("No token found. Cannot update a LOM description without a token.");
                                }
                        Severity: Minor
                        Found in src/Educa/DSB/Client/ApiClient/ClientV2.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 getPartnerStatistics has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                        Open

                            public function getPartnerStatistics(
                                $partnerId,
                                $from,
                                $to,
                                $aggregationMethod = 'day',
                        Severity: Minor
                        Found in src/Educa/DSB/Client/ApiClient/ClientV2.php - About 35 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 getPartner has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                        Open

                            public function getPartner($partner = null)
                            {
                                if (empty($this->tokenKey)) {
                                    throw new ClientAuthenticationException("No token found. Cannot load a partner without a token.");
                                }
                        Severity: Minor
                        Found in src/Educa/DSB/Client/ApiClient/ClientV2.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 3 locations. Consider refactoring.
                        Open

                                try {
                                    $response = $this->get('/suggest', $options);
                                    if ($response->getStatusCode() == 200) {
                                        return json_decode($response->getBody(), true);
                                    } else {
                        Severity: Major
                        Found in src/Educa/DSB/Client/ApiClient/ClientV2.php and 2 other locations - About 2 hrs to fix
                        src/Educa/DSB/Client/ApiClient/ClientV2.php on lines 112..129
                        src/Educa/DSB/Client/ApiClient/ClientV2.php on lines 403..420

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

                        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 3 locations. Consider refactoring.
                        Open

                                try {
                                    $response = $this->get('/search', $options);
                                    if ($response->getStatusCode() == 200) {
                                        return json_decode($response->getBody(), true);
                                    } else {
                        Severity: Major
                        Found in src/Educa/DSB/Client/ApiClient/ClientV2.php and 2 other locations - About 2 hrs to fix
                        src/Educa/DSB/Client/ApiClient/ClientV2.php on lines 148..165
                        src/Educa/DSB/Client/ApiClient/ClientV2.php on lines 403..420

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

                        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 3 locations. Consider refactoring.
                        Open

                                try {
                                    $response = $this->post('/description', $params);
                                    if ($response->getStatusCode() == 200) {
                                        return json_decode($response->getBody(), true);
                                    } else {
                        Severity: Major
                        Found in src/Educa/DSB/Client/ApiClient/ClientV2.php and 2 other locations - About 2 hrs to fix
                        src/Educa/DSB/Client/ApiClient/ClientV2.php on lines 112..129
                        src/Educa/DSB/Client/ApiClient/ClientV2.php on lines 148..165

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

                        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