silverstripe / silverstripe-userforms

code/Model/EditableFormField/EditableCheckboxGroupField.php

<?php

namespace SilverStripe\UserForms\Model\EditableFormField;

use SilverStripe\UserForms\FormField\UserFormsCheckboxSetField;
use SilverStripe\UserForms\Model\EditableCustomRule;

/**
 * EditableCheckboxGroup
 *
 * Represents a set of selectable radio buttons
 *
 * @package userforms
 */

class EditableCheckboxGroupField extends EditableMultipleOptionField
{
    private static $singular_name = 'Checkbox Group';

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

    private static $plural_name = 'Checkbox Groups';

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

    protected $jsEventHandler = 'click';

    private static $table_name = 'EditableCheckboxGroupField';

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

    public function getFormField()
    {
        $field = UserFormsCheckboxSetField::create($this->Name, $this->EscapedTitle, $this->getOptionsMap())

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

$this->Name of type string is incompatible with the type array expected by parameter $args of SilverStripe\View\ViewableData::create().

            ->setFieldHolderTemplate(EditableMultipleOptionField::class . '_holder')
            ->setTemplate(UserFormsCheckboxSetField::class);

        // Set the default checked items
        $defaultCheckedItems = $this->getDefaultOptions();
        if ($defaultCheckedItems->count()) {
            $field->setDefaultItems($defaultCheckedItems->map('Value')->keys());
        }

        $this->doUpdateFormField($field);
        return $field;
    }

    public function getValueFromData($data)
    {
        $result = '';
        $entries = (isset($data[$this->Name])) ? $data[$this->Name] : false;

        if ($entries) {
            if (!is_array($data[$this->Name])) {
                $entries = [$data[$this->Name]];
            }
            foreach ($entries as $selected => $value) {
                if (!$result) {
                    $result = $value;
                } else {
                    $result .= ', ' . $value;
                }
            }
        }
        return $result;
    }

    public function getSelectorField(EditableCustomRule $rule, $forOnLoad = false)
    {
        // watch out for checkboxs as the inputs don't have values but are 'checked
        // @todo - Test this
        if ($rule->FieldValue) {
            return "$(\"input[name='{$this->Name}[]'][value='{$rule->FieldValue}']\")";
        } else {
            return "$(\"input[name='{$this->Name}[]']:first\")";
        }
    }

    public function isCheckBoxField()
    {
        return true;
    }

    public function getSelectorFieldOnly()
    {
        return "[name='{$this->Name}[]']";
    }

    public function isCheckBoxGroupField()
    {
        return true;
    }
}