SU-SWS/stanford_profile_helper

View on GitHub
src/Config/ConfigOverrides.php

Summary

Maintainability
A
25 mins
Test Coverage
A
98%

Function setMainMenuOverrides has a Cognitive Complexity of 11 (exceeds 10 allowed). Consider refactoring.
Open

  protected function setMainMenuOverrides(array $names, array &$overrides) {
    foreach ($names as $name) {
      if (str_starts_with($name, 'block.block.')) {
        $block_plugin = $this->configFactory->getEditable($name)
          ->getOriginal('plugin', FALSE);
Severity: Minor
Found in src/Config/ConfigOverrides.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.
Wontfix

  public function __construct(StateInterface $state, ConfigPagesLoaderServiceInterface $config_pages_loader, ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, StreamWrapperManagerInterface $stream_wrapper_manager) {
    $this->state = $state;
    $this->configPagesLoader = $config_pages_loader;
    $this->configFactory = $config_factory;
    $this->entityTypeManager = $entity_type_manager;
Severity: Major
Found in src/Config/ConfigOverrides.php and 2 other locations - About 1 hr to fix
modules/stanford_intranet/src/Commands/IntranetCommands.php on lines 67..73
modules/stanford_intranet/src/StanfordIntranetManager.php on lines 65..71

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

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

Avoid excessively long variable names like $stream_wrapper_manager. Keep variable name length under 20.
Open

  public function __construct(StateInterface $state, ConfigPagesLoaderServiceInterface $config_pages_loader, ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, StreamWrapperManagerInterface $stream_wrapper_manager) {
Severity: Minor
Found in src/Config/ConfigOverrides.php by phpmd

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

Source https://phpmd.org/rules/naming.html#longvariable

Doc comment short description must start with a capital letter
Invalid

   * {@inheritDoc}

Doc comment short description must start with a capital letter
Invalid

   * {@inheritDoc}

Doc comment short description must end with a full stop
Invalid

   * {@inheritDoc}

Doc comment short description must end with a full stop
Invalid

   * {@inheritDoc}

Doc comment short description must end with a full stop
Invalid

   * {@inheritDoc}

Doc comment short description must start with a capital letter
Invalid

   * {@inheritDoc}

Doc comment short description must end with a full stop
Invalid

   * {@inheritDoc}

Doc comment short description must start with a capital letter
Invalid

   * {@inheritDoc}

There are no issues that match your filters.

Category
Status