wikimedia/mediawiki-core

View on GitHub
includes/xml/Xml.php

Summary

Maintainability
F
4 days
Test Coverage

File Xml.php has 392 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php
/**
 * Methods to generate XML.
 *
 * This program is free software; you can redistribute it and/or modify
Severity: Minor
Found in includes/xml/Xml.php - About 5 hrs to fix

    Xml has 36 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class Xml {
        /**
         * Format an XML element with given attributes and, optionally, text content.
         * Element and attribute names are assumed to be ready for literal inclusion.
         * Strings are assumed to not contain XML-illegal characters; special
    Severity: Minor
    Found in includes/xml/Xml.php - About 4 hrs to fix

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

          public static function listDropdownOptions( $list, $params = [] ) {
              $options = [];
      
              if ( isset( $params['other'] ) ) {
                  $options[ $params['other'] ] = 'other';
      Severity: Minor
      Found in includes/xml/Xml.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 listDropdownOptions has 35 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public static function listDropdownOptions( $list, $params = [] ) {
              $options = [];
      
              if ( isset( $params['other'] ) ) {
                  $options[ $params['other'] ] = 'other';
      Severity: Minor
      Found in includes/xml/Xml.php - About 1 hr to fix

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

            public static function buildTable( $rows, $attribs = [], $headers = null ) {
                $s = self::openElement( 'table', $attribs );
        
                if ( is_array( $headers ) ) {
                    $s .= self::openElement( 'thead', $attribs );
        Severity: Minor
        Found in includes/xml/Xml.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 inputLabel has 6 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            public static function inputLabel( $label, $name, $id, $size = false,
                $value = false, $attribs = []
        Severity: Minor
        Found in includes/xml/Xml.php - About 45 mins to fix

          Function dateMenu has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
          Open

              public static function dateMenu( $year, $month ) {
                  wfDeprecated( __METHOD__, '1.42' );
                  # Offset overrides year/month selection
                  if ( $month && $month !== -1 ) {
                      $encMonth = intval( $month );
          Severity: Minor
          Found in includes/xml/Xml.php - About 45 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 inputLabelSep has 6 arguments (exceeds 4 allowed). Consider refactoring.
          Open

              public static function inputLabelSep( $label, $name, $id, $size = false,
                  $value = false, $attribs = []
          Severity: Minor
          Found in includes/xml/Xml.php - About 45 mins to fix

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

                public static function listDropdown( $name = '', $list = '', $other = '',
                    $selected = '', $class = '', $tabindex = null
            Severity: Minor
            Found in includes/xml/Xml.php - About 45 mins to fix

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

                  public static function radioLabel( $label, $name, $value, $id,
                      $checked = false, $attribs = []
              Severity: Minor
              Found in includes/xml/Xml.php - About 45 mins to fix

                Method languageSelector has 5 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                    public static function languageSelector( $selected, $customisedOnly = true,
                        $inLanguage = null, $overrideAttrs = [], Message $msg = null
                Severity: Minor
                Found in includes/xml/Xml.php - About 35 mins to fix

                  Method textarea has 5 arguments (exceeds 4 allowed). Consider refactoring.
                  Open

                      public static function textarea( $name, $content, $cols = 40, $rows = 5, $attribs = [] ) {
                  Severity: Minor
                  Found in includes/xml/Xml.php - About 35 mins to fix

                    Method checkLabel has 5 arguments (exceeds 4 allowed). Consider refactoring.
                    Open

                        public static function checkLabel( $label, $name, $id, $checked = false, $attribs = [] ) {
                    Severity: Minor
                    Found in includes/xml/Xml.php - About 35 mins to fix

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

                          public static function listDropdownOptionsOoui( $options ) {
                              $optionsOoui = [];
                      
                              foreach ( $options as $text => $value ) {
                                  if ( is_array( $value ) ) {
                      Severity: Minor
                      Found in includes/xml/Xml.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

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

                          public static function listDropdownOptions( $list, $params = [] ) {
                              $options = [];
                      
                              if ( isset( $params['other'] ) ) {
                                  $options[ $params['other'] ] = 'other';
                      Severity: Major
                      Found in includes/xml/Xml.php and 1 other location - About 1 day to fix
                      includes/Html/Html.php on lines 1170..1210

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

                      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

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

                          public static function listDropdownOptionsOoui( $options ) {
                              $optionsOoui = [];
                      
                              foreach ( $options as $text => $value ) {
                                  if ( is_array( $value ) ) {
                      Severity: Major
                      Found in includes/xml/Xml.php and 1 other location - About 1 hr to fix
                      includes/Html/Html.php on lines 1220..1235

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

                      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