PartialUserFormController::getPartialFormSubmission() - Code Metrics - Inspection of "Add password protection selection to the form" - Firesphere/silverstripe-partial-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#12)

by Simon

created 2019-08-28 04:37 UTC

getPartialFormSubmission() A

↳ Parent: PartialUserFormController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Firesphere\PartialUserforms\Controllers;

use Exception;
use Firesphere\PartialUserforms\Forms\PasswordForm;
use Firesphere\PartialUserforms\Models\PartialFormSubmission;
use Page;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\HTTPResponse;
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;
use SilverStripe\UserForms\Model\UserDefinedForm;

/**
 * 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',
    ];
    /**
     * @var PartialFormSubmission
     */
    protected $partialFormSubmission;

    /**
     * Partial form
     *
     * @param HTTPRequest $request
     * @return HTTPResponse|DBHTMLText|void
     * @throws Exception
     */
    public function partial(HTTPRequest $request)
    {
        /** @var PartialFormSubmission $partial */
        $partial = $this->setData($request);
        if ($this->dataRecord->PasswordProtected &&
            $request->getSession()->get(PasswordForm::PASSWORD_SESSION_KEY) !== $partial->ID
        ) {
            return $this->redirect('verify');
        }

//        $this->setFailover($this->dataRecord);

        $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]);
    }

    /**
     * A little abstraction to be more readable
     *
     * @param HTTPRequest $request
     * @return PartialFormSubmission|void
     * @throws HTTPResponse_Exception
     */
    public function setData($request)
    {
        // Ensure this URL doesn't get picked up by HTTP caches
        HTTPCacheControlMiddleware::singleton()->disableCache();

        $key = $request->param('Key');
        $token = $request->param('Token');

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

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

        $this->setPartialFormSubmission($partial);
        // Set data record and load the form
        /** @var UserDefinedForm dataRecord */
        $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.");
        }
    }

}

        return $partial;
    }

    /**
     * @return PartialFormSubmission
     */
    public function getPartialFormSubmission(): PartialFormSubmission
    {
        return $this->partialFormSubmission;
    }

    /**
     * @param PartialFormSubmission $partialFormSubmission
     */
    public function setPartialFormSubmission(PartialFormSubmission $partialFormSubmission): void
    {
        $this->partialFormSubmission = $partialFormSubmission;
    }
}


1			<?php
2
3			namespace Firesphere\PartialUserforms\Controllers;
4
5			use Exception;
6			use Firesphere\PartialUserforms\Forms\PasswordForm;
7			use Firesphere\PartialUserforms\Models\PartialFormSubmission;
8			use Page;
9			use SilverStripe\Control\HTTPRequest;
10			use SilverStripe\Control\HTTPResponse;
11			use SilverStripe\Control\HTTPResponse_Exception;
12			use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware;
13			use SilverStripe\ORM\DataObject;
14			use SilverStripe\ORM\FieldType\DBField;
15			use SilverStripe\ORM\FieldType\DBHTMLText;
16			use SilverStripe\UserForms\Control\UserDefinedFormController;
17			use SilverStripe\UserForms\Model\UserDefinedForm;
18
19			/**
20			* Class PartialUserFormController
21			*
22			* @package Firesphere\PartialUserforms\Controllers
23			*/
24			class PartialUserFormController extends UserDefinedFormController
25			{
26
27			/**
28			* @var array
29			*/
30			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...
31			'$Key/$Token' => 'partial',
32			];
33			/**
34			* @var array
35			*/
36			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...
37			'partial',
38			];
39			/**
40			* @var PartialFormSubmission
41			*/
42			protected $partialFormSubmission;
43
44			/**
45			* Partial form
46			*
47			* @param HTTPRequest $request
48			* @return HTTPResponse\|DBHTMLText\|void
49			* @throws Exception
50			*/
51			public function partial(HTTPRequest $request)
52			{
53			/** @var PartialFormSubmission $partial */
54			$partial = $this->setData($request);
55			if ($this->dataRecord->PasswordProtected &&
56			$request->getSession()->get(PasswordForm::PASSWORD_SESSION_KEY) !== $partial->ID
57			) {
58			return $this->redirect('verify');
59			}
60
61			// $this->setFailover($this->dataRecord);
62
63			$form = $this->Form();
64			$fields = $partial->PartialFields()->map('Name', 'Value')->toArray();
65			$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...
66
67			// Copied from {@link UserDefinedFormController}
68			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...
69			$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...
70			if ($hasLocation) {
71			/** @see Requirements_Backend::escapeReplacement */
72			$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...
73			$content = preg_replace(
74			'/(<p[^>]*>)?\\$UserDefinedForm(<\\/p>)?/i',
75			$formEscapedForRegex,
76			$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...
77			);
78
79			return $this->customise([
80			'Content' => DBField::create_field('HTMLText', $content),
81			'Form' => '',
82			'PartialLink' => $partial->getPartialLink()
83			])->renderWith([static::class, Page::class]);
84			}
85			}
86
87			return $this->customise([
88			'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...
89			'Form' => $form,
90			'PartialLink' => $partial->getPartialLink()
91			])->renderWith([static::class, Page::class]);
92			}
93
94			/**
95			* A little abstraction to be more readable
96			*
97			* @param HTTPRequest $request
98			* @return PartialFormSubmission\|void
99			* @throws HTTPResponse_Exception
100			*/
101			public function setData($request)
102			{
103			// Ensure this URL doesn't get picked up by HTTP caches
104			HTTPCacheControlMiddleware::singleton()->disableCache();
105
106			$key = $request->param('Key');
107			$token = $request->param('Token');
108
109			/** @var PartialFormSubmission $partial */
110			$partial = PartialFormSubmission::get()->find('Token', $token);
111			if (!$token \|\|
112			!$partial \|\|
113			!$partial->UserDefinedFormID \|\|
114			!hash_equals($partial->generateKey($token), $key)
115			) {
116			return $this->httpError(404);
117			}
118
119			$session = $this->getRequest()->getSession();
120			// Set the session if the last session has expired
121			if (!$session->get(PartialSubmissionController::SESSION_KEY)) {
122			$session->set(PartialSubmissionController::SESSION_KEY, $partial->ID);
123			}
124
125			$this->setPartialFormSubmission($partial);
126			// Set data record and load the form
127			/** @var UserDefinedForm dataRecord */
128			$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...
129
130			return $partial;
131			}
132
133			/**
134			* @return PartialFormSubmission
135			*/
136			public function getPartialFormSubmission(): PartialFormSubmission
137			{
138			return $this->partialFormSubmission;
139			}
140
141			/**
142			* @param PartialFormSubmission $partialFormSubmission
143			*/
144			public function setPartialFormSubmission(PartialFormSubmission $partialFormSubmission): void
145			{
146			$this->partialFormSubmission = $partialFormSubmission;
147			}
148			}
149

Firesphere / silverstripe-partial-userforms

Pull Request — master (#12)

getPartialFormSubmission() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like