Sign upLogin

SU-SWS/stanford_profile

View on GitHub
Star
src/Plugin/InstallTask/SiteSettings.php

Summary

Maintainability
A
0 mins
Test Coverage
A
100%

Method runTask has 43 lines of code (exceeds 25 allowed). Consider refactoring.
Wontfix

  public function runTask(array &$install_state) {
    $this->state->set('nobots', FALSE);

    $node_pages = [
      '403_page' => '4b8018dc-49a6-4018-9c54-e8c3e462beee',
Severity: Minor
Found in src/Plugin/InstallTask/SiteSettings.php - About 1 hr to fix

    Method getSnowData has 33 lines of code (exceeds 25 allowed). Consider refactoring.
    Wontfix

      protected function getSnowData($site_name) {
    $api_url = Settings::get('stanford_profile_snow_api_url', self::SNOW_API);
    try {
      $response = $this->client->request('GET', $api_url, [
        'query' => ['website_address' => $site_name],
    Severity: Minor
    Found in src/Plugin/InstallTask/SiteSettings.php - About 1 hr to fix

      Function runTask has a Cognitive Complexity of 13 (exceeds 10 allowed). Consider refactoring.
      Wontfix

        public function runTask(array &$install_state) {
    $this->state->set('nobots', FALSE);

    $node_pages = [
      '403_page' => '4b8018dc-49a6-4018-9c54-e8c3e462beee',
      Severity: Minor
      Found in src/Plugin/InstallTask/SiteSettings.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

      The class SiteSettings has a coupling between objects value of 16. Consider to reduce the number of dependencies under 13.
      Wontfix

      class SiteSettings extends InstallTaskBase implements ContainerFactoryPluginInterface {

  /**
   * The fallback site name.
   */
      Severity: Minor
      Found in src/Plugin/InstallTask/SiteSettings.php by phpmd

      CouplingBetweenObjects

      Since: 1.1.0

      A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

      Example

      class Foo {
    /**
     * @var \foo\bar\X
     */
    private $x = null;

    /**
     * @var \foo\bar\Y
     */
    private $y = null;

    /**
     * @var \foo\bar\Z
     */
    private $z = null;

    public function setFoo(\Foo $foo) {}
    public function setBar(\Bar $bar) {}
    public function setBaz(\Baz $baz) {}

    /**
     * @return \SplObjectStorage
     * @throws \OutOfRangeException
     * @throws \InvalidArgumentException
     * @throws \ErrorException
     */
    public function process(\Iterator $it) {}

    // ...
}

      Source https://phpmd.org/rules/design.html#couplingbetweenobjects

      Missing class import via use statement (line '213', column '19').
      Open

              throw new \Exception($response['result'][0]['message']);
      Severity: Minor
      Found in src/Plugin/InstallTask/SiteSettings.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
    return new \stdClass();
}

      Source http://phpmd.org/rules/cleancode.html#MissingImport

      Missing class import via use statement (line '209', column '19').
      Open

              throw new \Exception('Could not decode JSON from SNOW API.');
      Severity: Minor
      Found in src/Plugin/InstallTask/SiteSettings.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
    return new \stdClass();
}

      Source http://phpmd.org/rules/cleancode.html#MissingImport

      Avoid assigning values to variables in if clauses and the like (line '116', column '11').
      Invalid

        public function runTask(array &$install_state) {
    $this->state->set('nobots', FALSE);

    $node_pages = [
      '403_page' => '4b8018dc-49a6-4018-9c54-e8c3e462beee',
      Severity: Minor
      Found in src/Plugin/InstallTask/SiteSettings.php by phpmd

      IfStatementAssignment

      Since: 2.7.0

      Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($foo = 'bar') { // possible typo
            // ...
        }
        if ($baz = 0) { // always false
            // ...
        }
    }
}

      Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

      Doc comment short description must end with a full stop
      Invalid

         * {@inheritDoc}
      Severity: Minor
      Found in src/Plugin/InstallTask/SiteSettings.php by phpcodesniffer

      Doc comment short description must start with a capital letter
      Invalid

         * {@inheritDoc}
      Severity: Minor
      Found in src/Plugin/InstallTask/SiteSettings.php by phpcodesniffer

      Doc comment short description must start with a capital letter
      Invalid

         * {@inheritDoc}
      Severity: Minor
      Found in src/Plugin/InstallTask/SiteSettings.php by phpcodesniffer

      Doc comment short description must end with a full stop
      Invalid

         * {@inheritDoc}
      Severity: Minor
      Found in src/Plugin/InstallTask/SiteSettings.php by phpcodesniffer

      Doc comment short description must end with a full stop
      Invalid

         * {@inheritDoc}
      Severity: Minor
      Found in src/Plugin/InstallTask/SiteSettings.php by phpcodesniffer

      Doc comment short description must start with a capital letter
      Invalid

         * {@inheritDoc}
      Severity: Minor
      Found in src/Plugin/InstallTask/SiteSettings.php by phpcodesniffer

      There are no issues that match your filters.

      Category
      Status