EmailReminder_NotificationSchedule::getCMSFields() - Code Metrics - Inspection of "MINOR: expanding functionality of CurrentRecords f..." - sunnysideup/silverstripe-email_reminder - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( adb17f...230106 )

unknown
created 2018-04-04 05:38 UTC
EmailReminder_NotificationSchedule::getCMSFields() D

↳ Parent: Project
Complexity

Conditions	10
Paths	96
Size

Total Lines	146
Code Lines	101
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	146
c	0
b	0
f	0
rs	4.8196
cc	10
eloc	101
nc	96
nop	0
How to fix Long Method Complexity

<?php


class EmailReminder_NotificationSchedule extends DataObject
namespace YourVendor;

class YourClass { }
{

    /**
     * @var int
     */
    private static $grace_days = 3;


    /**
     * @var string
     */
    private static $default_data_object = 'Member';


    /**
     * @var string
     */
    private static $default_date_field = '';


    /**
     * @var string
     */
    private static $default_email_field = '';


    /**
     * @var string
     */
    private static $replaceable_record_fields = array('FirstName', 'Surname', 'Email');


    /**
     * @var string
     */
    private static $include_method = 'EmailReminderInclude';


    /**
     * @var string
     */
    private static $exclude_method = 'EmailReminderExclude';


    /**
     * @var string
     */
    private static $mail_out_class = 'EmailReminder_DailyMailOut';


    private static $singular_name = 'Email Reminder Schedule';
    public function i18n_singular_name()
    {
        return self::$singular_name;
    }

    private static $plural_name = 'Email Reminder Schedules';
    public function i18n_plural_name()
    {
        return self::$plural_name;
    }

    private static $db = array(

        'DataObject' => 'Varchar(100)',
        'EmailField' => 'Varchar(100)',
        'DateField' => 'Varchar(100)',
        'Days' => 'Int',
        'RepeatDays' => 'Int',
        'BeforeAfter' => "Enum('before,after,immediately','before')",
        'EmailFrom' => 'Varchar(100)',
        'EmailSubject' => 'Varchar(100)',
        'Content' => 'HTMLText',
        'Disable' => 'Boolean',
        'SendTestTo' => 'Text'
    );


    private static $has_many = array(

        'EmailsSent' => 'EmailReminder_EmailRecord'
    );

    private static $summary_fields = array(

        'EmailSubject',
        'Days'
    );

    private static $field_labels = array(

        'DataObject' => 'Class/Table',
        'Days' => 'Days from Expiry',
        'RepeatDays' => 'Repeat cycle days'
    );

    public function populateDefaults()
    {
        parent::populateDefaults();
        $this->DataObject = $this->Config()->get('default_data_object');
        $this->EmailField = $this->Config()->get('default_email_field');
        $this->DateField = $this->Config()->get('default_date_field');
        $this->Days = 7;
        $this->RepeatDays = 300;
        $this->BeforeAfter = 'before';
        $this->EmailFrom = Config::inst()->get('Email', 'admin_email');
        $this->EmailSubject = 'Your memberships expires in [days] days';
    }

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

        $emailsSentField = $fields->dataFieldByName('EmailsSent');
        $fields->removeFieldFromTab('Root', 'EmailsSent');

        $fields->addFieldToTab(
            'Root.Main',
            CheckboxField::create('Disable')
        );
        $fields->addFieldToTab(
            'Root.Main',
            $dataObjecField = DropdownField::create(
                'DataObject',
                'Table/Class Name',
                $this->dataObjectOptions()
            )
            ->setRightTitle('Type a valid table/class name')
        );
        if ($this->Config()->get('default_data_object')) {
            $fields->replaceField('DataObject', $dataObjecField->performReadonlyTransformation());
        }



        $fields->addFieldToTab(
            'Root.Main',
            $emailFieldField = DropdownField::create(
                'EmailField',
                'Email Field',
                $this->emailFieldOptions()
            )
            ->setRightTitle('Select the field that will contain a valid email address')
            ->setEmptyString('[ Please select ]')
        );
        if ($this->Config()->get('default_email_field')) {
            $fields->replaceField('EmailField', $emailFieldField->performReadonlyTransformation());
        }

        $fields->addFieldToTab(
            'Root.Main',
            $dateFieldField = DropdownField::create(
                'DateField',
                'Date Field',
                $this->dateFieldOptions()
            )
            ->setRightTitle('Select a valid Date field to calculate when reminders should be sent')
            ->setEmptyString('[ Please select ]')
        );
        if ($this->Config()->get('default_date_field')) {
            $fields->replaceField('DateField', $dateFieldField->performReadonlyTransformation());
        }

        $fields->removeFieldsFromTab(
            'Root.Main',
            array('Days', 'BeforeAfter', 'RepeatDays')
        );
        $fields->addFieldsToTab(
            'Root.Main',
            array(
                DropdownField::create('BeforeAfter', 'Before / After Expiration', array('before' => 'before', 'after' => 'after', 'immediately' => 'immediately'))
                    ->setRightTitle('Are the days listed above before or after the actual expiration date.'),
                NumericField::create('Days', 'Days')
                    ->setRightTitle('How many days in advance (before) or in arrears (after) of the expiration date should this email be sent? </br>This field is ignored if set to send immediately.'),
                NumericField::create('RepeatDays', 'Repeat Cycle Days')
                    ->setRightTitle(
                        '
                        Number of days after which the same reminder can be sent to the same email address.
                        <br />We allow an e-mail to be sent to one specific email address for one specific reminder only once.
                        <br />In this field you can indicate for how long we will apply this rule.'
                )
            )
        );
        $fields->addFieldsToTab(
            'Root.EmailContent',
            array(
                TextField::create('EmailFrom', 'Email From Address')
                    ->setRightTitle('The email from address, eg: "My Company &lt;[email protected]&gt;"'),
                $subjectField = TextField::create('EmailSubject', 'Email Subject Line')
                    ->setRightTitle('The subject of the email'),
                $contentField = HTMLEditorField::create('Content', 'Email Content')
                    ->SetRows(20)
            )
        );
        if ($obj = $this->getReplacerObject()) {
            $html = $obj->replaceHelpList($asHTML = true);
            $otherFieldsThatCanBeUsed = $this->getFieldsFromDataObject(array('*'));
            $replaceableFields = $this->Config()->get('replaceable_record_fields');
            if (count($otherFieldsThatCanBeUsed)) {
                $html .= '<h3>You can also use the record fields (not replaced in tests):</h3><ul>';
                foreach ($otherFieldsThatCanBeUsed as $key => $value) {
                    if (in_array($key, $replaceableFields)) {
                        $html .= '<li><strong>$'.$key.'</strong> <span>'.$value.'</span></li>';
                    }
                }
            }
            $html .= '</ul>';
            $subjectField->setRightTitle('for replacement options, please see below ...');
            $contentField->setRightTitle($html);
        }
        $fields->addFieldsToTab(
            'Root.Sent',
            array(
                TextareaField::create('SendTestTo', 'Send test email to ...')
                    ->setRightTitle(
                        '
                        Separate emails by commas, a test email will be sent every time you save this Email Reminder, if you do not want test emails to be sent make sure this field is empty
                        '
                    )
                    ->SetRows(3)
            )
        );
        if ($emailsSentField) {
            $config = $emailsSentField->getConfig();
            $config->removeComponentsByType('GridFieldAddExistingAutocompleter');
            $fields->addFieldToTab(
                'Root.Sent',
                $emailsSentField
            );
        }
        $records = $this->CurrentRecords();
        if ($records) {
            $fields->addFieldsToTab(
                'Root.Review',
                array(
                    GridField::create(
                        'CurrentRecords',
                        'Today we are sending to ...',
                        $records
                    ),
                    LiteralField::create(
                        'SampleSelectStatement',
                        '<h3>Here is a sample statement used to select records:</h3>
                        <pre>'.$this->whereStatementForDays().'</pre>'
                    ),
                    LiteralField::create(
                        'SampleFieldDataForRecords',
                        '<h3>sample of '.$this->DateField.' field values:</h3>
                        <li>'.implode('</li><li>', $this->SampleFieldDataForRecords()).'</li>'
                    )
                )
            );
        }
        return $fields;
    }

    /**
     * @return array
     */
    protected function dataObjectOptions()
    {
        return ClassInfo::subclassesFor("DataObject");
    }

    /**
     * @return array
     */
    protected function emailFieldOptions()
    {
        return $this->getFieldsFromDataObject(array('Varchar', 'Email'));
    }

    /**
     * @return array
     */
    protected function dateFieldOptions()
    {
        return $this->getFieldsFromDataObject(array('Date'));
    }


    /**
     * list of database fields available
     * @param  array $fieldTypeMatchArray - strpos filter
     * @return array
     */
    protected function getFieldsFromDataObject($fieldTypeMatchArray = array())
    {
        $array = array();
        if ($this->hasValidDataObject()) {
            $object = Injector::inst()->get($this->DataObject);
            if ($object) {
                $allOptions = $object->stat('db');
                $fieldLabels = $object->fieldLabels();
                foreach ($allOptions as $fieldName => $fieldType) {
                    foreach ($fieldTypeMatchArray as $matchString) {
                        if ((strpos($fieldType, $matchString) !== false) || $matchString == '*') {
                            if (isset($fieldLabels[$fieldName])) {
                                $label = $fieldLabels[$fieldName];
                            } else {
                                $label = $fieldName;
                            }
                            $array[$fieldName] = $label;
                        }
                    }
                }
            }
        }
        return $array;
    }


    /**
     * Test if valid classname has been set
     * @param null
     * @return Boolean
     */
    public function hasValidDataObject()
    {
        return (! $this->DataObject) || ClassInfo::exists($this->DataObject) ? true : false;
    }

    /**
     * Test if valid fields have been set
     * @param null
     * @return Boolean
     */
    public function hasValidDataObjectFields()
    {
        if (!$this->hasValidDataObject()) {
            return false;
        }
        $emailFieldOptions = $this->emailFieldOptions();
        if (!isset($emailFieldOptions[$this->EmailField])) {
            return false;
        }
        $dateFieldOptions = $this->dateFieldOptions();
        if (!isset($dateFieldOptions[$this->DateField])) {
            return false;
        }
        return true;
    }

    /**
     * @return string
     */
    public function getTitle()
    {
        $niceTitle = '[' . $this->EmailSubject . '] // send ';
        $niceTitle .= ($this->BeforeAfter === 'immediately') ?  $this->BeforeAfter : $this->Days . ' days '.$this->BeforeAfter.' Expiration Date';
        return ($this->hasValidDataObjectFields()) ? $niceTitle : 'uncompleted';
    }

    /**
     * @return boolean
     */
    public function hasValidFields()
    {
        if (!$this->hasValidDataObject()) {
            return false;
        }
        if (!$this->hasValidDataObjectFields()) {
            return false;
        }
        if ($this->EmailFrom && $this->EmailSubject && $this->Content) {
            return true;
        }
        return false;
    }

    /**
     * @return boolean
     */
    public function validate()
    {
        $valid = parent::validate();
        if ($this->exists()) {
            if (! $this->hasValidDataObject()) {
                $valid->error('Please enter valid Tabe/Class name ("' . htmlspecialchars($this->DataObject) .'" does not exist)');
            } elseif (! $this->hasValidDataObjectFields()) {
                $valid->error('Please select valid fields for both Email & Date');
            } elseif (! $this->hasValidFields()) {
                $valid->error('Please fill in all fields.  Make sure not to forget the email details (from who, subject, content)');
            }
        }
        return $valid;
    }

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        if ($this->RepeatDays < ($this->Days * 3)) {
            $this->RepeatDays = ($this->Days * 3);
        }
    }

    public function onAfterWrite()
    {
        parent::onAfterWrite();
        if ($this->SendTestTo) {
            if ($mailOutObject = $this->getMailOutObject()) {
                $mailOutObject->setTestOnly(true);
                $mailOutObject->setVerbose(true);
                $mailOutObject->run(null);
            }
        }
    }

    /**
     *
     * @return null | EmailReminder_ReplacerClassInterface
     */
    public function getReplacerObject()
    {
        if ($mailOutObject = $this->getMailOutObject()) {
            return $mailOutObject->getReplacerObject();
        }
    }

    /**
     *
     * @return null | ScheduledTask
     */
    public function getMailOutObject()
    {
        $mailOutClass = $this->Config()->get('mail_out_class');
        if (class_exists($mailOutClass)) {
            $obj = Injector::inst()->get($mailOutClass);
            if ($obj instanceof BuildTask) {
                return $obj;
            } else {
                user_error($mailOutClass.' needs to be an instance of a Scheduled Task');
            }
        }
    }

    /**
     * @param int $limit
     * @return array
     */
    public function SampleFieldDataForRecords($limit = 200)
    {
        if ($this->hasValidFields()) {
            $className = $this->DataObject;
            $objects = $className::get()->sort('RAND()')
                ->where('"'.$this->DateField.'" IS NOT NULL AND "'.$this->DateField.'" <> \'\' AND "'.$this->DateField.'" <> 0')
                ->limit($limit);
            if ($objects->count()) {
                return array_unique($objects->column($this->DateField));
            } else {
                return array();
            }
        }
    }


    /**
     * @return DataList | null
     */
    public function CurrentRecords()
    {
        if ($this->hasValidFields()) {
            $className = $this->DataObject;

            // Use StartsWith to match Date and DateTime fields
            $records = $className::get()->where($this->whereStatementForDays());
            //sample record
            $firstRecord = $records->first();
            if($firstRecord && $firstRecord->exists())
                //methods
                $includeMethod = $this->Config()->get('include_method');
                $excludeMethod = $this->Config()->get('exclude_method');

                //included method?
                $hasIncludeMethod = false;
                if($record->hasMethod($includeMethod)) {
                    $includedRecords = [0 => 0];
                    $hasIncludeMethod = true;
                }

                //excluded method?
                $hasExcludeMethod = false;
                if($record->hasMethod($excludeMethod)) {
                    $excludedRecords = [0 => 0];
                    $hasExcludeMethod = true;
                }

                //see who is in and out
                if($hasIncludeMethod || $hasExcludeMethod) {
                    foreach($records as $record) {
                        if($hasIncludeMethod) {
                            $in = $record->$includeMethod($this, $records);
                            if($in === true) {
                                $includedRecords[$record->ID] = $record->ID;
                            }
                        }
                        if($hasExcludeMethod) {
                            $out = $record->$excludeMethod($this, $records);
                            if($out === true) {
                                $excludedRecords[$record->ID] = $record->ID;
                            }
                        }
                    }
                }

                //apply inclusions and exclusions
                if($hasIncludeMethod) {
                    $records = $className::get()->filter(['ID' => $includedRecords]);
                }
                if($hasExcludeMethod) {
                    $records = $records->exclude(['ID' => $excludedRecords]);
                }
            }
            return $records;
        }
    }

    /**
     * BeforeAfter = 'after'
     * Days = 3
     * GraceDays = 2
     *  -> minDays = -5 days start of day
     *  -> maxDays = -3 days end of day
     *
     * @return string
     */
    protected function whereStatementForDays()

    {
        if ($this->hasValidFields()) {
            $sign = $this->BeforeAfter == 'before' ? '+' : '-';
            $graceDays = 10; //Config::inst()->get('EmailReminder_NotificationSchedule', 'grace_days');


            if ($sign == '+') {
                $minDays = $sign . ($this->Days - $graceDays) . ' days';
                $maxDays = $sign . $this->Days . ' days';
                $minDate = date('Y-m-d', strtotime($minDays)).' 00:00:00';
                $maxDate = date('Y-m-d', strtotime($maxDays)).' 23:59:59';
            } else {
                $minDays = $sign . ($this->Days) . ' days';
                $maxDays = $sign . $this->Days - $graceDays . ' days';
                //we purposely change these days around here ...
                $minDate = date('Y-m-d', strtotime($maxDays)).' 00:00:00';
                $maxDate = date('Y-m-d', strtotime($minDays)).' 23:59:59';
            }

            return '("'. $this->DateField.'" BETWEEN \''.$minDate.'\' AND \''.$maxDate.'\')';
        }
        return '1 == 2';
    }
}

sunnysideup / silverstripe-email_reminder

Push — master ( adb17f...230106 )

EmailReminder_NotificationSchedule::getCMSFields() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
