598 lines
18 KiB
PHP
Executable File
598 lines
18 KiB
PHP
Executable File
<?php
|
|
|
|
namespace Symbiote\GridFieldExtensions;
|
|
|
|
use SilverStripe\Control\Controller;
|
|
use SilverStripe\Control\RequestHandler;
|
|
use SilverStripe\Core\ClassInfo;
|
|
use SilverStripe\Forms\GridField\GridField;
|
|
use SilverStripe\Forms\GridField\GridField_ColumnProvider;
|
|
use SilverStripe\Forms\GridField\GridField_DataManipulator;
|
|
use SilverStripe\Forms\GridField\GridField_HTMLProvider;
|
|
use SilverStripe\Forms\GridField\GridField_SaveHandler;
|
|
use SilverStripe\Forms\GridField\GridField_URLHandler;
|
|
use SilverStripe\Forms\HiddenField;
|
|
use SilverStripe\ORM\ArrayList;
|
|
use SilverStripe\ORM\DataObject;
|
|
use SilverStripe\ORM\DB;
|
|
use SilverStripe\ORM\DataList;
|
|
use SilverStripe\ORM\DataObjectInterface;
|
|
use SilverStripe\ORM\ManyManyList;
|
|
use SilverStripe\ORM\SS_List;
|
|
use SilverStripe\ORM\SS_Map;
|
|
use SilverStripe\View\ViewableData;
|
|
use Exception;
|
|
|
|
/**
|
|
* Allows grid field rows to be re-ordered via drag and drop. Both normal data
|
|
* lists and many many lists can be ordered.
|
|
*
|
|
* If the grid field has not been sorted, this component will sort the data by
|
|
* the sort field.
|
|
*/
|
|
class GridFieldOrderableRows extends RequestHandler implements
|
|
GridField_ColumnProvider,
|
|
GridField_DataManipulator,
|
|
GridField_HTMLProvider,
|
|
GridField_URLHandler,
|
|
GridField_SaveHandler
|
|
{
|
|
|
|
/**
|
|
* @see $immediateUpdate
|
|
* @var boolean
|
|
*/
|
|
private static $default_immediate_update = true;
|
|
|
|
private static $allowed_actions = array(
|
|
'handleReorder',
|
|
'handleMoveToPage'
|
|
);
|
|
|
|
/**
|
|
* The database field which specifies the sort, defaults to "Sort".
|
|
*
|
|
* @see setSortField()
|
|
* @var string
|
|
*/
|
|
protected $sortField;
|
|
|
|
/**
|
|
* If set to true, when an item is re-ordered, it will update on the
|
|
* database and refresh the gridfield. When set to false, it will only
|
|
* update the sort order when the record is saved.
|
|
*
|
|
* @var boolean
|
|
*/
|
|
protected $immediateUpdate;
|
|
|
|
/**
|
|
* Extra sort fields to apply before the sort field.
|
|
*
|
|
* @see setExtraSortFields()
|
|
* @var string|array
|
|
*/
|
|
protected $extraSortFields = null;
|
|
|
|
/**
|
|
* The number of the column containing the reorder handles
|
|
*
|
|
* @see setReorderColumnNumber()
|
|
* @var int
|
|
*/
|
|
protected $reorderColumnNumber = 0;
|
|
|
|
/**
|
|
* @param string $sortField
|
|
*/
|
|
public function __construct($sortField = 'Sort')
|
|
{
|
|
parent::__construct();
|
|
$this->sortField = $sortField;
|
|
$this->immediateUpdate = $this->config()->default_immediate_update;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getSortField()
|
|
{
|
|
return $this->sortField;
|
|
}
|
|
|
|
/**
|
|
* Sets the field used to specify the sort.
|
|
*
|
|
* @param string $sortField
|
|
* @return GridFieldOrderableRows $this
|
|
*/
|
|
public function setSortField($field)
|
|
{
|
|
$this->sortField = $field;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return boolean
|
|
*/
|
|
public function getImmediateUpdate()
|
|
{
|
|
return $this->immediateUpdate;
|
|
}
|
|
|
|
/**
|
|
* @see $immediateUpdate
|
|
* @param boolean $immediateUpdate
|
|
* @return GridFieldOrderableRows $this
|
|
*/
|
|
public function setImmediateUpdate($bool)
|
|
{
|
|
$this->immediateUpdate = $bool;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return string|array
|
|
*/
|
|
public function getExtraSortFields()
|
|
{
|
|
return $this->extraSortFields;
|
|
}
|
|
|
|
/**
|
|
* Sets extra sort fields to apply before the sort field.
|
|
*
|
|
* @param string|array $fields
|
|
* @return GridFieldOrderableRows $this
|
|
*/
|
|
public function setExtraSortFields($fields)
|
|
{
|
|
$this->extraSortFields = $fields;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
public function getReorderColumnNumber()
|
|
{
|
|
return $this->reorderColumnNumber;
|
|
}
|
|
|
|
/**
|
|
* Sets the number of the column containing the reorder handles.
|
|
*
|
|
* @param int $colno
|
|
* @return GridFieldOrderableRows $this
|
|
*/
|
|
public function setReorderColumnNumber($colno)
|
|
{
|
|
$this->reorderColumnNumber = $colno;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the table which contains the sort field.
|
|
*
|
|
* @param DataList $list
|
|
* @return string
|
|
*/
|
|
public function getSortTable(SS_List $list)
|
|
{
|
|
$field = $this->getSortField();
|
|
|
|
if ($list instanceof ManyManyList) {
|
|
$extra = $list->getExtraFields();
|
|
$table = $list->getJoinTable();
|
|
|
|
if ($extra && array_key_exists($field, $extra)) {
|
|
return $table;
|
|
}
|
|
}
|
|
|
|
$classes = ClassInfo::dataClassesFor($list->dataClass());
|
|
|
|
foreach ($classes as $class) {
|
|
if (singleton($class)->hasDataBaseField($field)) {
|
|
return DataObject::getSchema()->tableName($class);
|
|
}
|
|
}
|
|
|
|
throw new \Exception("Couldn't find the sort field '$field'");
|
|
}
|
|
|
|
public function getURLHandlers($grid)
|
|
{
|
|
return array(
|
|
'POST reorder' => 'handleReorder',
|
|
'POST movetopage' => 'handleMoveToPage'
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param GridField $field
|
|
*/
|
|
public function getHTMLFragments($field)
|
|
{
|
|
GridFieldExtensions::include_requirements();
|
|
|
|
$field->addExtraClass('ss-gridfield-orderable');
|
|
$field->setAttribute('data-immediate-update', (string)(int)$this->immediateUpdate);
|
|
$field->setAttribute('data-url-reorder', $field->Link('reorder'));
|
|
$field->setAttribute('data-url-movetopage', $field->Link('movetopage'));
|
|
}
|
|
|
|
public function augmentColumns($grid, &$cols)
|
|
{
|
|
if (!in_array('Reorder', $cols) && $grid->getState()->GridFieldOrderableRows->enabled) {
|
|
array_splice($cols, $this->reorderColumnNumber, 0, 'Reorder');
|
|
}
|
|
}
|
|
|
|
public function getColumnsHandled($grid)
|
|
{
|
|
return array('Reorder');
|
|
}
|
|
|
|
public function getColumnContent($grid, $record, $col)
|
|
{
|
|
// In case you are using GridFieldEditableColumns, this ensures that
|
|
// the correct sort order is saved. If you are not using that component,
|
|
// this will be ignored by other components, but will still work for this.
|
|
$sortFieldName = sprintf(
|
|
'%s[GridFieldEditableColumns][%s][%s]',
|
|
$grid->getName(),
|
|
$record->ID,
|
|
$this->getSortField()
|
|
);
|
|
$sortField = new HiddenField($sortFieldName, false, $record->getField($this->getSortField()));
|
|
$sortField->addExtraClass('ss-orderable-hidden-sort');
|
|
$sortField->setForm($grid->getForm());
|
|
|
|
return ViewableData::create()->customise(array(
|
|
'SortField' => $sortField
|
|
))->renderWith('Symbiote\\GridFieldExtensions\\GridFieldOrderableRowsDragHandle');
|
|
}
|
|
|
|
public function getColumnAttributes($grid, $record, $col)
|
|
{
|
|
return array('class' => 'col-reorder');
|
|
}
|
|
|
|
public function getColumnMetadata($grid, $col)
|
|
{
|
|
if ($fieldLabels = singleton($grid->getModelClass())->fieldLabels()) {
|
|
return array('title' => isset($fieldLabels['Reorder']) ? $fieldLabels['Reorder'] : '');
|
|
}
|
|
|
|
return array('title' => '');
|
|
}
|
|
|
|
public function getManipulatedData(GridField $grid, SS_List $list)
|
|
{
|
|
$state = $grid->getState();
|
|
$sorted = (bool) ((string) $state->GridFieldSortableHeader->SortColumn);
|
|
|
|
// If the data has not been sorted by the user, then sort it by the
|
|
// sort column, otherwise disable reordering.
|
|
$state->GridFieldOrderableRows->enabled = !$sorted;
|
|
|
|
if (!$sorted) {
|
|
$sortterm = '';
|
|
if ($this->extraSortFields) {
|
|
if (is_array($this->extraSortFields)) {
|
|
foreach ($this->extraSortFields as $col => $dir) {
|
|
$sortterm .= "$col $dir, ";
|
|
}
|
|
} else {
|
|
$sortterm = $this->extraSortFields.', ';
|
|
}
|
|
}
|
|
if ($list instanceof ArrayList) {
|
|
// Fix bug in 3.1.3+ where ArrayList doesn't account for quotes
|
|
$sortterm .= $this->getSortTable($list).'.'.$this->getSortField();
|
|
} else {
|
|
$sortterm .= '"'.$this->getSortTable($list).'"."'.$this->getSortField().'"';
|
|
}
|
|
return $list->sort($sortterm);
|
|
} else {
|
|
return $list;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handles requests to reorder a set of IDs in a specific order.
|
|
*
|
|
* @param GridField $grid
|
|
* @param SS_HTTPRequest $request
|
|
* @return SS_HTTPResponse
|
|
*/
|
|
public function handleReorder($grid, $request)
|
|
{
|
|
if (!$this->immediateUpdate) {
|
|
$this->httpError(400);
|
|
}
|
|
$list = $grid->getList();
|
|
$modelClass = $grid->getModelClass();
|
|
if ($list instanceof ManyManyList && !singleton($modelClass)->canView()) {
|
|
$this->httpError(403);
|
|
} elseif (!($list instanceof ManyManyList) && !singleton($modelClass)->canEdit()) {
|
|
$this->httpError(403);
|
|
}
|
|
|
|
// Save any un-committed changes to the gridfield
|
|
if (($form = $grid->getForm()) && ($record = $form->getRecord())) {
|
|
$form->loadDataFrom($request->requestVars(), true);
|
|
$grid->saveInto($record);
|
|
}
|
|
|
|
// Get records from the `GridFieldEditableColumns` column
|
|
$data = $request->postVar($grid->getName());
|
|
$sortedIDs = $this->getSortedIDs($data);
|
|
if (!$this->executeReorder($grid, $sortedIDs)) {
|
|
$this->httpError(400);
|
|
}
|
|
|
|
Controller::curr()->getResponse()->addHeader('X-Status', rawurlencode('Records reordered.'));
|
|
return $grid->FieldHolder();
|
|
}
|
|
|
|
/**
|
|
* Get mapping of sort value to ID from posted data
|
|
*
|
|
* @param array $data Raw posted data
|
|
* @return array
|
|
*/
|
|
protected function getSortedIDs($data)
|
|
{
|
|
if (empty($data['GridFieldEditableColumns'])) {
|
|
return array();
|
|
}
|
|
|
|
$sortedIDs = array();
|
|
foreach ($data['GridFieldEditableColumns'] as $id => $recordData) {
|
|
$sortValue = $recordData[$this->sortField];
|
|
$sortedIDs[$sortValue] = $id;
|
|
}
|
|
ksort($sortedIDs);
|
|
return $sortedIDs;
|
|
}
|
|
|
|
/**
|
|
* Handles requests to move an item to the previous or next page.
|
|
*/
|
|
public function handleMoveToPage(GridField $grid, $request)
|
|
{
|
|
if (!$paginator = $grid->getConfig()->getComponentByType('SilverStripe\\Forms\\GridField\\GridFieldPaginator')) {
|
|
$this->httpError(404, 'Paginator component not found');
|
|
}
|
|
|
|
$move = $request->postVar('move');
|
|
$field = $this->getSortField();
|
|
|
|
$list = $grid->getList();
|
|
$manip = $grid->getManipulatedList();
|
|
|
|
$existing = $manip->map('ID', $field)->toArray();
|
|
$values = $existing;
|
|
$order = array();
|
|
|
|
$id = isset($move['id']) ? (int) $move['id'] : null;
|
|
$to = isset($move['page']) ? $move['page'] : null;
|
|
|
|
if (!isset($values[$id])) {
|
|
$this->httpError(400, 'Invalid item ID');
|
|
}
|
|
|
|
$this->populateSortValues($list);
|
|
|
|
$page = ((int) $grid->getState()->GridFieldPaginator->currentPage) ?: 1;
|
|
$per = $paginator->getItemsPerPage();
|
|
|
|
if ($to == 'prev') {
|
|
$swap = $list->limit(1, ($page - 1) * $per - 1)->first();
|
|
$values[$swap->ID] = $swap->$field;
|
|
|
|
$order[] = $id;
|
|
$order[] = $swap->ID;
|
|
|
|
foreach ($existing as $_id => $sort) {
|
|
if ($id != $_id) {
|
|
$order[] = $_id;
|
|
}
|
|
}
|
|
} elseif ($to == 'next') {
|
|
$swap = $list->limit(1, $page * $per)->first();
|
|
$values[$swap->ID] = $swap->$field;
|
|
|
|
foreach ($existing as $_id => $sort) {
|
|
if ($id != $_id) {
|
|
$order[] = $_id;
|
|
}
|
|
}
|
|
|
|
$order[] = $swap->ID;
|
|
$order[] = $id;
|
|
} else {
|
|
$this->httpError(400, 'Invalid page target');
|
|
}
|
|
|
|
$this->reorderItems($list, $values, $order);
|
|
|
|
return $grid->FieldHolder();
|
|
}
|
|
|
|
/**
|
|
* Handle saving when 'immediateUpdate' is disabled, otherwise this isn't
|
|
* necessary for the default sort mode.
|
|
*/
|
|
public function handleSave(GridField $grid, DataObjectInterface $record)
|
|
{
|
|
if (!$this->immediateUpdate) {
|
|
$value = $grid->Value();
|
|
$sortedIDs = $this->getSortedIDs($value);
|
|
if ($sortedIDs) {
|
|
$this->executeReorder($grid, $sortedIDs);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param GridField $grid
|
|
* @param array $sortedIDs List of IDS, where the key is the sort field value to save
|
|
* @return bool
|
|
*/
|
|
protected function executeReorder(GridField $grid, $sortedIDs)
|
|
{
|
|
if (!is_array($sortedIDs)) {
|
|
return false;
|
|
}
|
|
$field = $this->getSortField();
|
|
|
|
$sortterm = '';
|
|
if ($this->extraSortFields) {
|
|
if (is_array($this->extraSortFields)) {
|
|
foreach ($this->extraSortFields as $col => $dir) {
|
|
$sortterm .= "$col $dir, ";
|
|
}
|
|
} else {
|
|
$sortterm = $this->extraSortFields.', ';
|
|
}
|
|
}
|
|
$list = $grid->getList();
|
|
$sortterm .= '"'.$this->getSortTable($list).'"."'.$field.'"';
|
|
$items = $list->filter('ID', $sortedIDs)->sort($sortterm);
|
|
|
|
// Ensure that each provided ID corresponded to an actual object.
|
|
if (count($items) != count($sortedIDs)) {
|
|
return false;
|
|
}
|
|
|
|
// Populate each object we are sorting with a sort value.
|
|
$this->populateSortValues($items);
|
|
|
|
// Generate the current sort values.
|
|
if ($items instanceof ManyManyList) {
|
|
$current = array();
|
|
foreach ($items->toArray() as $record) {
|
|
// NOTE: _SortColumn0 is the first ->sort() field
|
|
// used by SS when functions are detected in a SELECT
|
|
// or CASE WHEN.
|
|
if (isset($record->_SortColumn0)) {
|
|
$current[$record->ID] = $record->_SortColumn0;
|
|
} else {
|
|
$current[$record->ID] = $record->$field;
|
|
}
|
|
}
|
|
} else {
|
|
$current = $items->map('ID', $field)->toArray();
|
|
}
|
|
|
|
// Perform the actual re-ordering.
|
|
$this->reorderItems($list, $current, $sortedIDs);
|
|
return true;
|
|
}
|
|
|
|
protected function reorderItems($list, array $values, array $sortedIDs)
|
|
{
|
|
$sortField = $this->getSortField();
|
|
/** @var SS_List $map */
|
|
$map = $list->map('ID', $sortField);
|
|
//fix for versions of SS that return inconsistent types for `map` function
|
|
if ($map instanceof SS_Map) {
|
|
$map = $map->toArray();
|
|
}
|
|
|
|
// If not a ManyManyList and using versioning, detect it.
|
|
$isVersioned = false;
|
|
$class = $list->dataClass();
|
|
if ($class == $this->getSortTable($list)) {
|
|
$isVersioned = $class::has_extension('SilverStripe\\ORM\\Versioning\\Versioned');
|
|
}
|
|
|
|
// Loop through each item, and update the sort values which do not
|
|
// match to order the objects.
|
|
if (!$isVersioned) {
|
|
$sortTable = $this->getSortTable($list);
|
|
$additionalSQL = (!$list instanceof ManyManyList) ? ', "LastEdited" = NOW()' : '';
|
|
foreach ($sortedIDs as $sortValue => $id) {
|
|
if ($map[$id] != $sortValue) {
|
|
DB::query(sprintf(
|
|
'UPDATE "%s" SET "%s" = %d%s WHERE %s',
|
|
$sortTable,
|
|
$sortField,
|
|
$sortValue,
|
|
$additionalSQL,
|
|
$this->getSortTableClauseForIds($list, $id)
|
|
));
|
|
}
|
|
}
|
|
} else {
|
|
// For versioned objects, modify them with the ORM so that the
|
|
// *_versions table is updated. This ensures re-ordering works
|
|
// similar to the SiteTree where you change the position, and then
|
|
// you go into the record and publish it.
|
|
foreach ($sortedIDs as $sortValue => $id) {
|
|
if ($map[$id] != $sortValue) {
|
|
$record = $class::get()->byID($id);
|
|
$record->$sortField = $sortValue;
|
|
$record->write();
|
|
}
|
|
}
|
|
}
|
|
|
|
$this->extend('onAfterReorderItems', $list);
|
|
}
|
|
|
|
protected function populateSortValues(DataList $list)
|
|
{
|
|
$list = clone $list;
|
|
$field = $this->getSortField();
|
|
$table = $this->getSortTable($list);
|
|
$clause = sprintf('"%s"."%s" = 0', $table, $this->getSortField());
|
|
$additionalSQL = (!$list instanceof ManyManyList) ? ', "LastEdited" = NOW()' : '';
|
|
|
|
foreach ($list->where($clause)->column('ID') as $id) {
|
|
$max = DB::query(sprintf('SELECT MAX("%s") + 1 FROM "%s"', $field, $table));
|
|
$max = $max->value();
|
|
|
|
DB::query(sprintf(
|
|
'UPDATE "%s" SET "%s" = %d%s WHERE %s',
|
|
$table,
|
|
$field,
|
|
$max,
|
|
$additionalSQL,
|
|
$this->getSortTableClauseForIds($list, $id)
|
|
));
|
|
}
|
|
}
|
|
|
|
protected function getSortTableClauseForIds(DataList $list, $ids)
|
|
{
|
|
if (is_array($ids)) {
|
|
$value = 'IN (' . implode(', ', array_map('intval', $ids)) . ')';
|
|
} else {
|
|
$value = '= ' . (int) $ids;
|
|
}
|
|
|
|
if ($list instanceof ManyManyList) {
|
|
$extra = $list->getExtraFields();
|
|
$key = $list->getLocalKey();
|
|
$foreignKey = $list->getForeignKey();
|
|
$foreignID = (int) $list->getForeignID();
|
|
|
|
if ($extra && array_key_exists($this->getSortField(), $extra)) {
|
|
return sprintf(
|
|
'"%s" %s AND "%s" = %d',
|
|
$key,
|
|
$value,
|
|
$foreignKey,
|
|
$foreignID
|
|
);
|
|
}
|
|
}
|
|
|
|
return "\"ID\" $value";
|
|
}
|
|
}
|