modxcms/revolution

View on GitHub
core/model/modx/processors/resource/create.class.php

Summary

Maintainability
F
6 days
Test Coverage

File create.class.php has 473 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php
/*
 * This file is part of MODX Revolution.
 *
 * Copyright (c) MODX, LLC. All Rights Reserved.
Severity: Minor
Found in core/model/modx/processors/resource/create.class.php - About 7 hrs to fix

    Function saveResourceGroups has a Cognitive Complexity of 37 (exceeds 5 allowed). Consider refactoring.
    Open

        public function saveResourceGroups() {
            $resourceGroups = $this->getProperty('resource_groups',null);
            if ($resourceGroups !== null) {
                $resourceGroups = $this->modx->fromJSON($resourceGroups);
                if (is_array($resourceGroups)) {
    Severity: Minor
    Found in core/model/modx/processors/resource/create.class.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 setFieldDefaults has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
    Open

        public function setFieldDefaults() {
            $scriptProperties = $this->getProperties();
            $scriptProperties['template'] = !isset($scriptProperties['template']) ? (integer) $this->workingContext->getOption('default_template', 0) : (integer) $scriptProperties['template'];
            $scriptProperties['hidemenu'] = !isset($scriptProperties['hidemenu']) ? (integer) $this->workingContext->getOption('hidemenu_default', 0) : (empty($scriptProperties['hidemenu']) ? 0 : 1);
            $scriptProperties['isfolder'] = empty($scriptProperties['isfolder']) ? 0 : 1;
    Severity: Minor
    Found in core/model/modx/processors/resource/create.class.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

    Function addTemplateVariables has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
    Open

        public function addTemplateVariables() {
            $addedTemplateVariables = array();
            $templateKey = $this->getProperty('template',0);
            $this->template = $this->modx->getObject('modTemplate',$templateKey);
            if (!empty($templateKey) && $this->template) {
    Severity: Minor
    Found in core/model/modx/processors/resource/create.class.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

    modResourceCreateProcessor has 26 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class modResourceCreateProcessor extends modObjectCreateProcessor {
        public $classKey = 'modResource';
        public $languageTopics = array('resource');
        public $permission = 'new_document';
        public $objectType = 'resource';
    Severity: Minor
    Found in core/model/modx/processors/resource/create.class.php - About 3 hrs to fix

      Method setFieldDefaults has 56 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function setFieldDefaults() {
              $scriptProperties = $this->getProperties();
              $scriptProperties['template'] = !isset($scriptProperties['template']) ? (integer) $this->workingContext->getOption('default_template', 0) : (integer) $scriptProperties['template'];
              $scriptProperties['hidemenu'] = !isset($scriptProperties['hidemenu']) ? (integer) $this->workingContext->getOption('hidemenu_default', 0) : (empty($scriptProperties['hidemenu']) ? 0 : 1);
              $scriptProperties['isfolder'] = empty($scriptProperties['isfolder']) ? 0 : 1;
      Severity: Major
      Found in core/model/modx/processors/resource/create.class.php - About 2 hrs to fix

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

            public function addTemplateVariables() {
                $addedTemplateVariables = array();
                $templateKey = $this->getProperty('template',0);
                $this->template = $this->modx->getObject('modTemplate',$templateKey);
                if (!empty($templateKey) && $this->template) {
        Severity: Minor
        Found in core/model/modx/processors/resource/create.class.php - About 1 hr to fix

          Method saveResourceGroups has 40 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public function saveResourceGroups() {
                  $resourceGroups = $this->getProperty('resource_groups',null);
                  if ($resourceGroups !== null) {
                      $resourceGroups = $this->modx->fromJSON($resourceGroups);
                      if (is_array($resourceGroups)) {
          Severity: Minor
          Found in core/model/modx/processors/resource/create.class.php - About 1 hr to fix

            Function prepareAlias has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
            Open

                public function prepareAlias() {
                    // The user submitted alias & page title
                    $alias = $this->getProperty('alias');
                    $pageTitle = $this->getProperty('pagetitle');
                    $autoGenerated = false;
            Severity: Minor
            Found in core/model/modx/processors/resource/create.class.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 checkForAllowableCreateToken has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
            Open

                public function checkForAllowableCreateToken() {
                    $tokenPassed = true;
                    $token = $this->getProperty('create-resource-token',false);
                    if (!empty($token)) {
                        $tokenPassed = false;
            Severity: Minor
            Found in core/model/modx/processors/resource/create.class.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 prepareAlias has 31 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                public function prepareAlias() {
                    // The user submitted alias & page title
                    $alias = $this->getProperty('alias');
                    $pageTitle = $this->getProperty('pagetitle');
                    $autoGenerated = false;
            Severity: Minor
            Found in core/model/modx/processors/resource/create.class.php - About 1 hr to fix

              Method beforeSet has 27 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  public function beforeSet() {
                      /* default settings */
                      $this->prepareParent();
                      if ($this->getProperty('parent') === (int) $this->modx->getOption('tree_root_id') && !$this->modx->hasPermission('new_document_in_root')) {
                          return $this->modx->lexicon('permission_denied');
              Severity: Minor
              Found in core/model/modx/processors/resource/create.class.php - About 1 hr to fix

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

                    public function beforeSet() {
                        /* default settings */
                        $this->prepareParent();
                        if ($this->getProperty('parent') === (int) $this->modx->getOption('tree_root_id') && !$this->modx->hasPermission('new_document_in_root')) {
                            return $this->modx->lexicon('permission_denied');
                Severity: Minor
                Found in core/model/modx/processors/resource/create.class.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

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

                    public function checkParentPermissions() {
                        $parent = null;
                        $parentId = intval($this->getProperty('parent'));
                        if ($parentId > 0) {
                            $this->parentResource = $this->modx->getObject('modResource',$parentId);
                Severity: Minor
                Found in core/model/modx/processors/resource/create.class.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

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

                    public function fireBeforeSaveEvent() {
                        /** @var array $OnBeforeDocFormSave */
                        $OnBeforeDocFormSave = $this->modx->invokeEvent('OnBeforeDocFormSave',array(
                            'mode' => modSystemEvent::MODE_NEW,
                            'id' => 0,
                Severity: Minor
                Found in core/model/modx/processors/resource/create.class.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

                Avoid too many return statements within this method.
                Open

                        return parent::beforeSet();
                Severity: Major
                Found in core/model/modx/processors/resource/create.class.php - About 30 mins to fix

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

                      public function prepareAlias() {
                          // The user submitted alias & page title
                          $alias = $this->getProperty('alias');
                          $pageTitle = $this->getProperty('pagetitle');
                          $autoGenerated = false;
                  Severity: Major
                  Found in core/model/modx/processors/resource/create.class.php and 1 other location - About 1 day to fix
                  core/model/modx/processors/resource/update.class.php on lines 365..410

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

                  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

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

                                      if (!empty($resourceGroupAccess['access'])) {
                                          /** @var modResourceGroupResource $resourceGroupResource */
                                          $resourceGroupResource = $this->modx->getObject('modResourceGroupResource',array(
                                              'document_group' => $resourceGroupAccess['id'],
                                              'document' => $this->object->get('id'),
                  Severity: Major
                  Found in core/model/modx/processors/resource/create.class.php and 1 other location - About 2 hrs to fix
                  core/model/modx/processors/resource/update.class.php on lines 785..818

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

                  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