Firesphere\PartialUserforms\Controllers\PartialUserFormController

Complexity

Total Complexity

15

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	11

Test Coverage

Coverage

88.24%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
C	partial()	0	61	12
A	populateFileData()	0	21	3

<?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\Forms\Form;
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 = [

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',
    ];

    /**
     * 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 or from another submission
        $session = $request->getSession()->get(PartialSubmissionController::SESSION_KEY);
        if (!$session || $session !==  $partial->ID) {
            $request->getSession()->set(PartialSubmissionController::SESSION_KEY, $partial->ID);
        }

        // Set data record and load the form
        $record = 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.

        $controller = parent::create($record);

It seems like you call parent on a different method (create() instead of partial()). Are you sure this is correct? If so, you might want to change this to $this->create().

        $controller->doInit();

        $form = $controller->Form();
        $form->loadDataFrom($partial->getFields());

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

        $this->populateFileData($form, $partial);

$form is of type object<Firesphere\PartialUserforms\Controllers\PartialUserFormController>, but the function expects a object<SilverStripe\Forms\Form>.

        // Copied from {@link UserDefinedFormController}
        if ($controller->Content && $form && !$controller->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($controller->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,
                    $controller->Content

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

                );

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

        return $controller->customise([
            'Content'     => DBField::create_field('HTMLText', $controller->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]);
    }

    /**
     * Set the uploaded filenames as right title of the file fields
     *
     * @param Form $form
     * @param PartialFormSubmission $partialSubmission
     */
    protected function populateFileData($form, $partialSubmission)
    {
        $uploads = $partialSubmission->PartialUploads()->filter([
            'UploadedFileID:not'=> null
        ]);

        if (!$uploads->exists()) {
            return;
        }

        $fields = $form->Fields();
        foreach ($uploads as $upload) {
            $fields->dataFieldByName($upload->Name)
                ->setRightTitle(
                    sprintf(
                        'Uploaded: %s (Attach a new file to replace the uploaded file)',
                        $upload->UploadedFile()->Name
                    )
                );
        }
    }
}