Sign upLogin

wikimedia/mediawiki-core

View on GitHub
Star
includes/htmlform/HTMLForm.php

Summary

Maintainability
F
1 wk
Test Coverage

File HTMLForm.php has 1020 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

/**
 * HTML form generation and submission handling.
 *
Severity: Major
Found in includes/htmlform/HTMLForm.php - About 2 days to fix

    HTMLForm has 93 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class HTMLForm extends ContextSource {
    use ProtectedHookAccessorTrait;

    /** @var string[] A mapping of 'type' inputs onto standard HTMLFormField subclasses */
    public static $typeMappings = [
    Severity: Major
    Found in includes/htmlform/HTMLForm.php - About 1 day to fix

      Function trySubmit has a Cognitive Complexity of 36 (exceeds 5 allowed). Consider refactoring.
      Open

          public function trySubmit() {
        $valid = true;
        $hoistedErrors = Status::newGood();
        if ( $this->mValidationErrorMessage ) {
            foreach ( $this->mValidationErrorMessage as $error ) {
      Severity: Minor
      Found in includes/htmlform/HTMLForm.php - About 5 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

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

          public function displaySection( $fields,
        $sectionName = '',
        $fieldsetIDPrefix = '',
        &$hasUserVisibleFields = false
    ) {
      Severity: Minor
      Found in includes/htmlform/HTMLForm.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 trySubmit has 65 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function trySubmit() {
        $valid = true;
        $hoistedErrors = Status::newGood();
        if ( $this->mValidationErrorMessage ) {
            foreach ( $this->mValidationErrorMessage as $error ) {
      Severity: Major
      Found in includes/htmlform/HTMLForm.php - About 2 hrs to fix

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

            public function getButtons() {
        $buttons = '';

        if ( $this->mShowSubmit ) {
            $attribs = [];
        Severity: Minor
        Found in includes/htmlform/HTMLForm.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 displaySection has 56 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function displaySection( $fields,
        $sectionName = '',
        $fieldsetIDPrefix = '',
        &$hasUserVisibleFields = false
    ) {
        Severity: Major
        Found in includes/htmlform/HTMLForm.php - About 2 hrs to fix

          Method getButtons has 53 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public function getButtons() {
        $buttons = '';

        if ( $this->mShowSubmit ) {
            $attribs = [];
          Severity: Major
          Found in includes/htmlform/HTMLForm.php - About 2 hrs to fix

            Function getErrorsOrWarnings has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
            Open

                public function getErrorsOrWarnings( $elements, $elementsType ) {
        if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
            throw new DomainException( $elementsType . ' is not a valid type.' );
        }
        $elementstr = false;
            Severity: Minor
            Found in includes/htmlform/HTMLForm.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 loadFieldData has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
            Open

                protected function loadFieldData() {
        $fieldData = [];
        $request = $this->getRequest();

        foreach ( $this->mFlatFields as $fieldname => $field ) {
            Severity: Minor
            Found in includes/htmlform/HTMLForm.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 getErrorsOrWarnings has 30 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                public function getErrorsOrWarnings( $elements, $elementsType ) {
        if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
            throw new DomainException( $elementsType . ' is not a valid type.' );
        }
        $elementstr = false;
            Severity: Minor
            Found in includes/htmlform/HTMLForm.php - About 1 hr to fix

              Method addButton has 28 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  public function addButton( $data ) {
        if ( !is_array( $data ) ) {
            $args = func_get_args();
            if ( count( $args ) < 2 || count( $args ) > 4 ) {
                throw new InvalidArgumentException(
              Severity: Minor
              Found in includes/htmlform/HTMLForm.php - About 1 hr to fix

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

                    public function tryAuthorizedSubmit() {
        $result = false;

        if ( $this->mFormIdentifier === null ) {
            $identOkay = true;
                Severity: Minor
                Found in includes/htmlform/HTMLForm.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 addFields has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
                Open

                    public function addFields( $descriptor ) {
        $loadedDescriptor = [];

        foreach ( $descriptor as $fieldname => $info ) {
            $section = $info['section'] ?? '';
                Severity: Minor
                Found in includes/htmlform/HTMLForm.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

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

                    public function addButton( $data ) {
        if ( !is_array( $data ) ) {
            $args = func_get_args();
            if ( count( $args ) < 2 || count( $args ) > 4 ) {
                throw new InvalidArgumentException(
                Severity: Minor
                Found in includes/htmlform/HTMLForm.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

                Avoid too many return statements within this method.
                Open

                            return Html::rawElement( 'div', $attribs, "\n$html\n" );
                Severity: Major
                Found in includes/htmlform/HTMLForm.php - About 30 mins to fix

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

                      protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
        if ( !$fieldsHtml ) {
            // Do not generate any wrappers for empty sections. Sections may be empty if they only have
            // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
            return '';
                  Severity: Minor
                  Found in includes/htmlform/HTMLForm.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

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

                              if ( isset( $button['label-message'] ) ) {
                $label = $this->getMessage( $button['label-message'] )->parse();
            } elseif ( isset( $button['label'] ) ) {
                $label = htmlspecialchars( $button['label'] );
            } elseif ( isset( $button['label-raw'] ) ) {
                  Severity: Major
                  Found in includes/htmlform/HTMLForm.php and 1 other location - About 1 hr to fix
                  includes/htmlform/CodexHTMLForm.php on lines 218..226

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

                  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