wikimedia/mediawiki-core

View on GitHub
includes/watchlist/WatchedItemQueryService.php

Summary

Maintainability
F
4 days
Test Coverage

File WatchedItemQueryService.php has 571 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace MediaWiki\Watchlist;

use ChangeTags;
Severity: Major
Found in includes/watchlist/WatchedItemQueryService.php - About 1 day to fix

    Method getWatchedItemsWithRecentChangeInfo has 98 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function getWatchedItemsWithRecentChangeInfo(
            User $user, array $options = [], &$startFrom = null
        ) {
            $options += [
                'includeFields' => [],
    Severity: Major
    Found in includes/watchlist/WatchedItemQueryService.php - About 3 hrs to fix

      Function getWatchedItemsWithRCInfoQueryFilterConds has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
      Open

          private function getWatchedItemsWithRCInfoQueryFilterConds(
              IReadableDatabase $dbr,
              User $user,
              array $options
          ) {
      Severity: Minor
      Found in includes/watchlist/WatchedItemQueryService.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 getWatchedItemsWithRCInfoQueryFields has 50 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function getWatchedItemsWithRCInfoQueryFields( array $options ) {
              $fields = [
                  'rc_id',
                  'rc_namespace',
                  'rc_title',
      Severity: Minor
      Found in includes/watchlist/WatchedItemQueryService.php - About 2 hrs to fix

        Method getWatchedItemsForUser has 47 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function getWatchedItemsForUser( UserIdentity $user, array $options = [] ) {
                if ( !$user->isRegistered() ) {
                    // TODO: should this just return an empty array or rather complain loud at this point
                    // as e.g. ApiBase::getWatchlistUser does?
                    return [];
        Severity: Minor
        Found in includes/watchlist/WatchedItemQueryService.php - About 1 hr to fix

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

              private function getWatchedItemsWithRCInfoQueryFilterConds(
                  IReadableDatabase $dbr,
                  User $user,
                  array $options
              ) {
          Severity: Minor
          Found in includes/watchlist/WatchedItemQueryService.php - About 1 hr to fix

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

                public function getWatchedItemsWithRecentChangeInfo(
                    User $user, array $options = [], &$startFrom = null
                ) {
                    $options += [
                        'includeFields' => [],
            Severity: Minor
            Found in includes/watchlist/WatchedItemQueryService.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 getWatchedItemsWithRCInfoQueryFields has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
            Open

                private function getWatchedItemsWithRCInfoQueryFields( array $options ) {
                    $fields = [
                        'rc_id',
                        'rc_namespace',
                        'rc_title',
            Severity: Minor
            Found in includes/watchlist/WatchedItemQueryService.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 getWatchedItemsWithRCInfoQueryConds has 31 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                private function getWatchedItemsWithRCInfoQueryConds(
                    IReadableDatabase $db,
                    User $user,
                    array $options
                ) {
            Severity: Minor
            Found in includes/watchlist/WatchedItemQueryService.php - About 1 hr to fix

              Method getWatchedItemsWithRCInfoQueryJoinConds has 26 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  private function getWatchedItemsWithRCInfoQueryJoinConds( array $options ) {
                      $joinConds = [
                          'watchlist' => [ 'JOIN',
                              [
                                  'wl_namespace=rc_namespace',
              Severity: Minor
              Found in includes/watchlist/WatchedItemQueryService.php - About 1 hr to fix

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

                        IConnectionProvider $dbProvider,
                        CommentStore $commentStore,
                        WatchedItemStoreInterface $watchedItemStore,
                        HookContainer $hookContainer,
                        UserOptionsLookup $userOptionsLookup,
                Severity: Major
                Found in includes/watchlist/WatchedItemQueryService.php - About 1 hr to fix

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

                      private function addQueryCondsForWatchedItemsForUser(
                          IReadableDatabase $db, UserIdentity $user, array $options, SelectQueryBuilder $queryBuilder
                      ) {
                          $queryBuilder->where( [ 'wl_user' => $user->getId() ] );
                          if ( $options['namespaceIds'] ) {
                  Severity: Minor
                  Found in includes/watchlist/WatchedItemQueryService.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

                  Consider simplifying this complex logical expression.
                  Open

                          if ( in_array( self::INCLUDE_USER, $options['includeFields'] ) ||
                              in_array( self::INCLUDE_USER_ID, $options['includeFields'] ) ||
                              in_array( self::FILTER_ANON, $options['filters'] ) ||
                              in_array( self::FILTER_NOT_ANON, $options['filters'] ) ||
                              array_key_exists( 'onlyByUser', $options ) || array_key_exists( 'notByUser', $options )
                  Severity: Major
                  Found in includes/watchlist/WatchedItemQueryService.php - About 40 mins to fix

                    Consider simplifying this complex logical expression.
                    Open

                            if ( in_array( self::INCLUDE_USER, $options['includeFields'] ) ||
                                in_array( self::INCLUDE_USER_ID, $options['includeFields'] ) ||
                                in_array( self::FILTER_ANON, $options['filters'] ) ||
                                in_array( self::FILTER_NOT_ANON, $options['filters'] ) ||
                                array_key_exists( 'onlyByUser', $options ) || array_key_exists( 'notByUser', $options )
                    Severity: Major
                    Found in includes/watchlist/WatchedItemQueryService.php - About 40 mins to fix

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

                          private function getUserRelatedConds( IReadableDatabase $db, Authority $user, array $options ) {
                              if ( !array_key_exists( 'onlyByUser', $options ) && !array_key_exists( 'notByUser', $options ) ) {
                                  return [];
                              }
                      
                      
                      Severity: Minor
                      Found in includes/watchlist/WatchedItemQueryService.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 getWatchedItemsWithRCInfoQueryConds has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                      Open

                          private function getWatchedItemsWithRCInfoQueryConds(
                              IReadableDatabase $db,
                              User $user,
                              array $options
                          ) {
                      Severity: Minor
                      Found in includes/watchlist/WatchedItemQueryService.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 getWatchedItemsForUser has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                      Open

                          public function getWatchedItemsForUser( UserIdentity $user, array $options = [] ) {
                              if ( !$user->isRegistered() ) {
                                  // TODO: should this just return an empty array or rather complain loud at this point
                                  // as e.g. ApiBase::getWatchlistUser does?
                                  return [];
                      Severity: Minor
                      Found in includes/watchlist/WatchedItemQueryService.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 ( in_array( self::INCLUDE_USER, $options['includeFields'] ) ||
                                  in_array( self::INCLUDE_USER_ID, $options['includeFields'] ) ||
                                  in_array( self::FILTER_ANON, $options['filters'] ) ||
                                  in_array( self::FILTER_NOT_ANON, $options['filters'] ) ||
                                  array_key_exists( 'onlyByUser', $options ) || array_key_exists( 'notByUser', $options )
                      Severity: Major
                      Found in includes/watchlist/WatchedItemQueryService.php and 1 other location - About 1 hr to fix
                      includes/watchlist/WatchedItemQueryService.php on lines 395..402

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

                      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

                              if ( in_array( self::INCLUDE_USER, $options['includeFields'] ) ||
                                  in_array( self::INCLUDE_USER_ID, $options['includeFields'] ) ||
                                  in_array( self::FILTER_ANON, $options['filters'] ) ||
                                  in_array( self::FILTER_NOT_ANON, $options['filters'] ) ||
                                  array_key_exists( 'onlyByUser', $options ) || array_key_exists( 'notByUser', $options )
                      Severity: Major
                      Found in includes/watchlist/WatchedItemQueryService.php and 1 other location - About 1 hr to fix
                      includes/watchlist/WatchedItemQueryService.php on lines 762..769

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

                      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