PartialUserFormController::partial() - Code Metrics - Inspection of "Create shareable partial link and page" - Firesphere/silverstripe-partial-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#13)

by Lhalaa

created 2019-08-20 09:32 UTC

PartialUserFormController::partial() A

↳ Parent: PartialUserFormController

Complexity

Conditions	4
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	33
rs	9.392
c	0
b	0
f	0
cc	4
nc	3
nop	1

<?php

namespace Firesphere\PartialUserforms\Controllers;

use Firesphere\PartialUserforms\Models\PartialFieldSubmission;
use Firesphere\PartialUserforms\Models\PartialFormSubmission;
use SilverStripe\CMS\Controllers\ContentController;
use SilverStripe\Control\Controller;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\ValidationException;
use SilverStripe\UserForms\Control\UserDefinedFormController;
use SilverStripe\UserForms\Form\UserForm;
use SilverStripe\UserForms\Model\EditableFormField;
use SilverStripe\UserForms\Model\UserDefinedForm;

/**
 * Class \Firesphere\PartialUserforms\Controllers\PartialUserFormController
 *
 */
class PartialUserFormController extends ContentController
{
    /**
     * Session key name
     */
    const SESSION_KEY = 'PartialSubmissionID';

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

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

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

        'savePartialSubmission',
        'partial',
    ];

    /**
     * @param HTTPRequest $request
     * @return int
     * @throws ValidationException
     */
    public function savePartialSubmission(HTTPRequest $request)
    {
        $postVars = $request->postVars();
        $editableField = null;

        // We don't want SecurityID and/or the process Action stored as a thing
        unset($postVars['SecurityID'], $postVars['action_process']);
        $submissionID = $request->getSession()->get(self::SESSION_KEY);

        /** @var PartialFormSubmission $partialSubmission */
        $partialSubmission = PartialFormSubmission::get()->byID($submissionID);

        if (!$submissionID || !$partialSubmission) {
            $partialSubmission = PartialFormSubmission::create();
            $submissionID = $partialSubmission->write();
        }
        $request->getSession()->set(self::SESSION_KEY, $submissionID);
        foreach ($postVars as $field => $value) {
            /** @var EditableFormField $editableField */
            $editableField = $this->createOrUpdateSubmission([
                'Name'            => $field,
                'Value'           => $value,
                'SubmittedFormID' => $submissionID
            ]);
        }

        if ($editableField instanceof EditableFormField && !$partialSubmission->UserDefinedFormID) {
            $partialSubmission->update([
                'UserDefinedFormID'    => $editableField->Parent()->ID,
                'ParentID'             => $editableField->Parent()->ID,
                'ParentClass'          => $editableField->Parent()->ClassName,
                'UserDefinedFormClass' => $editableField->Parent()->ClassName
            ]);
            $partialSubmission->write();
        }

        return $submissionID;
    }

    /**
     * @param $formData
     * @return DataObject|EditableFormField
     * @throws ValidationException
     */
    protected function createOrUpdateSubmission($formData)
    {
        if (is_array($formData['Value'])) {
            $formData['Value'] = implode(', ', $formData['Value']);
        }

        $filter = [
            'Name'            => $formData['Name'],
            'SubmittedFormID' => $formData['SubmittedFormID'],
        ];

        $exists = PartialFieldSubmission::get()->filter($filter)->first();
        // Set the title
        $editableField = EditableFormField::get()->filter(['Name' => $formData['Name']])->first();
        if ($editableField) {
            $formData['Title'] = $editableField->Title;
            $formData['ParentClass'] = $editableField->Parent()->ClassName;
        }
        if (!$exists) {
            $exists = PartialFieldSubmission::create($formData);
            $exists->write();
        } else {
            $exists->update($formData);
            $exists->write();
        }

        // Return the ParentID to link the PartialSubmission to it's proper thingy
        return $editableField;
    }

    /**
     * Partial form
     *
     * @param HTTPRequest $request
     * @return \SilverStripe\ORM\FieldType\DBHTMLText|void
     * @throws \SilverStripe\Control\HTTPResponse_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');

        $partial = PartialFormSubmission::get()->find('Token', $token);
        if (!$partial || !$partial->UserDefinedFormID) {
            return $this->httpError(404);
        }

        if ($partial->generateKey($token) === $key) {

            // TODO: Recognize visitor with the password
            // TODO: Populate form values

            $record = UserDefinedForm::get()->byID($partial->UserDefinedFormID);
            $controller = new UserDefinedFormController($record);
            $controller->init();


            return $this->customise([
                'Title' => $record->Title,
                'Breadcrumbs' => $record->Breadcrumbs(),
                'Content' => $this->obj('Content'),
                'Form' => $controller->Form(),
                'Link' => $partial->getPartialLink()
            ])->renderWith(['PartialUserform', 'Page']);
        } else {
            return $this->httpError(404);
        }
    }
}


1			<?php
2
3			namespace Firesphere\PartialUserforms\Controllers;
4
5			use Firesphere\PartialUserforms\Models\PartialFieldSubmission;
6			use Firesphere\PartialUserforms\Models\PartialFormSubmission;
7			use SilverStripe\CMS\Controllers\ContentController;
8			use SilverStripe\Control\Controller;
9			use SilverStripe\Control\HTTPRequest;
10			use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware;
11			use SilverStripe\ORM\DataObject;
12			use SilverStripe\ORM\ValidationException;
13			use SilverStripe\UserForms\Control\UserDefinedFormController;
14			use SilverStripe\UserForms\Form\UserForm;
15			use SilverStripe\UserForms\Model\EditableFormField;
16			use SilverStripe\UserForms\Model\UserDefinedForm;
17
18			/**
19			* Class \Firesphere\PartialUserforms\Controllers\PartialUserFormController
20			*
21			*/
22			class PartialUserFormController extends ContentController
23			{
24			/**
25			* Session key name
26			*/
27			const SESSION_KEY = 'PartialSubmissionID';
28
29			/**
30			* @var array
31			*/
32			private static $url_handlers = [
			0 ignored issues – show Comprehensibility introduced 2018-05-08 23:26 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...
33			'' => 'savePartialSubmission',
34			'$Key/$Token' => 'partial',
35			];
36
37			/**
38			* @var array
39			*/
40			private static $allowed_actions = [
			0 ignored issues – show Comprehensibility introduced 2018-05-08 23:26 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...
41			'savePartialSubmission',
42			'partial',
43			];
44
45			/**
46			* @param HTTPRequest $request
47			* @return int
48			* @throws ValidationException
49			*/
50			public function savePartialSubmission(HTTPRequest $request)
51			{
52			$postVars = $request->postVars();
53			$editableField = null;
54
55			// We don't want SecurityID and/or the process Action stored as a thing
56			unset($postVars['SecurityID'], $postVars['action_process']);
57			$submissionID = $request->getSession()->get(self::SESSION_KEY);
58
59			/** @var PartialFormSubmission $partialSubmission */
60			$partialSubmission = PartialFormSubmission::get()->byID($submissionID);
61
62			if (!$submissionID \|\| !$partialSubmission) {
63			$partialSubmission = PartialFormSubmission::create();
64			$submissionID = $partialSubmission->write();
65			}
66			$request->getSession()->set(self::SESSION_KEY, $submissionID);
67			foreach ($postVars as $field => $value) {
68			/** @var EditableFormField $editableField */
69			$editableField = $this->createOrUpdateSubmission([
70			'Name' => $field,
71			'Value' => $value,
72			'SubmittedFormID' => $submissionID
73			]);
74			}
75
76			if ($editableField instanceof EditableFormField && !$partialSubmission->UserDefinedFormID) {
77			$partialSubmission->update([
78			'UserDefinedFormID' => $editableField->Parent()->ID,
79			'ParentID' => $editableField->Parent()->ID,
80			'ParentClass' => $editableField->Parent()->ClassName,
81			'UserDefinedFormClass' => $editableField->Parent()->ClassName
82			]);
83			$partialSubmission->write();
84			}
85
86			return $submissionID;
87			}
88
89			/**
90			* @param $formData
91			* @return DataObject\|EditableFormField
92			* @throws ValidationException
93			*/
94			protected function createOrUpdateSubmission($formData)
95			{
96			if (is_array($formData['Value'])) {
97			$formData['Value'] = implode(', ', $formData['Value']);
98			}
99
100			$filter = [
101			'Name' => $formData['Name'],
102			'SubmittedFormID' => $formData['SubmittedFormID'],
103			];
104
105			$exists = PartialFieldSubmission::get()->filter($filter)->first();
106			// Set the title
107			$editableField = EditableFormField::get()->filter(['Name' => $formData['Name']])->first();
108			if ($editableField) {
109			$formData['Title'] = $editableField->Title;
110			$formData['ParentClass'] = $editableField->Parent()->ClassName;
111			}
112			if (!$exists) {
113			$exists = PartialFieldSubmission::create($formData);
114			$exists->write();
115			} else {
116			$exists->update($formData);
117			$exists->write();
118			}
119
120			// Return the ParentID to link the PartialSubmission to it's proper thingy
121			return $editableField;
122			}
123
124			/**
125			* Partial form
126			*
127			* @param HTTPRequest $request
128			* @return \SilverStripe\ORM\FieldType\DBHTMLText\|void
129			* @throws \SilverStripe\Control\HTTPResponse_Exception
130			*/
131			public function partial(HTTPRequest $request)
132			{
133			// Ensure this URL doesn't get picked up by HTTP caches
134			HTTPCacheControlMiddleware::singleton()->disableCache();
135
136			$key = $request->param('Key');
137			$token = $request->param('Token');
138
139			$partial = PartialFormSubmission::get()->find('Token', $token);
140			if (!$partial \|\| !$partial->UserDefinedFormID) {
141			return $this->httpError(404);
142			}
143
144			if ($partial->generateKey($token) === $key) {
145
146			// TODO: Recognize visitor with the password
147			// TODO: Populate form values
148
149			$record = UserDefinedForm::get()->byID($partial->UserDefinedFormID);
150			$controller = new UserDefinedFormController($record);
151			$controller->init();
			0 ignored issues – show Bug introduced 2019-08-20 09:24 UTC by Report Bug Copy Issue Report The method `init()` cannot be called from this context as it is declared protected in class `SilverStripe\UserForms\C...erDefinedFormController`. This check looks for access to methods that are not accessible from the current context. If you need to make a method accessible to another context you can raise its visibility level in the defining class. Loading history...
152
153			return $this->customise([
154			'Title' => $record->Title,
155			'Breadcrumbs' => $record->Breadcrumbs(),
156			'Content' => $this->obj('Content'),
157			'Form' => $controller->Form(),
158			'Link' => $partial->getPartialLink()
159			])->renderWith(['PartialUserform', 'Page']);
160			} else {
161			return $this->httpError(404);
162			}
163			}
164			}
165

Firesphere / silverstripe-partial-userforms

Pull Request — master (#13)

PartialUserFormController::partial() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like