SU-SWS/stanford_profile_helper

View on GitHub
modules/stanford_publication/src/Entity/Citation.php

Summary

Maintainability
B
5 hrs
Test Coverage
A
91%

Method getBibliography has 44 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  public function getBibliography($style = self::APA): string {

    $data = [
      'id' => $this->id(),
      'title' => $this->label(),
Severity: Minor
Found in modules/stanford_publication/src/Entity/Citation.php - About 1 hr to fix

    Method baseFieldDefinitions has 41 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
        $fields = parent::baseFieldDefinitions($entity_type);
    
        $fields['title'] = BaseFieldDefinition::create('string')
          ->setLabel(t('Title'))
    Severity: Minor
    Found in modules/stanford_publication/src/Entity/Citation.php - About 1 hr to fix

      Returning type \Drupal\Core\TypedData\TranslatableInterface but getParentEntity() is declared to return \Drupal\Core\Entity\ContentEntityInterface|null
      Open

          return $parent;

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

          $fields['parent_type'] = BaseFieldDefinition::create('string')
            ->setLabel(t('Parent type'))
            ->setDescription(t('The entity parent type to which this entity is referenced.'))
            ->setSetting('is_ascii', TRUE)
            ->setSetting('max_length', EntityTypeInterface::ID_MAX_LENGTH);
      Severity: Minor
      Found in modules/stanford_publication/src/Entity/Citation.php and 1 other location - About 55 mins to fix
      modules/stanford_publication/src/Entity/Citation.php on lines 115..119

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

      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

          $fields['parent_field_name'] = BaseFieldDefinition::create('string')
            ->setLabel(t('Parent field name'))
            ->setDescription(t('The entity parent field name to which this entity is referenced.'))
            ->setSetting('is_ascii', TRUE)
            ->setSetting('max_length', FieldStorageConfig::NAME_MAX_LENGTH);
      Severity: Minor
      Found in modules/stanford_publication/src/Entity/Citation.php and 1 other location - About 55 mins to fix
      modules/stanford_publication/src/Entity/Citation.php on lines 109..113

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

      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

      Doc comment short description must end with a full stop
      Open

         * {@inheritDoc}

      Doc comment short description must end with a full stop
      Open

         * {@inheritDoc}

      Doc comment short description must start with a capital letter
      Open

         * {@inheritDoc}

      Doc comment short description must start with a capital letter
      Open

         * {@inheritDoc}

      There are no issues that match your filters.

      Category
      Status