Broarm\EventTickets\AttendeeExtraField

Complexity

Total Complexity

22

Size/Duplication

Total Lines	207
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	14

Importance

Changes	1
Bugs	0	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
B	getCMSFields()	0	39	4
A	singular_name()	0	5	1
A	onBeforeWrite()	0	8	2
A	getValue()	0	11	4
A	createFromConfig()	0	17	3
B	createField()	0	25	4
A	canView()	0	4	1
A	canEdit()	0	4	1
A	canDelete()	0	4	1
A	canCreate()	0	4	1

<?php
/**
 * AttendeeExtraField.php
 *
 * @author Bram de Leeuw
 * Date: 24/05/17
 */

namespace Broarm\EventTickets;

use CheckboxField;
use Convert;
use DataObject;
use DropdownField;
use FieldList;
use FormField;
use GridField;
use LiteralField;
use OptionsetField;
use ReadonlyField;
use Tab;
use TabSet;
use TextField;

/**
 * Class AttendeeExtraField
 *
 * @property string    Title
 * @property string    FieldName
 * @property FormField FieldType
 * @property string    DefaultValue
 * @property string    ExtraClass
 * @property boolean   Required
 * @property boolean   Editable
 *
 * @method \CalendarEvent Event()
 * @method \HasManyList Options()
 */
class AttendeeExtraField extends DataObject
{
    /**
     * Field name to be used in the AttendeeField (Composite field)
     * @var string
     */
    protected $fieldName;

    private static $db = array(

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

The property $db is not used and could be removed.

        'Title' => 'Varchar(255)',
        'DefaultValue' => 'Varchar(255)',
        'ExtraClass' => 'Varchar(255)',
        'FieldName' => 'Varchar(255)',
        'Required' => 'Boolean',
        'Editable' => 'Boolean',
        'FieldType' => 'Enum("TextField,EmailField,CheckboxField,OptionsetField","TextField")',
        'Sort' => 'Int'
    );

    private static $defaults = array(

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

The property $defaults is not used and could be removed.

        'Editable' => 1
    );

    private static $default_sort = 'Sort ASC';

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

The property $default_sort is not used and could be removed.

    private static $has_one = array(

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

The property $has_one is not used and could be removed.

        'Event' => 'CalendarEvent'
    );

    private static $has_many = array(

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

The property $has_many is not used and could be removed.

        'Options' => 'Broarm\EventTickets\AttendeeExtraFieldOption'
    );

    private static $belongs_many_many = array(

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

The property $belongs_many_many is not used and could be removed.

        'Attendees' => 'Broarm\EventTickets\Attendee'
    );

    private static $summary_fields = array(

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

The property $summary_fields is not used and could be removed.

        'Title' => 'Title',
        'FieldType' => 'FieldType',
        'Required.Nice' => 'Required'
    );

    private static $translate = array(

The property $translate is not used and could be removed.

        'Title'
    );

    public function getCMSFields()

The return type could not be reliably inferred; please add a @return annotation.

    {
        $fields = new FieldList(new TabSet('Root', $mainTab = new Tab('Main')));

        $fields->addFieldsToTab('Root.Main', array(
            $fieldType = DropdownField::create(
                'FieldType',
                _t('AttendeeExtraField.FieldType', 'Type of field'),
                $this->dbObject('FieldType')->enumValues()
            ),
            TextField::create('Title', _t('AttendeeExtraField.Title', 'Field label or question')),
            TextField::create('ExtraClass', _t('AttendeeExtraField.ExtraClass', 'Add an extra class to the field')),
            $required = CheckboxField::create('Required', _t('AttendeeExtraField.Required', 'This field is required'))
        ));

        if ($this->exists()) {
            if ($this->FieldType !== 'OptionsetField') {
                $fields->addFieldToTab('Root.Main', TextField::create(
                    'DefaultValue',
                    _t('AttendeeExtraField.DefaultValue', 'Set a default value'))
                );
            } else {
                $fields->addFieldToTab('Root.Main', GridField::create(
                    'Options',
                    _t('AttendeeExtraField.Options', 'Add field options'),
                    $this->Options(),
                    GridFieldConfig_Fields::create()
                ));
            }
        }

        if (!$this->Editable) {
            $fieldType->setDisabled(true);
            $required->setDisabled(true);
        }

        $this->extend('updateCMSFields', $fields);
        return $fields;
    }

    /**
     * Returns the singular name without the namespaces
     *
     * @return string
     */
    public function singular_name()
    {
        $name = explode('\\', parent::singular_name());
        return trim(end($name));
    }

    /**
     * Set the Field name based on the title and ID
     */
    public function onBeforeWrite()
    {
        if (empty($this->FieldName)) {
            $this->FieldName = Convert::raw2url($this->Title);
        }

        parent::onBeforeWrite();
    }

    /**
     * Get the value casted based on chosen field type
     *
     * @return mixed|string
     */
    public function getValue()
    {
        switch ($this->FieldType) {
            case 'OptionsetField':
                return $this->Options()->byID($this->getField('Value'))->Title;
            case 'CheckboxField':
                return (bool)$this->getField('Value') ? _t('Boolean.YESANSWER', 'Yes') : _t('Boolean.NOANSWER', 'No');
            default:
                return $this->getField('Value');
        }
    }

    /**
     * Create a field from given configuration
     *
     * @param $fieldName
     * @param $fieldConfig
     *
     * @return AttendeeExtraField|DataObject
     */
    public static function createFromConfig($fieldName, $fieldConfig) {
        $field = AttendeeExtraField::create();
        $field->Title = _t("AttendeeField.$fieldName", $fieldName);
        $field->FieldName = $fieldName;
        $field->Required = true;
        $field->Editable = false;

        if (is_array($fieldConfig)) {
            foreach ($fieldConfig as $property => $value) {
                $field->setField($property, $value);
            }
        } else {
            $field->FieldType = $fieldConfig;
        }

        return $field;
    }

    /**
     * Create the configured field
     *
     * @param $fieldName
     * @param $defaultValue
     *
     * @return \FormField
     */
    public function createField($fieldName, $defaultValue = null)
    {
        $fieldType = $this->FieldType;
        $field = $fieldType::create($this->fieldName = $fieldName, $this->Title);

        // Set a default value if set
        $field->setValue($defaultValue ? $defaultValue : $this->DefaultValue);

        // Add any extra classes
        $field->addExtraClass($this->ExtraClass);

        // Check if the field is an option set
        if ($field instanceof OptionsetField) {
            /** @var OptionsetField $field */
            $options = $this->Options()->map('ID', 'Title')->toArray();
            $field->setSource($options);

            // If a field is selected as default set that value
            if ($defaultValue = $this->Options()->find('Default', 1)) {
                $field->setValue($defaultValue->ID);
            }
        }

        return $field;
    }

    public function canView($member = null)

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->Event()->canView($member);
    }

    public function canEdit($member = null)

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->Event()->canEdit($member);
    }

    public function canDelete($member = null)
    {
        return $this->Editable;
    }

    public function canCreate($member = null)

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->Event()->canCreate($member);
    }
}