PartialUserFormController::partial() - Code Metrics - Inspection of "Solves #15 Safe files to partial submissions" - Firesphere/silverstripe-partial-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#16)

by Simon

created 2019-08-29 02:29 UTC

PartialUserFormController::partial() C

↳ Parent: PartialUserFormController

Complexity

Conditions	11
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	56.5782

Importance

Changes

Metric	Value
dl	0
loc	60
ccs	10
cts	36
cp	0.2778
rs	6.726
c	0
b	0
f	0
cc	11
nc	8
nop	1
crap	56.5782

How to fix Long Method Complexity

<?php

namespace Firesphere\PartialUserforms\Controllers;

use Exception;
use Firesphere\PartialUserforms\Models\PartialFormSubmission;
use Page;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\HTTPResponse_Exception;
use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\ORM\FieldType\DBHTMLText;
use SilverStripe\UserForms\Control\UserDefinedFormController;

/**
 * Class PartialUserFormController
 *
 * @package Firesphere\PartialUserforms\Controllers
 */
class PartialUserFormController extends UserDefinedFormController
{
    /**
     * @var array
     */
    private static $url_handlers = [

        '$Key/$Token' => 'partial',
    ];

    /**
     * @var array
     */
    private static $allowed_actions = [

        'partial',
    ];

    /**
     * Partial form
     *
     * @param HTTPRequest $request
     * @return DBHTMLText|void
     * @throws HTTPResponse_Exception
     * @throws Exception
     */
    public function partial(HTTPRequest $request)
    {
        // Ensure this URL doesn't get picked up by HTTP caches
        HTTPCacheControlMiddleware::singleton()->disableCache();

        $key = $request->param('Key');
        $token = $request->param('Token');
        if (!$key || !$token) {
            return $this->httpError(404);
        }

        /** @var PartialFormSubmission $partial */
        $partial = PartialFormSubmission::get()->find('Token', $token);
        if (!$partial ||
            !$partial->UserDefinedFormID ||
            !hash_equals($partial->generateKey($token), $key)
        ) {
            return $this->httpError(404);
        }

        // Set the session if the last session has expired
        if (!$request->getSession()->get(PartialSubmissionController::SESSION_KEY)) {
            $request->getSession()->set(PartialSubmissionController::SESSION_KEY, $partial->ID);
        }

        // TODO: Recognize visitor with the password
        // Set data record and load the form
        $this->dataRecord = DataObject::get_by_id($partial->UserDefinedFormClass, $partial->UserDefinedFormID);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->setFailover($this->dataRecord);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

        $form = $this->Form();
        $fields = $partial->PartialFields()->map('Name', 'Value')->toArray();
        $form->loadDataFrom($fields);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        // Copied from {@link UserDefinedFormController}
        if ($this->Content && $form && !$this->config()->disable_form_content_shortcode) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $hasLocation = stristr($this->Content, '$UserDefinedForm');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            if ($hasLocation) {
                /** @see Requirements_Backend::escapeReplacement */
                $formEscapedForRegex = addcslashes($form->forTemplate(), '\\$');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                $content = preg_replace(
                    '/(<p[^>]*>)?\\$UserDefinedForm(<\\/p>)?/i',
                    $formEscapedForRegex,
                    $this->Content
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                );

                return $this->customise([
                    'Content'     => DBField::create_field('HTMLText', $content),
                    'Form'        => '',
                    'PartialLink' => $partial->getPartialLink()
                ])->renderWith([static::class, Page::class]);
            }
        }

        return $this->customise([
            'Content'     => DBField::create_field('HTMLText', $this->Content),
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            'Form'        => $form,
            'PartialLink' => $partial->getPartialLink()
        ])->renderWith([static::class, Page::class]);
    }
}


1		<?php
2
3		namespace Firesphere\PartialUserforms\Controllers;
4
5		use Exception;
6		use Firesphere\PartialUserforms\Models\PartialFormSubmission;
7		use Page;
8		use SilverStripe\Control\HTTPRequest;
9		use SilverStripe\Control\HTTPResponse_Exception;
10		use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware;
11		use SilverStripe\ORM\DataObject;
12		use SilverStripe\ORM\FieldType\DBField;
13		use SilverStripe\ORM\FieldType\DBHTMLText;
14		use SilverStripe\UserForms\Control\UserDefinedFormController;
15
16		/**
17		* Class PartialUserFormController
18		*
19		* @package Firesphere\PartialUserforms\Controllers
20		*/
21		class PartialUserFormController extends UserDefinedFormController
22		{
23		/**
24		* @var array
25		*/
26		private static $url_handlers = [
		0 ignored issues – show Comprehensibility introduced 2019-08-22 09:10 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
27		'$Key/$Token' => 'partial',
28		];
29
30		/**
31		* @var array
32		*/
33		private static $allowed_actions = [
		0 ignored issues – show Comprehensibility introduced 2019-08-22 04:04 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
34		'partial',
35		];
36
37		/**
38		* Partial form
39		*
40		* @param HTTPRequest $request
41		* @return DBHTMLText\|void
42		* @throws HTTPResponse_Exception
43		* @throws Exception
44		*/
45	3	public function partial(HTTPRequest $request)
46		{
47		// Ensure this URL doesn't get picked up by HTTP caches
48	3	HTTPCacheControlMiddleware::singleton()->disableCache();
49
50	3	$key = $request->param('Key');
51	3	$token = $request->param('Token');
52	3	if (!$key \|\| !$token) {
53	1	return $this->httpError(404);
54		}
55
56		/** @var PartialFormSubmission $partial */
57	2	$partial = PartialFormSubmission::get()->find('Token', $token);
58	2	if (!$partial \|\|
59		!$partial->UserDefinedFormID \|\|
60	2	!hash_equals($partial->generateKey($token), $key)
61		) {
62	2	return $this->httpError(404);
63		}
64
65		// Set the session if the last session has expired
66		if (!$request->getSession()->get(PartialSubmissionController::SESSION_KEY)) {
67		$request->getSession()->set(PartialSubmissionController::SESSION_KEY, $partial->ID);
68		}
69
70		// TODO: Recognize visitor with the password
71		// Set data record and load the form
72		$this->dataRecord = DataObject::get_by_id($partial->UserDefinedFormClass, $partial->UserDefinedFormID);
		0 ignored issues – show Documentation introduced 2019-08-22 05:57 UTC by Report Bug Copy Issue Report The property `UserDefinedFormClass` does not exist on `object<Firesphere\Partia...\PartialFormSubmission>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation Bug introduced 2019-08-22 09:10 UTC by Report Bug Copy Issue Report It seems like `\SilverStripe\ORM\DataOb...ial->UserDefinedFormID)` can also be of type `object<SilverStripe\ORM\DataObject>`. However, the property `$dataRecord` is declared as type `object<SilverStripe\CMS\Model\SiteTree>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /* @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
73		$this->setFailover($this->dataRecord);
		0 ignored issues – show Bug introduced 2019-08-22 09:10 UTC by Report Bug Copy Issue Report It seems like `$this->dataRecord` can be `null`; however, `setFailover()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
74
75		$form = $this->Form();
76		$fields = $partial->PartialFields()->map('Name', 'Value')->toArray();
77		$form->loadDataFrom($fields);
		0 ignored issues – show Documentation Bug introduced 2019-08-23 02:42 UTC by Report Bug Copy Issue Report The method `loadDataFrom` does not exist on `object<Firesphere\Partia...tialUserFormController>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
78
79		// Copied from {@link UserDefinedFormController}
80		if ($this->Content && $form && !$this->config()->disable_form_content_shortcode) {
		0 ignored issues – show Documentation introduced 2019-08-22 09:10 UTC by Report Bug Copy Issue Report The property `Content` does not exist on `object<Firesphere\Partia...tialUserFormController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
81		$hasLocation = stristr($this->Content, '$UserDefinedForm');
		0 ignored issues – show Documentation introduced 2019-08-22 09:10 UTC by Report Bug Copy Issue Report The property `Content` does not exist on `object<Firesphere\Partia...tialUserFormController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
82		if ($hasLocation) {
83		/** @see Requirements_Backend::escapeReplacement */
84		$formEscapedForRegex = addcslashes($form->forTemplate(), '\\$');
		0 ignored issues – show Documentation Bug introduced 2019-08-22 09:10 UTC by Report Bug Copy Issue Report The method `forTemplate` does not exist on `object<Firesphere\Partia...tialUserFormController>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
85		$content = preg_replace(
86		'/(<p[^>]*>)?\\$UserDefinedForm(<\\/p>)?/i',
87		$formEscapedForRegex,
88		$this->Content
		0 ignored issues – show Documentation introduced 2019-08-22 09:10 UTC by Report Bug Copy Issue Report The property `Content` does not exist on `object<Firesphere\Partia...tialUserFormController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
89		);
90
91		return $this->customise([
92		'Content' => DBField::create_field('HTMLText', $content),
93		'Form' => '',
94		'PartialLink' => $partial->getPartialLink()
95		])->renderWith([static::class, Page::class]);
96		}
97		}
98
99		return $this->customise([
100		'Content' => DBField::create_field('HTMLText', $this->Content),
		0 ignored issues – show Documentation introduced 2019-08-22 09:10 UTC by Report Bug Copy Issue Report The property `Content` does not exist on `object<Firesphere\Partia...tialUserFormController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
101		'Form' => $form,
102		'PartialLink' => $partial->getPartialLink()
103		])->renderWith([static::class, Page::class]);
104		}
105		}
106

Firesphere / silverstripe-partial-userforms

Pull Request — master (#16)

PartialUserFormController::partial() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like