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-21 05:15 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	35
rs	9.36
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\HTTPRequest;
use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\ValidationException;
use SilverStripe\UserForms\Control\UserDefinedFormController;
use SilverStripe\UserForms\Model\EditableFormField;
use SilverStripe\View\Requirements;

/**
 * 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 = DataObject::get_by_id($partial->UserDefinedFormClass, $partial->UserDefinedFormID);
            $controller = new UserDefinedFormController($record);
            $controller->init();


            Requirements::javascript('firesphere/partialuserforms:client/dist/main.js');

            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\HTTPRequest;
9			use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware;
10			use SilverStripe\ORM\DataObject;
11			use SilverStripe\ORM\ValidationException;
12			use SilverStripe\UserForms\Control\UserDefinedFormController;
13			use SilverStripe\UserForms\Model\EditableFormField;
14			use SilverStripe\View\Requirements;
15
16			/**
17			* Class \Firesphere\PartialUserforms\Controllers\PartialUserFormController
18			*
19			*/
20			class PartialUserFormController extends ContentController
21			{
22			/**
23			* Session key name
24			*/
25			const SESSION_KEY = 'PartialSubmissionID';
26
27			/**
28			* @var array
29			*/
30			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...
31			'' => 'savePartialSubmission',
32			'$Key/$Token' => 'partial',
33			];
34
35			/**
36			* @var array
37			*/
38			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...
39			'savePartialSubmission',
40			'partial',
41			];
42
43			/**
44			* @param HTTPRequest $request
45			* @return int
46			* @throws ValidationException
47			*/
48			public function savePartialSubmission(HTTPRequest $request)
49			{
50			$postVars = $request->postVars();
51			$editableField = null;
52
53			// We don't want SecurityID and/or the process Action stored as a thing
54			unset($postVars['SecurityID'], $postVars['action_process']);
55			$submissionID = $request->getSession()->get(self::SESSION_KEY);
56
57			/** @var PartialFormSubmission $partialSubmission */
58			$partialSubmission = PartialFormSubmission::get()->byID($submissionID);
59
60			if (!$submissionID \|\| !$partialSubmission) {
61			$partialSubmission = PartialFormSubmission::create();
62			$submissionID = $partialSubmission->write();
63			}
64			$request->getSession()->set(self::SESSION_KEY, $submissionID);
65			foreach ($postVars as $field => $value) {
66			/** @var EditableFormField $editableField */
67			$editableField = $this->createOrUpdateSubmission([
68			'Name' => $field,
69			'Value' => $value,
70			'SubmittedFormID' => $submissionID
71			]);
72			}
73
74			if ($editableField instanceof EditableFormField && !$partialSubmission->UserDefinedFormID) {
75			$partialSubmission->update([
76			'UserDefinedFormID' => $editableField->Parent()->ID,
77			'ParentID' => $editableField->Parent()->ID,
78			'ParentClass' => $editableField->Parent()->ClassName,
79			'UserDefinedFormClass' => $editableField->Parent()->ClassName
80			]);
81			$partialSubmission->write();
82			}
83
84			return $submissionID;
85			}
86
87			/**
88			* @param $formData
89			* @return DataObject\|EditableFormField
90			* @throws ValidationException
91			*/
92			protected function createOrUpdateSubmission($formData)
93			{
94			if (is_array($formData['Value'])) {
95			$formData['Value'] = implode(', ', $formData['Value']);
96			}
97
98			$filter = [
99			'Name' => $formData['Name'],
100			'SubmittedFormID' => $formData['SubmittedFormID'],
101			];
102
103			$exists = PartialFieldSubmission::get()->filter($filter)->first();
104			// Set the title
105			$editableField = EditableFormField::get()->filter(['Name' => $formData['Name']])->first();
106			if ($editableField) {
107			$formData['Title'] = $editableField->Title;
108			$formData['ParentClass'] = $editableField->Parent()->ClassName;
109			}
110			if (!$exists) {
111			$exists = PartialFieldSubmission::create($formData);
112			$exists->write();
113			} else {
114			$exists->update($formData);
115			$exists->write();
116			}
117
118			// Return the ParentID to link the PartialSubmission to it's proper thingy
119			return $editableField;
120			}
121
122			/**
123			* Partial form
124			*
125			* @param HTTPRequest $request
126			* @return \SilverStripe\ORM\FieldType\DBHTMLText\|void
127			* @throws \SilverStripe\Control\HTTPResponse_Exception
128			*/
129			public function partial(HTTPRequest $request)
130			{
131			// Ensure this URL doesn't get picked up by HTTP caches
132			HTTPCacheControlMiddleware::singleton()->disableCache();
133
134			$key = $request->param('Key');
135			$token = $request->param('Token');
136
137			$partial = PartialFormSubmission::get()->find('Token', $token);
138			if (!$partial \|\| !$partial->UserDefinedFormID) {
139			return $this->httpError(404);
140			}
141
142			if ($partial->generateKey($token) === $key) {
143
144			// TODO: Recognize visitor with the password
145			// TODO: Populate form values
146
147			$record = DataObject::get_by_id($partial->UserDefinedFormClass, $partial->UserDefinedFormID);
148			$controller = new UserDefinedFormController($record);
149			$controller->init();
			0 ignored issues – show Bug introduced 2019-08-21 04:51 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...
150
151			Requirements::javascript('firesphere/partialuserforms:client/dist/main.js');
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