Skip to content

Commit

Permalink
Merge pull request #16 from bigfork/admin-improvements
Browse files Browse the repository at this point in the history 
Break out getEditForm into individual methods with extension points
  • Loading branch information
@k-coidan
k-coidan authored Jan 30, 2023
2 parents 3e01070 + 79e4d59 commit 9da789e
Showing 1 changed file with 90 additions and 77 deletions.
167 changes: 90 additions & 77 deletions src/Admin/FormCaptureAdmin.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldConfig;
use SilverStripe\Forms\GridField\GridFieldExportButton;
use SilverStripe\Forms\GridField\GridFieldFilterHeader;
use SilverStripe\Forms\GridField\GridFieldImportButton;
Expand All @@ -21,7 +22,6 @@
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\Filters\GreaterThanOrEqualFilter;
use SilverStripe\ORM\Filters\LessThanOrEqualFilter;
use SilverStripe\ORM\Filters\PartialMatchFilter;
use SilverStripe\ORM\Queries\SQLSelect;
use SilverStripe\ORM\Search\SearchContext;

Expand All @@ -37,82 +37,95 @@ class FormCaptureAdmin extends ModelAdmin

private static $menu_icon_class = 'font-icon-checklist';

public function getEditForm($id = null, $fields = null)
{
$form = parent::getEditForm();

/** @var GridField $gridField */
$gridField = $form->Fields()->dataFieldByName($this->sanitiseClassName($this->modelClass));
$gridField->setName('Submissions');

$config = $gridField->getConfig();
$config->removeComponentsByType(GridFieldImportButton::class);
$config->removeComponentsByType(GridFieldPrintButton::class);

// Configure filtering options
$updateSearchContext = function(SearchContext $context) {
$filters = $context->getFilters();
$filters['Name'] = HavingPartialMatchFilter::create('NameWithFallback');
$filters['Email'] = HavingPartialMatchFilter::create('EmailWithFallback');
$filters['MinDate'] = GreaterThanOrEqualFilter::create('Created');
$filters['MaxDate'] = LessThanOrEqualFilter::create('Created');
$context->setFilters($filters);
};

$updateSearchForm = function(Form $form) {
$form->Fields()->insertBefore('Search__Type', $name = TextField::create('Name', 'Name'));
$form->Fields()->insertBefore('Search__Type', $email = TextField::create('Email', 'Email'));

// Replace free-text with dropdown of available submission types
$types = ArrayLib::valuekey(CapturedFormSubmission::get()->columnUnique('Type'));
$typeField = DropdownField::create('Search__Type', 'Type', $types)
->setEmptyString(_t('SilverStripe\\Forms\\DropdownField.CHOOSE', '(Choose)'))
->addExtraClass('stacked');

$form->Fields()->replaceField('Search__Type', $typeField);
$form->Fields()->push($minDate = DateField::create('MinDate', 'Submitted from'));
$form->Fields()->push($maxDate = DateField::create('MaxDate', 'Submitted to'));

foreach ([$name, $email, $minDate, $maxDate, $typeField] as $field) {
$field->addExtraClass('stacked')
->setForm($form);
public function getGridField(): GridField
{
$this->beforeExtending('updateGridField', function (GridField $field) {
$field->setName('Submissions');
});

return parent::getGridField();
}

public function getGridFieldConfig(): GridFieldConfig
{
$this->beforeExtending('updateGridFieldConfig', function (GridFieldConfig $config) {
$config->removeComponentsByType(GridFieldImportButton::class);
$config->removeComponentsByType(GridFieldPrintButton::class);

// Configure filtering options
$updateSearchContext = function (SearchContext $context) {
$filters = $context->getFilters();
$filters['Name'] = HavingPartialMatchFilter::create('NameWithFallback');
$filters['Email'] = HavingPartialMatchFilter::create('EmailWithFallback');
$filters['MinDate'] = GreaterThanOrEqualFilter::create('Created');
$filters['MaxDate'] = LessThanOrEqualFilter::create('Created');
$context->setFilters($filters);

$this->extend('updateSearchContext', $context);
};

$updateSearchForm = function (Form $form) {
$form->Fields()->insertBefore('Search__Type', $name = TextField::create('Name', 'Name'));
$form->Fields()->insertBefore('Search__Type', $email = TextField::create('Email', 'Email'));

// Replace free-text with dropdown of available submission types
$types = ArrayLib::valuekey(CapturedFormSubmission::get()->columnUnique('Type'));
$typeField = DropdownField::create('Search__Type', 'Type', $types)
->setEmptyString(_t('SilverStripe\\Forms\\DropdownField.CHOOSE', '(Choose)'))
->addExtraClass('stacked');

$form->Fields()->replaceField('Search__Type', $typeField);
$form->Fields()->push($minDate = DateField::create('MinDate', 'Submitted from'));
$form->Fields()->push($maxDate = DateField::create('MaxDate', 'Submitted to'));

foreach ([$name, $email, $minDate, $maxDate, $typeField] as $field) {
$field->addExtraClass('stacked')
->setForm($form);
}

// Remove scaffolded fields
$form->Fields()->removeByName('Search__NameWithFallback');
$form->Fields()->removeByName('Search__EmailWithFallback');

$this->extend('updateSearchForm', $form);
};

$config->removeComponentsByType(GridFieldFilterHeader::class);
$config->addComponent(new GridFieldFilterHeader(false, $updateSearchContext, $updateSearchForm));
// Filter only updates page indicators if paginator is added *after* it, so we have to remove and re-add it
// See https://github.com/silverstripe/silverstripe-framework/issues/8454
$config->removeComponentsByType(GridFieldPaginator::class);
$config->addComponent(new GridFieldPaginator());

// Configure CSV export columns
$fieldTable = DataObject::getSchema()->tableName(CapturedField::class);
$columnSelect = SQLSelect::create()
->setSelect('Name')
->setFrom($fieldTable)
->setGroupBy(['Name']);

$columns = [
'Type' => 'Type',
'Created' => 'Date'
];

foreach ($columnSelect->execute() as $row) {
$columns["export__{$row['Name']}"] = $row['Name'];
}
};

$config->removeComponentsByType(GridFieldFilterHeader::class);
$config->addComponent(new GridFieldFilterHeader(false, $updateSearchContext, $updateSearchForm));
// Filter only updates page indicators if paginator is added *after* it, so we have to remove and re-add it
// See https://github.com/silverstripe/silverstripe-framework/issues/8454
$config->removeComponentsByType(GridFieldPaginator::class);
$config->addComponent(new GridFieldPaginator());

// Configure CSV export columns
$fieldTable = DataObject::getSchema()->tableName(CapturedField::class);
$columnSelect = SQLSelect::create()
->setSelect('Name')
->setFrom($fieldTable)
->setGroupBy(['Name']);

$columns = [
'Type' => 'Type',
'Created' => 'Date'
];
foreach ($columnSelect->execute() as $row) {
$columns["export__{$row['Name']}"] = $row['Name'];
}

// Replace existing export button with new one (queued export if module is installed)
$config->removeComponentsByType(GridFieldExportButton::class);
if (class_exists(GridFieldQueuedExportButton::class)) {
$export = new GridFieldQueuedExportButton('buttons-before-left');
} else {
$export = new GridFieldExportButton('buttons-before-left');
}

$config->addComponent($export);
$export->setExportColumns($columns);

return $form;
}

// Replace existing export button with new one (queued export if module is installed)
$config->removeComponentsByType(GridFieldExportButton::class);
if (class_exists(GridFieldQueuedExportButton::class)) {
$export = new GridFieldQueuedExportButton('buttons-before-left');
} else {
$export = new GridFieldExportButton('buttons-before-left');
}

$config->addComponent($export);
$export->setExportColumns($columns);

});

return parent::getGridFieldConfig();
}
}

0 comments on commit 9da789e

Please sign in to comment.