Sign upLogin

EscolaLMS/H5P

View on GitHub
Star
src/Services/HeadlessH5PService.php

Summary

Maintainability
F
4 days
Test Coverage
B
87%

File HeadlessH5PService.php has 601 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace EscolaLms\HeadlessH5P\Services;

use EscolaLms\HeadlessH5P\Exceptions\H5PException;
Severity: Major
Found in src/Services/HeadlessH5PService.php - About 1 day to fix

    HeadlessH5PService has 34 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class HeadlessH5PService implements HeadlessH5PServiceContract
{
    private H5PFrameworkInterface $repository;
    private H5PFileStorage $fileStorage;
    private H5PCore $core;
    Severity: Minor
    Found in src/Services/HeadlessH5PService.php - About 4 hrs to fix

      Method getEditorSettings has 100 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function getEditorSettings($content = null): array
    {
        $lang = config('hh5p.language');

        $config = $this->getConfig();
      Severity: Major
      Found in src/Services/HeadlessH5PService.php - About 4 hrs to fix

        Method getContentSettings has 88 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function getContentSettings($id, ?string $token = null): array
    {
        $lang = config('hh5p.language');

        // READ this https://h5p.org/creating-your-own-h5p-plugin
        Severity: Major
        Found in src/Services/HeadlessH5PService.php - About 3 hrs to fix

          Function addMoreHtmlTags has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
          Open

              private function addMoreHtmlTags($semantics) {
        foreach ($semantics as $field) {
            while ($field->type === 'list') {
                $field = $field->field;
            }
          Severity: Minor
          Found in src/Services/HeadlessH5PService.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

          Function reinstallLibraryDependencies has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
          Open

              public function reinstallLibraryDependencies(string $machineName): void
    {
        if (!$this->editor->ajaxInterface->getContentTypeCache($machineName) ||
            !$this->callHubEndpoint(H5PHubEndpoints::CONTENT_TYPES . $machineName) ||
            !$this->core->librariesJsonData
          Severity: Minor
          Found in src/Services/HeadlessH5PService.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 getSettingsForContent has 30 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public function getSettingsForContent($id): array
    {
        $content = $this->getCore()->loadContent($id);
        $content['metadata']['title'] = $content['title'];
          Severity: Minor
          Found in src/Services/HeadlessH5PService.php - About 1 hr to fix

            Method __construct has 9 arguments (exceeds 4 allowed). Consider refactoring.
            Open

                    H5PFrameworkInterface  $repository,
        H5PFileStorage         $fileStorage,
        H5PCore                $core,
        H5PValidator           $validator,
        H5PStorage             $storage,
            Severity: Major
            Found in src/Services/HeadlessH5PService.php - About 1 hr to fix

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

                  public function getLibraries(string $machineName = null, string $major_version = null, string $minor_version = null, int $library_id = null)
    {
        $lang = config('hh5p.language');
        $libraries_url = Storage::url(config('hh5p.h5p_library_url'));
              Severity: Minor
              Found in src/Services/HeadlessH5PService.php - About 1 hr to fix

                Function getEditorSettings has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
                Open

                    public function getEditorSettings($content = null): array
    {
        $lang = config('hh5p.language');

        $config = $this->getConfig();
                Severity: Minor
                Found in src/Services/HeadlessH5PService.php - About 55 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 libraryInstall has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                    public function libraryInstall($machineName)
    {
        // Determine which content type to install from post data
        if (!$machineName) {
            throw new H5PException(H5PException::NO_CONTENT_TYPE);
                Severity: Minor
                Found in src/Services/HeadlessH5PService.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 getContentSettings has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                    public function getContentSettings($id, ?string $token = null): array
    {
        $lang = config('hh5p.language');

        // READ this https://h5p.org/creating-your-own-h5p-plugin
                Severity: Minor
                Found in src/Services/HeadlessH5PService.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 getLibraries has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                    public function getLibraries(string $machineName = null, string $major_version = null, string $minor_version = null, int $library_id = null)
    {
        $lang = config('hh5p.language');
        $libraries_url = Storage::url(config('hh5p.h5p_library_url'));
                Severity: Minor
                Found in src/Services/HeadlessH5PService.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

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

                        $settings = [
            'baseUrl' => $config['domain'],
            'url' => $config['url'],
            'postUserStatistics' => config('hh5p.h5p_track_user'),
            'ajax' => [
                Severity: Major
                Found in src/Services/HeadlessH5PService.php and 1 other location - About 1 hr to fix
                src/Services/HeadlessH5PService.php on lines 246..261

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

                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

                        $settings = [
            'baseUrl' => $config['domain'],
            'url' => $config['url'],
            'postUserStatistics' => config('hh5p.h5p_track_user'),
            'ajax' => [
                Severity: Major
                Found in src/Services/HeadlessH5PService.php and 1 other location - About 1 hr to fix
                src/Services/HeadlessH5PService.php on lines 417..433

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

                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