wikimedia/mediawiki-core

View on GitHub
includes/api/ApiQueryInfo.php

Summary

Maintainability
F
1 wk
Test Coverage

File ApiQueryInfo.php has 816 lines of code (exceeds 250 allowed). Consider refactoring.
Open

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

    Function extractPageInfo has a Cognitive Complexity of 70 (exceeds 5 allowed). Consider refactoring.
    Open

        private function extractPageInfo( $pageid, $page ) {
            $title = $this->titleFactory->newFromPageIdentity( $page );
            $pageInfo = [];
            // $page->exists() needs pageid, which is not set for all title objects
            $pageExists = $pageid > 0;
    Severity: Minor
    Found in includes/api/ApiQueryInfo.php - About 1 day 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 extractPageInfo has 201 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function extractPageInfo( $pageid, $page ) {
            $title = $this->titleFactory->newFromPageIdentity( $page );
            $pageInfo = [];
            // $page->exists() needs pageid, which is not set for all title objects
            $pageExists = $pageid > 0;
    Severity: Major
    Found in includes/api/ApiQueryInfo.php - About 1 day to fix

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

          public function execute() {
              $this->params = $this->extractRequestParams();
              if ( $this->params['prop'] !== null ) {
                  $prop = array_fill_keys( $this->params['prop'], true );
                  $this->fld_protection = isset( $prop['protection'] );
      Severity: Minor
      Found in includes/api/ApiQueryInfo.php - About 3 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

      Method getProtectionInfo has 91 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function getProtectionInfo() {
              $this->protections = [];
              $db = $this->getDB();
      
              // Get normal protections for existing titles
      Severity: Major
      Found in includes/api/ApiQueryInfo.php - About 3 hrs to fix

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

            public function execute() {
                $this->params = $this->extractRequestParams();
                if ( $this->params['prop'] !== null ) {
                    $prop = array_fill_keys( $this->params['prop'], true );
                    $this->fld_protection = isset( $prop['protection'] );
        Severity: Major
        Found in includes/api/ApiQueryInfo.php - About 3 hrs to fix

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

              public function getAllowedParams() {
                  return [
                      'prop' => [
                          ParamValidator::PARAM_ISMULTI => true,
                          ParamValidator::PARAM_TYPE => [
          Severity: Major
          Found in includes/api/ApiQueryInfo.php - About 2 hrs to fix

            Function getProtectionInfo has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
            Open

                private function getProtectionInfo() {
                    $this->protections = [];
                    $db = $this->getDB();
            
                    // Get normal protections for existing titles
            Severity: Minor
            Found in includes/api/ApiQueryInfo.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

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

                    ApiQuery $queryModule,
                    $moduleName,
                    Language $contentLanguage,
                    LinkBatchFactory $linkBatchFactory,
                    NamespaceInfo $namespaceInfo,
            Severity: Major
            Found in includes/api/ApiQueryInfo.php - About 2 hrs to fix

              Method getVisitingWatcherInfo has 50 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  private function getVisitingWatcherInfo() {
                      $config = $this->getConfig();
                      $db = $this->getDB();
              
                      $canUnwatchedpages = $this->getAuthority()->isAllowed( 'unwatchedpages' );
              Severity: Minor
              Found in includes/api/ApiQueryInfo.php - About 2 hrs to fix

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

                    private function getTSIDs() {
                        $getTitles = $this->talkids = $this->subjectids = [];
                        $nsInfo = $this->namespaceInfo;
                
                        /** @var PageReference $page */
                Severity: Minor
                Found in includes/api/ApiQueryInfo.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 getTSIDs has 30 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                    private function getTSIDs() {
                        $getTitles = $this->talkids = $this->subjectids = [];
                        $nsInfo = $this->namespaceInfo;
                
                        /** @var PageReference $page */
                Severity: Minor
                Found in includes/api/ApiQueryInfo.php - About 1 hr to fix

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

                      private function getWatchedInfo() {
                          $user = $this->getUser();
                  
                          if ( !$user->isRegistered() || count( $this->everything ) == 0
                              || !$this->getAuthority()->isAllowed( 'viewmywatchlist' )
                  Severity: Minor
                  Found in includes/api/ApiQueryInfo.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 getVisitingWatcherInfo has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                  Open

                      private function getVisitingWatcherInfo() {
                          $config = $this->getConfig();
                          $db = $this->getDB();
                  
                          $canUnwatchedpages = $this->getAuthority()->isAllowed( 'unwatchedpages' );
                  Severity: Minor
                  Found in includes/api/ApiQueryInfo.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(
                          ApiQuery $queryModule,
                          $moduleName,
                          Language $contentLanguage,
                          LinkBatchFactory $linkBatchFactory,
                  Severity: Major
                  Found in includes/api/ApiQueryInfo.php and 2 other locations - About 1 hr to fix
                  includes/api/ApiParse.php on lines 104..139
                  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

                  There are no issues that match your filters.

                  Category
                  Status