Skip to content

Commit

Permalink
Merge branch '5' into 6
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Aug 16, 2024
2 parents cec5c45 + 42fc926 commit f6e72cb
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 36 deletions.
7 changes: 7 additions & 0 deletions src/Models/BaseElement.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
use DNADesign\Elemental\Controllers\ElementController;
use DNADesign\Elemental\Forms\TextCheckboxGroupField;
use DNADesign\Elemental\ORM\FieldType\DBObjectType;
use DNADesign\Elemental\Services\ReorderElements;
use DNADesign\Elemental\TopPage\DataExtension;
use Exception;
use SilverStripe\CMS\Controllers\CMSPageEditController;
Expand Down Expand Up @@ -1278,4 +1279,10 @@ public static function getGraphQLTypeName(): string
}
return str_replace('\\', '_', static::class);
}

public function onAfterPublish()
{
$reorderer = Injector::inst()->create(ReorderElements::class, $this);
$reorderer->publishSortOrder();
}
}
62 changes: 35 additions & 27 deletions src/Services/ReorderElements.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
use InvalidArgumentException;
use SilverStripe\Core\Convert;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\Queries\SQLUpdate;
use SilverStripe\Versioned\Versioned;

Expand Down Expand Up @@ -61,7 +62,8 @@ public function setElement(BaseElement $element)
}

/**
* Set the ordering of Elements in relation to sibling Elements in the parent {@see ElementalArea}
* Set the ordering of Elements in relation to sibling Elements in the parent {@see ElementalArea}.
* This only affects the sort order in draft.
*
* @param int $elementToBeAfterID ID of the Element to be ordered after
*/
Expand Down Expand Up @@ -97,39 +99,45 @@ public function reorder($elementToBeAfterID = 0)
// We are updating records with SQL queries to avoid the ORM triggering the creation of new versions
// for each element that is affected by this reordering.
$baseTableName = Convert::raw2sql(DataObject::getSchema()->tableName(BaseElement::class));

// Update both the draft and live versions of the records
$tableNames = [$baseTableName];
if (BaseElement::has_extension(Versioned::class)) {
/** @var BaseElement&Versioned $element */
$tableNames[] = $element->stageTable($baseTableName, Versioned::LIVE);
$tableName = sprintf('"%s"', $baseTableName);

if ($sortAfterPosition < $currentPosition) {
$operator = '+';
$filter = "$tableName.\"Sort\" > $sortAfterPosition AND $tableName.\"Sort\" < $currentPosition";
$newBlockPosition = $sortAfterPosition + 1;
} else {
$operator = '-';
$filter = "$tableName.\"Sort\" <= $sortAfterPosition AND $tableName.\"Sort\" > $currentPosition";
$newBlockPosition = $sortAfterPosition;
}

foreach ($tableNames as $tableName) {
$tableName = sprintf('"%s"', $tableName);

if ($sortAfterPosition < $currentPosition) {
$operator = '+';
$filter = "$tableName.\"Sort\" > $sortAfterPosition AND $tableName.\"Sort\" < $currentPosition";
$newBlockPosition = $sortAfterPosition + 1;
} else {
$operator = '-';
$filter = "$tableName.\"Sort\" <= $sortAfterPosition AND $tableName.\"Sort\" > $currentPosition";
$newBlockPosition = $sortAfterPosition;
}

$query = SQLUpdate::create()
->setTable("$tableName")
->assignSQL('"Sort"', "$tableName.\"Sort\" $operator 1")
->addWhere([$filter, "$tableName.\"ParentID\"" => $parentId]);

$query->execute();
}
$query = SQLUpdate::create()
->setTable("$tableName")
->assignSQL('"Sort"', "$tableName.\"Sort\" $operator 1")
->addWhere([$filter, "$tableName.\"ParentID\"" => $parentId]);
$query->execute();

// Now use the ORM to write a new version of the record that we are directly reordering
$element->Sort = $newBlockPosition;
$element->write(skipValidation: $this->elementIsNew);

return $element;
}

/**
* Force live sort order to match stage sort order
*/
public function publishSortOrder()
{
$baseTableName = Convert::raw2sql(DataObject::getSchema()->tableName(BaseElement::class));
$live = Versioned::LIVE;
$sql = sprintf(
'UPDATE "%2$s"
SET "Sort" = (SELECT "%1$s"."Sort" FROM "%1$s" WHERE "%2$s"."ID" = "%1$s"."ID")
WHERE EXISTS (SELECT "%1$s"."Sort" FROM "%1$s" WHERE "%2$s"."ID" = "%1$s"."ID") AND "ParentID" = ?',
$baseTableName,
"{$baseTableName}_{$live}"
);
DB::prepared_query($sql, [$this->getElement()->ParentID]);
}
}
41 changes: 32 additions & 9 deletions tests/Services/ReorderElementsTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

namespace DNADesign\Elemental\Tests\Services;

use DNADesign\Elemental\Models\BaseElement;
use DNADesign\Elemental\Services\ReorderElements;
use DNADesign\Elemental\Tests\Src\TestElement;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Versioned\Versioned;

class ReorderElementsTest extends SapphireTest
{
Expand All @@ -19,28 +21,49 @@ class ReorderElementsTest extends SapphireTest
*/
public function testReorder()
{
foreach (BaseElement::get() as $toPublish) {
$toPublish->publishSingle();
}
$element = $this->objFromFixture(TestElement::class, 'element1');
$reorderService = new ReorderElements($element);

$reorderService->reorder(4);
$this->assertIdsInOrder([2, 3, 4, 1], 'The Element should be last in the list');
$this->assertIdsInOrder([2, 3, 4, 1], [1, 2, 3, 4], 'The Element should be last in the list (draft only)');
$element->publishSingle();
$this->assertIdsInOrder([2, 3, 4, 1], [2, 3, 4, 1], 'The sort order should be published correctly');

$reorderService->reorder(0);
$this->assertIdsInOrder([1, 2, 3, 4], 'The Element should be first in the list');
$this->assertIdsInOrder([1, 2, 3, 4], [2, 3, 4, 1], 'The Element should be first in the list (draft only)');
$element->publishSingle();
$this->assertIdsInOrder([1, 2, 3, 4], [1, 2, 3, 4], 'The sort order should be published correctly');

$reorderService->reorder(2);
$this->assertIdsInOrder([2, 1, 3, 4], 'The Element should be second in the list');
$this->assertIdsInOrder([2, 1, 3, 4], [1, 2, 3, 4], 'The Element should be second in the list (draft only)');
$element->publishSingle();
$this->assertIdsInOrder([2, 1, 3, 4], [2, 1, 3, 4], 'The sort order should be published correctly');

$reorderService->reorder();
$this->assertIdsInOrder([1, 2, 3, 4], 'The Element should be first in the list');
$this->assertIdsInOrder([1, 2, 3, 4], [2, 1, 3, 4], 'The Element should be first in the list (draft only)');
$element->publishSingle();
$this->assertIdsInOrder([1, 2, 3, 4], [1, 2, 3, 4], 'The sort order should be published correctly');
}

protected function assertIdsInOrder($ids, $message = null)
protected function assertIdsInOrder($draftIds, $publishedIDs, $message = null)
{
$actualIDs = TestElement::get()->sort('Sort')->column('ID');
// Check draft
Versioned::withVersionedMode(function () use ($draftIds, $message) {
Versioned::set_stage(Versioned::DRAFT);
$actualIDs = TestElement::get()->sort('Sort')->column('ID');

// Ideally this should be assertSame, but sometimes the database
// returns IDs as strings instead of integers (e.g. "1" instead of 1).
$this->assertEquals($ids, $actualIDs, $message);
// Ideally this should be assertSame, but sometimes the database
// returns IDs as strings instead of integers (e.g. "1" instead of 1).
$this->assertEquals($draftIds, $actualIDs, $message);
});
// Check published
Versioned::withVersionedMode(function () use ($publishedIDs, $message) {
Versioned::set_stage(Versioned::LIVE);
$actualIDs = TestElement::get()->sort('Sort')->column('ID');
$this->assertEquals($publishedIDs, $actualIDs, $message);
});
}
}

0 comments on commit f6e72cb

Please sign in to comment.