LeKoala\SparkPost\SparkPostAdmin::getEditForm()

Complexity

Conditions	21
Paths	10922

Size

Total Lines	214
Code Lines	131

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	1

<?php
    public function getEditForm($id = null, $fields = null)
    {
        if (!$id) {
            $id = $this->currentPageID();

The function SilverStripe\Admin\LeftAndMain::currentPageID() has been deprecated: 5.4.0 use currentRecordID() instead.

        }

        /** @var DataObject|null $record */
        $record = $this->getRecord($id);

        // Check if this record is viewable
        if ($record && !$record->canView()) {
            $response = Security::permissionFailure($this);
            $this->setResponse($response);
            return null;
        }

        // Build gridfield
        $messageListConfig = GridFieldConfig::create()->addComponents(
            new GridFieldSortableHeader(),
            new GridFieldDataColumns(),
            new GridFieldFooter()
        );

        $messages = $this->Messages();
        if (is_string($messages)) {
            // The api returned an error
            $messagesList = new LiteralField("MessageAlert", $this->MessageHelper($messages, 'bad'));
        } else {
            $messagesList = GridField::create(
                'Messages',
                false,
                $messages,
                $messageListConfig
            )->addExtraClass("messages_grid");

            /** @var GridFieldDataColumns $columns  */
            $columns = $messageListConfig->getComponentByType(GridFieldDataColumns::class);
            $columns->setDisplayFields([
                'transmission_id' => _t('SparkPostAdmin.EventTransmissionId', 'Id'),
                'timestamp' => _t('SparkPostAdmin.EventDate', 'Date'),
                'type' => _t('SparkPostAdmin.EventType', 'Type'),
                'rcpt_to' => _t('SparkPostAdmin.EventRecipient', 'Recipient'),
                'subject' => _t('SparkPostAdmin.EventSubject', 'Subject'),
                'friendly_from' => _t('SparkPostAdmin.EventSender', 'Sender'),
            ]);

            $columns->setFieldFormatting([
                'timestamp' => function ($value, &$item) {
                    return date('Y-m-d H:i:s', strtotime($value));
                },
            ]);

            // Validator setup
            $validator = null;
            if ($record && method_exists($record, 'getValidator')) {
                $validator = $record->getValidator();
            }

            if ($validator) {
                /** @var GridFieldDetailForm|null $detailForm  */
                $detailForm = $messageListConfig->getComponentByType(GridFieldDetailForm::class);
                if ($detailForm) {
                    $detailForm->setValidator($validator);
                }
            }
        }

        // Create tabs
        $messagesTab = new Tab(
            'Messages',
            _t('SparkPostAdmin.Messages', 'Messages'),
            $this->SearchFields(),
            $messagesList,
            // necessary for tree node selection in LeftAndMain.EditForm.js
            new HiddenField('ID', null, 0)
        );

        $fields = new FieldList([
            $root = new TabSet('Root', $messagesTab)
        ]);

        $suppressionsTab = new Tab('Suppressions', _t('SparkPostAdmin.Suppressions', 'Suppressions'));

        // Show the summary
        $summary = $this->getCachedData('suppressionSummary');
        if ($summary) {
            $callback = function ($k, $v) {
                return ArrayData::create([
                    'Title' => $k,
                    'Value' => $v,
                ]);
            };
            $summaryArray = array_map($callback, array_keys($summary), array_values($summary));
            $summaryGrid = GridField::create(
                'SuppressionSummary',
                _t('SparkPostAdmin.Suppressionsummary', 'Suppression summary'),
                new ArrayList($summaryArray)

The class SilverStripe\ORM\ArrayList has been deprecated: 5.4.0 Will be renamed to SilverStripe\Model\List\ArrayList

            );
            //@link https://docs.silverstripe.org/en/5/developer_guides/forms/using_gridfield_with_arbitrary_data/
            $summaryGrid->getConfig()->removeComponentsByType(GridFieldFilterHeader::class);
            /** @var GridFieldDataColumns $columns */
            $columns = $summaryGrid->getConfig()->getComponentByType(GridFieldDataColumns::class);
            $columns->setDisplayFields([
                'Title' => _t('SparkPostAdmin.Title', 'Title'),
                'Value' => _t('SparkPostAdmin.Value', 'Value'),
            ]);
            $suppressionsTab->push($summaryGrid);
        }


        // Show recent suppressions
        $client = SparkPostHelper::getClient();
        $suppressions = $this->getCachedData('searchSuppressions', [
            'from' => $client->createValidDatetime('-90 days')
        ]);
        if ($suppressions) {
            $suppressionGrid = GridField::create(
                'RecentSuppressions',
                _t('SparkPostAdmin.RecentSuppressions', 'Recent suppressions'),
                new ArrayList(array_map(function ($item) {

The class SilverStripe\ORM\ArrayList has been deprecated: 5.4.0 Will be renamed to SilverStripe\Model\List\ArrayList

                    return ArrayData::create($item);
                }, $suppressions))
            );
            //@link https://docs.silverstripe.org/en/5/developer_guides/forms/using_gridfield_with_arbitrary_data/
            $suppressionGrid->getConfig()->removeComponentsByType(GridFieldFilterHeader::class);
            /** @var GridFieldDataColumns $columns */
            $columns = $suppressionGrid->getConfig()->getComponentByType(GridFieldDataColumns::class);
            $columns->setDisplayFields([
                'recipient' => _t('SparkPostAdmin.Recipient', 'Recipient'),
                'type' => _t('SparkPostAdmin.Type', 'Type'),
                'source' => _t('SparkPostAdmin.Source', 'Source'),
                'description' => _t('SparkPostAdmin.Description', 'Description'),
                'created' => _t('SparkPostAdmin.Created', 'Created'),
                // 'updated' => _t('SparkPostAdmin.Updated', 'Updated'),
            ]);
            $suppressionsTab->push($suppressionGrid);
        }

        $fields->addFieldToTab('Root', $suppressionsTab);

        $settingsTab = new Tab('Settings', _t('SparkPostAdmin.Settings', 'Settings'));
        if ($this->CanConfigureApi()) {
            $domainTabData = $this->DomainTab();
            $settingsTab->push($domainTabData);

            // Show webhook options if not using a subaccount key
            if (!SparkPostHelper::getSubaccountId() && self::config()->show_webhook_tab) {
                $webhookTabData = $this->WebhookTab();
                $settingsTab->push($webhookTabData);
            }

            $toolsHtml = '<h2>Tools</h2>';

            // Show default from email
            $defaultEmail = SparkPostHelper::resolveDefaultFromEmail();
            $defaultEmailDisplayed = EmailUtils::stringify($defaultEmail);
            $toolsHtml .= "<p>Default sending email: " . Convert::raw2xml($defaultEmailDisplayed) . " (" . SparkPostHelper::resolveDefaultFromEmailType() . ")</p>";
            if (!SparkPostHelper::isEmailDomainReady($defaultEmailDisplayed)) {
                $toolsHtml .= '<p style="color:red">The default email is not ready to send emails</p>';
            }

            // Show constants
            if (SparkPostHelper::getEnvSendingDisabled()) {
                $toolsHtml .= '<p style="color:red">Sending is disabled by .env configuration</p>';
            }
            if (SparkPostHelper::getEnvEnableLogging()) {
                $toolsHtml .= '<p style="color:orange">Logging is enabled by .env configuration</p>';
            }
            if (SparkPostHelper::getSubaccountId()) {
                $toolsHtml .= '<p style="color:orange">Using subaccount id</p>';
            }
            if (SparkPostHelper::getEnvForceSender()) {
                $toolsHtml .= '<p style="color:orange">Sender is forced to ' . SparkPostHelper::getEnvForceSender() . '</p>';
            }

            // Add a refresh button
            $toolsHtml .= $this->ButtonHelper(
                $this->Link() . '?refresh=true',
                _t('SparkPostAdmin.REFRESH', 'Force data refresh from the API')
            );

            $toolsHtml = $this->FormGroupHelper($toolsHtml);
            $Tools = new LiteralField('Tools', $toolsHtml);
            $settingsTab->push($Tools);

            $fields->addFieldToTab('Root', $settingsTab);
        }

        // Tab nav in CMS is rendered through separate template
        $root->setTemplate('SilverStripe\\Forms\\CMSTabSet');

        // Manage tabs state
        $actionParam = $this->getRequest()->param('Action');
        if ($actionParam == 'setting') {
            $settingsTab->addExtraClass('ui-state-active');
        } elseif ($actionParam == 'messages') {
            $messagesTab->addExtraClass('ui-state-active');
        }

        // Build replacement form
        $form = Form::create(
            $this,
            'EditForm',
            $fields,
            new FieldList()
        )->setHTMLID('Form_EditForm');
        $form->addExtraClass('cms-edit-form fill-height');
        $form->setTemplate($this->getTemplatesWithSuffix('_EditForm'));
        $form->addExtraClass('ss-tabset cms-tabset ' . $this->BaseCSSClasses());
        $form->setAttribute('data-pjax-fragment', 'CurrentForm');

        $this->extend('updateEditForm', $form);

        return $form;
    }