wikimedia/mediawiki-core

View on GitHub
includes/api/ApiHelp.php

Summary

Maintainability
F
1 wk
Test Coverage

Function getHelpInternal has a Cognitive Complexity of 155 (exceeds 5 allowed). Consider refactoring.
Open

    private static function getHelpInternal( IContextSource $context, array $modules,
        array $options, &$haveModules
    ) {
        $out = '';

Severity: Minor
Found in includes/api/ApiHelp.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

Method getHelpInternal has 348 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private static function getHelpInternal( IContextSource $context, array $modules,
        array $options, &$haveModules
    ) {
        $out = '';

Severity: Major
Found in includes/api/ApiHelp.php - About 1 day to fix

    File ApiHelp.php has 572 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
    /**
     * Copyright © 2014 Wikimedia Foundation and contributors
     *
     * This program is free software; you can redistribute it and/or modify
    Severity: Major
    Found in includes/api/ApiHelp.php - About 1 day to fix

      Method getHelp has 56 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public static function getHelp( IContextSource $context, $modules, array $options ) {
              if ( !is_array( $modules ) ) {
                  $modules = [ $modules ];
              }
      
      
      Severity: Major
      Found in includes/api/ApiHelp.php - About 2 hrs to fix

        Function getHelp has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
        Open

            public static function getHelp( IContextSource $context, $modules, array $options ) {
                if ( !is_array( $modules ) ) {
                    $modules = [ $modules ];
                }
        
        
        Severity: Minor
        Found in includes/api/ApiHelp.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 execute has 46 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function execute() {
                $params = $this->extractRequestParams();
                $modules = [];
        
                foreach ( $params['modules'] as $path ) {
        Severity: Minor
        Found in includes/api/ApiHelp.php - About 1 hr to fix

          Method fixHelpLinks has 31 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public static function fixHelpLinks( $html, $helptitle = null, $localModules = [] ) {
                  return HtmlHelper::modifyElements(
                      $html,
                      static function ( SerializerNode $node ): bool {
                          return $node->name === 'a'
          Severity: Minor
          Found in includes/api/ApiHelp.php - About 1 hr to fix

            Function fixHelpLinks has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                public static function fixHelpLinks( $html, $helptitle = null, $localModules = [] ) {
                    return HtmlHelper::modifyElements(
                        $html,
                        static function ( SerializerNode $node ): bool {
                            return $node->name === 'a'
            Severity: Minor
            Found in includes/api/ApiHelp.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

            There are no issues that match your filters.

            Category
            Status