wikimedia/mediawiki-core

View on GitHub
includes/api/ApiParse.php

Summary

Maintainability
F
1 wk
Test Coverage

Function execute has a Cognitive Complexity of 173 (exceeds 5 allowed). Consider refactoring.
Open

    public function execute() {
        // The data is hot but user-dependent, like page views, so we set vary cookies
        $this->getMain()->setCacheMode( 'anon-public-user-private' );

        // Get parameters
Severity: Minor
Found in includes/api/ApiParse.php - About 3 days 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

File ApiParse.php has 901 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php
/**
 * Copyright © 2007 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
 *
 * This program is free software; you can redistribute it and/or modify
Severity: Major
Found in includes/api/ApiParse.php - About 2 days to fix

    Method execute has 432 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function execute() {
            // The data is hot but user-dependent, like page views, so we set vary cookies
            $this->getMain()->setCacheMode( 'anon-public-user-private' );
    
            // Get parameters
    Severity: Major
    Found in includes/api/ApiParse.php - About 2 days to fix

      Method getAllowedParams has 97 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function getAllowedParams() {
              return [
                  'title' => null,
                  'text' => [
                      ParamValidator::PARAM_TYPE => 'text',
      Severity: Major
      Found in includes/api/ApiParse.php - About 3 hrs to fix

        Function getParsedContent has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
        Open

            private function getParsedContent(
                WikiPage $page, $popts, $suppressCache, $pageId, $rev, $getContent
            ) {
                $revId = $rev ? $rev->getId() : null;
                $isDeleted = $rev && $rev->isDeleted( RevisionRecord::DELETED_TEXT );
        Severity: Minor
        Found in includes/api/ApiParse.php - About 2 hrs 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

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

        class ApiParse extends ApiBase {
        
            /** @var string|false|null */
            private $section = null;
        
        
        Severity: Minor
        Found in includes/api/ApiParse.php - About 2 hrs to fix

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

                  ApiMain $main,
                  $action,
                  RevisionLookup $revisionLookup,
                  SkinFactory $skinFactory,
                  LanguageNameUtils $languageNameUtils,
          Severity: Major
          Found in includes/api/ApiParse.php - About 2 hrs to fix

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

                private function getParsedContent(
                    WikiPage $page, $popts, $suppressCache, $pageId, $rev, $getContent
                ) {
                    $revId = $rev ? $rev->getId() : null;
                    $isDeleted = $rev && $rev->isDeleted( RevisionRecord::DELETED_TEXT );
            Severity: Minor
            Found in includes/api/ApiParse.php - About 1 hr to fix

              Method formatCategoryLinks has 35 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  private function formatCategoryLinks( $links ) {
                      $result = [];
              
                      if ( !$links ) {
                          return $result;
              Severity: Minor
              Found in includes/api/ApiParse.php - About 1 hr to fix

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

                    private function formatCategoryLinks( $links ) {
                        $result = [];
                
                        if ( !$links ) {
                            return $result;
                Severity: Minor
                Found in includes/api/ApiParse.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

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

                        WikiPage $page, $popts, $suppressCache, $pageId, $rev, $getContent
                Severity: Minor
                Found in includes/api/ApiParse.php - About 45 mins to fix

                  Function formatSummary has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                  Open

                      private function formatSummary( $title, $params ) {
                          $summary = $params['summary'] ?? '';
                          $sectionTitle = $params['sectiontitle'] ?? '';
                  
                          if ( $this->section === 'new' && ( $sectionTitle === '' || $summary === '' ) ) {
                  Severity: Minor
                  Found in includes/api/ApiParse.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 formatIWLinks has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                  Open

                      private function formatIWLinks( $iw ) {
                          $result = [];
                          foreach ( $iw as $prefix => $titles ) {
                              foreach ( $titles as $title => $_ ) {
                                  $entry = [];
                  Severity: Minor
                  Found in includes/api/ApiParse.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

                      public function __construct(
                          ApiMain $main,
                          $action,
                          RevisionLookup $revisionLookup,
                          SkinFactory $skinFactory,
                  Severity: Major
                  Found in includes/api/ApiParse.php and 2 other locations - About 1 hr to fix
                  includes/api/ApiQueryInfo.php on lines 157..191
                  includes/api/ApiQuerySiteinfo.php on lines 90..125

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

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

                          $result_mapping = [
                              'redirects' => 'r',
                              'langlinks' => 'll',
                              'categories' => 'cl',
                              'links' => 'pl',
                  Severity: Major
                  Found in includes/api/ApiParse.php and 4 other locations - About 55 mins to fix
                  languages/messages/MessagesAcm.php on lines 31..55
                  languages/messages/MessagesApc.php on lines 69..93
                  languages/messages/MessagesAr.php on lines 58..82
                  languages/messages/MessagesFa.php on lines 404..429

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

                  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