Sign upLogin

SU-SWS/stanford_publication

View on GitHub
Star
src/Entity/Citation.php

Summary

Maintainability
A
1 hr
Test Coverage
A
97%

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

  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = parent::baseFieldDefinitions($entity_type);

    $fields['title'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Title'))
Severity: Minor
Found in src/Entity/Citation.php - About 1 hr to fix

    Method getBibliography has 30 lines of code (exceeds 25 allowed). Consider refactoring.
    Wontfix

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

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

      Avoid assigning values to variables in if clauses and the like (line '205', column '9').
      Open

        protected function getLinkBeginning() {
    if ($link = $this->getLink()) {
      // This will pull out the `<a href....>` part of the link.
      preg_match('/<a.*?>/', (string) $link->toString(), $matches);
      return $matches[0] ?? NULL;
      Severity: Minor
      Found in src/Entity/Citation.php by phpmd

      IfStatementAssignment

      Since: 2.7.0

      Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($foo = 'bar') { // possible typo
            // ...
        }
        if ($baz = 0) { // always false
            // ...
        }
    }
}

      Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

      Avoid assigning values to variables in if clauses and the like (line '229', column '9').
      Open

        protected function getLink() {
    $url = NULL;

    // Link to the parent node.
    if ($parent_entity = $this->getParentEntity()) {
      Severity: Minor
      Found in src/Entity/Citation.php by phpmd

      IfStatementAssignment

      Since: 2.7.0

      Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($foo = 'bar') { // possible typo
            // ...
        }
        if ($baz = 0) { // always false
            // ...
        }
    }
}

      Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

      Avoid assigning values to variables in if clauses and the like (line '224', column '9').
      Open

        protected function getLink() {
    $url = NULL;

    // Link to the parent node.
    if ($parent_entity = $this->getParentEntity()) {
      Severity: Minor
      Found in src/Entity/Citation.php by phpmd

      IfStatementAssignment

      Since: 2.7.0

      Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($foo = 'bar') { // possible typo
            // ...
        }
        if ($baz = 0) { // always false
            // ...
        }
    }
}

      Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

      Avoid assigning values to variables in if clauses and the like (line '304', column '9').
      Open

        protected function getAuthor() {
    // Authors are rendered using `names` render element in CSL. It expects
    // the name array to be keyed with `given`, `family` etc keys. Luckily the
    // name module does this for us.
    // @link https://docs.citationstyles.org/en/1.0.1/specification.html#names
      Severity: Minor
      Found in src/Entity/Citation.php by phpmd

      IfStatementAssignment

      Since: 2.7.0

      Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($foo = 'bar') { // possible typo
            // ...
        }
        if ($baz = 0) { // always false
            // ...
        }
    }
}

      Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

      Avoid assigning values to variables in if clauses and the like (line '288', column '9').
      Open

        public function __call($name, $args) {
    // Remove the `get` from the beginning.
    $data_name = preg_replace('/^get/', '', $name);

    // Convert UpperCamelCase to snake_case. This allows us to dynamically
      Severity: Minor
      Found in src/Entity/Citation.php by phpmd

      IfStatementAssignment

      Since: 2.7.0

      Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($foo = 'bar') { // possible typo
            // ...
        }
        if ($baz = 0) { // always false
            // ...
        }
    }
}

      Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

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

          return $parent;
      Severity: Minor
      Found in src/Entity/Citation.php by phan

      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 src/Entity/Citation.php and 1 other location - About 55 mins to fix
      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

      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 src/Entity/Citation.php and 1 other location - About 55 mins to fix
      src/Entity/Citation.php on lines 103..107

      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
      Invalid

         * {@inheritDoc}
      Severity: Minor
      Found in src/Entity/Citation.php by phpcodesniffer

      Doc comment short description must end with a full stop
      Invalid

         * {@inheritDoc}
      Severity: Minor
      Found in src/Entity/Citation.php by phpcodesniffer

      Doc comment short description must start with a capital letter
      Invalid

         * {@inheritDoc}
      Severity: Minor
      Found in src/Entity/Citation.php by phpcodesniffer

      Doc comment short description must start with a capital letter
      Invalid

         * {@inheritDoc}
      Severity: Minor
      Found in src/Entity/Citation.php by phpcodesniffer

      There are no issues that match your filters.

      Category
      Status