i-lateral / silverstripe-notifications

src/Model/NotificationRule.php

<?php

namespace ilateral\SilverStripe\Notifier\Model;

use SilverStripe\ORM\DataObject;
use SilverStripe\Forms\FieldList;
use ilateral\SilverStripe\Notifier\Model\Notification;
use SilverStripe\Forms\DropdownField;

/**
 * @property string FieldName
 * @property string Value
 * @property bool   WasChanged
 * @property string Summary
 *
 * @method Notification Notification
 */
class NotificationRule extends DataObject
{
    private static $table_name = 'Notifications_NotificationRule';

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

    private static $db = [

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

        'FieldName' => 'Varchar',
        'Value' => 'Varchar',
        'WasChanged' => 'Boolean'
    ];

    private static $has_one = [

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

        'Notification' => Notification::class
    ];

    private static $casting = [

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

        'Summary' => 'Varchar'
    ];

    private static $summary_fields = [

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

        'RuleName',
        'FieldName',
        'Value',
        'WasChanged'
    ];

    private static $field_labels = [

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

        'RuleName' => 'Name',
        'FieldName' => 'Field Name',
        'WasChanged' => 'Was the field changed at all',
        'Value' => 'Value is equal to'
    ];

    public function getRuleName(): string
    {
        return $this->i18n_singular_name();
    }

    /**
     * Attempt to generate a summary of this rule
     *
     * @return string
     */
    public function getSummary(): string
    {
        $results = [$this->FieldName];

        if ($this->WasChanged === true) {
            $results[] = 'Changed';
        } else {
            $results[] = $this->Value;
        }

        return implode(': ', $results);
    }

    /**
     * Get a list of valid field names and their labels
     *
     * @return array
     */
    public function getValidFields(): array
    {
        $fields = [];
        $class = $this->Notification()->BaseClassName;

        if (!empty($class) && class_exists($class)) {
            $obj = singleton($class);

            foreach ($obj::config()->get('db') as $field => $type) {
                $fields[$field] = $obj->fieldLabel($field);
            }
        }

        return $fields;
    }

    public function getCMSFields()
    {
        $self = $this;
        $this->beforeUpdateCMSFields(
            function (FieldList $fields) use ($self) {

The import $self is not used and could be removed.

                $fields->replaceField(
                    'FieldName',
                    DropdownField::create(
                        'FieldName',
                        $this->fieldLabel('FieldName'),
                        $this->getValidFields()
                    )
                );
            }
        );

        return parent::getCMSFields();
    }
}