CustomCheckboxSetField.php

<?php
/**
 * Copyright 2014 Openstack Foundation
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/

class CustomCheckboxSetField extends CheckboxSetField {


    /**
     * @return array
     */
    protected function buildOptions(){
        $source = $this->source;
        $values = $this->value;
        $items = [];

        // Get values from the join, if available
        if(is_object($this->form)) {
            $record = $this->form->getRecord();
            if(!$values && $record && $record->hasMethod($this->name)) {
                $funcName = $this->name;
                $join = $record->$funcName();
                if($join) {
                    foreach($join as $joinItem) {
                        $values[] = $joinItem->ID;
                    }
                }
            }
        }

        // Source is not an array
        if(!is_array($source) && !is_a($source, 'SQLMap')) {
            if(is_array($values)) {
                $items = $values;
            } else {
                // Source and values are DataObject sets.
                if($values && is_a($values, 'SS_List')) {
                    foreach($values as $object) {
                        if(is_a($object, 'DataObject')) {
                            $items[] = $object->ID;
                        }
                    }
                } elseif($values && is_string($values)) {
                    $items = explode(',', $values);
                    $items = str_replace('{comma}', ',', $items);
                }
            }
        } else {
            // Sometimes we pass a singluar default value thats ! an array && !SS_List
            if($values instanceof SS_List || is_array($values)) {
                $items = $values;
            } else {
                if($values === null) {
                    $items = array();
                }
                else {
                    $items = explode(',', $values);
                    $items = str_replace('{comma}', ',', $items);
                }
            }
        }

        if(is_array($source)) {
            unset($source['']);
        }

        $odd     = 0;
        $options = [];

        if ($source == null) $source = array();

        if($source) {
            foreach($source as $value => $item) {
                if($item instanceof DataObject) {
                    $value = $item->ID;
                    $title = $item->Title;
                } else {
                    $title = $item;
                }

                $itemID      = $this->ID() . '_' . preg_replace('/[^a-zA-Z0-9]/', '', $value);
                $odd         = ($odd + 1) % 2;
                $extraClass  = $odd ? 'odd' : 'even';
                $extraClass .= ' val' . preg_replace('/[^a-zA-Z0-9\-\_]/', '_', $value);

                $options[] = new ArrayData([
                    'ID'         => $itemID,
                    'Class'      => $extraClass,
                    'Name'       => "{$this->name}[]",
                    'Value'      => $value,
                    'Title'      => $title,
                    'isChecked'  => in_array($value, $items) || in_array($value, $this->defaultItems),
                    'isDisabled' => $this->disabled || in_array($value, $this->disabledItems)
                ]);
            }
        }
        return $options;
    }

    /**
     * @return array
     */
    protected function buildExtraProperties(){
        return ['Options' => new ArrayList($this->buildOptions())];
    }

    public function Field($properties = []) {
        Requirements::css(FRAMEWORK_DIR . '/css/CheckboxSetField.css');
        $properties = array_merge($properties, $this->buildExtraProperties());
        return $this->customise($properties)->renderWith($this->getTemplates());
    }
}