Firesphere\PartialUserforms\Controllers\PartialUserFormController

Complexity

Total Complexity

15

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	setData()	0	31	6
B	partial()	0	42	7
A	getPartialFormSubmission()	0	4	1
A	setPartialFormSubmission()	0	4	1

<?php

namespace Firesphere\PartialUserforms\Controllers;

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 PartialFormSubmission
     */
    protected $partialFormSubmission;
    /**
     * @var array
     */
    private static $url_handlers = [

Consider using a different property name as you override a private property of the parent class.

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

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

Consider using a different property name as you override a private property of the parent class.

        'partial',
    ];

    /**
     * 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);

The property UserDefinedFormClass does not exist on object<Firesphere\PartialUserforms\Models\PartialFormSubmission>. Since you implemented __get, maybe consider adding a @property annotation.

It seems like \SilverStripe\ORM\DataObject::get_by_id($partial->UserDefinedFormClass, $partial->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?

        return $partial;
    }

    /**
     * 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);

The method loadDataFrom does not exist on object<Firesphere\PartialUserforms\Controllers\PartialUserFormController>? Since you implemented __call, maybe consider adding a @method annotation.

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

The property Content does not exist on object<Firesphere\PartialUserforms\Controllers\PartialUserFormController>. Since you implemented __get, maybe consider adding a @property annotation.

            $hasLocation = stristr($this->Content, '$UserDefinedForm');

The property Content does not exist on object<Firesphere\PartialUserforms\Controllers\PartialUserFormController>. Since you implemented __get, maybe consider adding a @property annotation.

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

The method forTemplate does not exist on object<Firesphere\PartialUserforms\Controllers\PartialUserFormController>? Since you implemented __call, maybe consider adding a @method annotation.

                $content = preg_replace(
                    '/(<p[^>]*>)?\\$UserDefinedForm(<\\/p>)?/i',
                    $formEscapedForRegex,
                    $this->Content

The property Content does not exist on object<Firesphere\PartialUserforms\Controllers\PartialUserFormController>. Since you implemented __get, maybe consider adding a @property annotation.

                );

                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),

The property Content does not exist on object<Firesphere\PartialUserforms\Controllers\PartialUserFormController>. Since you implemented __get, maybe consider adding a @property annotation.

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

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

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