SilverStripe\UserForms\Model\EditableFormField\EditableFormStep

Complexity

Total Complexity

10

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	showInReports()	0	3	1
A	getInlineClassnameField()	0	3	1
A	getSelectorHolder()	0	3	1
A	getFormField()	0	7	1
A	getCMSTitle()	0	10	3
A	getCMSFields()	0	7	1
A	updateFormField()	0	5	2

<?php

namespace SilverStripe\UserForms\Model\EditableFormField;

use SilverStripe\Forms\LabelField;
use SilverStripe\UserForms\FormField\UserFormsStepField;
use SilverStripe\UserForms\Model\EditableFormField;

/**
 * A step in multi-page user form
 *
 * @package userforms
 */
class EditableFormStep extends EditableFormField
{
    private static $singular_name = 'Page Break';

The private property $singular_name is not used, and could be removed.

    private static $plural_name = 'Page Breaks';

The private property $plural_name is not used, and could be removed.

    /**
     * Disable selection of step class
     *
     * @config
     * @var bool
     */
    private static $hidden = true;

The private property $hidden is not used, and could be removed.

    private static $table_name = 'EditableFormStep';

The private property $table_name is not used, and could be removed.

    /**
     * @return FieldList

The type SilverStripe\UserForms\Model\EditableFormField\FieldList was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $fields->removeByName(['MergeField', 'Default', 'Validation', 'RightTitle']);

        return $fields;

The expression return $fields returns the type SilverStripe\Forms\FieldList which is incompatible with the documented return type SilverStripe\UserForms\Model\EditableFormField\FieldList.

    }

    /**
     * @return FormField

The type SilverStripe\UserForms\Model\EditableFormField\FormField was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getFormField()
    {
        $field = UserFormsStepField::create()
            ->setName($this->Name)
            ->setTitle($this->Title);
        $this->doUpdateFormField($field);
        return $field;
    }

    protected function updateFormField($field)
    {
        // if this field has an extra class
        if ($this->ExtraClass) {

The property ExtraClass does not exist on SilverStripe\UserForms\Model\EditableFormField\EditableFormStep. Since you implemented __get, consider adding a @property annotation.

            $field->addExtraClass($this->ExtraClass);
        }
    }

    /**
     * @return boolean
     */
    public function showInReports()
    {
        return false;
    }

    public function getInlineClassnameField($column, $fieldClasses)
    {
        return LabelField::create($column, $this->CMSTitle);

The property CMSTitle does not exist on SilverStripe\UserForms\Model\EditableFormField\EditableFormStep. Since you implemented __get, consider adding a @property annotation.

    }

    public function getCMSTitle()
    {
        $title = $this->getFieldNumber()
            ?: $this->Title
            ?: '';

        return _t(
            __CLASS__.'.STEP_TITLE',
            'Page {page}',
            ['page' => $title]
        );
    }

    /**
     * Get the JS expression for selecting the holder for this field
     *
     * @return string
     */
    public function getSelectorHolder()
    {
        return "$(\".step-button-wrapper[data-for='{$this->Name}']\")";
    }
}