Skip to content

feat(structure): slice priority on add + new /move endpoint #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marcohanke wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat(structure): slice priority on add + new /move endpoint #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e3c2973
feat(structure): support optional priority on slice add
marcohanke Jun 11, 2026
7fac85f
feat(structure): add slice move endpoint
marcohanke Jun 11, 2026
79910f7
test(structure): cover slice priority + move
marcohanke Jun 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 123 additions & 0 deletions lib/RoutePackage/Structure.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
use FriendsOfRedaxo\Api\RouteCollection;
use FriendsOfRedaxo\Api\RoutePackage;
use rex;
use rex_api_exception;
use rex_article;
use rex_article_cache;
use rex_article_service;
Expand Down Expand Up @@ -428,6 +429,11 @@ public function loadRoutes(): void
'required' => true,
'default' => null,
],
'priority' => [
'type' => 'int',
'required' => false,
'default' => null,
],
],
$Values, // value1...19
$Medias, // media1...10
Expand Down Expand Up @@ -524,6 +530,34 @@ public function loadRoutes(): void
null,
new BearerAuth()
);

// Slice eines Artikels verschieben (moveup/movedown) ✅
RouteCollection::registerRoute(
'structure/articles/slices/move',
new Route(
'structure/articles/{id}/slices/{slice_id}/move',
[
'_controller' => 'FriendsOfRedaxo\Api\RoutePackage\Structure::handleMoveArticleSlice',
'Body' => [
'direction' => [
'type' => 'string',
'required' => true,
'default' => null,
],
],
],
[
'id' => '\d+',
'slice_id' => '\d+',
],
[],
'',
[],
['POST']),
'Move a slice up or down within its ctype',
null,
new BearerAuth()
);
}

private static function checkStructurePerm(?rex_user $user, ?int $categoryId = null): ?Response
Expand Down Expand Up @@ -912,6 +946,14 @@ public static function handleAddArticleSlices($Parameter, array $Route = []): Re
}
}

// Optional priority: rex_content_service::addSlice() accepts a `priority` key in $data
// (content_service.php:17-24). If omitted, the service appends at the end (MAX(priority)+1).
// priority <= 0 is normalised to 1 by the service. After insert the service calls
// rex_sql_util::organizePriorities() to renormalise the sequence.
if (null !== $Data['priority']) {
$SliceData['priority'] = (int) $Data['priority'];
}

try {
$SliceId = null;
rex_extension::register('SLICE_ADDED', static function (rex_extension_point $ep) use (&$SliceId) {
Expand Down Expand Up @@ -1423,6 +1465,87 @@ public static function handleDeleteArticleSlice($Parameter, array $Route = []):
}
}

/** @api */
public static function handleMoveArticleSlice($Parameter, array $Route = []): Response
{
$Data = json_decode(rex::getRequest()->getContent(), true);

if (!is_array($Data)) {
return new JsonResponse(['error' => 'Invalid input'], 400);
}

try {
$Data = RouteCollection::getQuerySet($Data, $Parameter['Body']);
} catch (Exception $e) {
return new JsonResponse(['error' => 'Body field: `' . $e->getMessage() . '` is required'], 400);
}

$direction = $Data['direction'];
if ('moveup' !== $direction && 'movedown' !== $direction) {
return new JsonResponse([
'error' => 'Invalid direction',
'direction' => rex_escape((string) $direction),
'allowed' => ['moveup', 'movedown'],
], 400);
}

$sliceId = (int) $Parameter['slice_id'];
$articleId = (int) $Parameter['id'];

$Slice = self::loadSliceForArticle($sliceId, $articleId);
if (null === $Slice) {
return new JsonResponse(['error' => 'Slice not found'], 404);
}

$clangId = (int) $Slice['clang_id'];
$moduleId = (int) $Slice['module_id'];

$Article = rex_article::get($articleId, $clangId);
if (!$Article) {
return new JsonResponse(['error' => 'Article not found'], 404);
}

// Permission cascade mirrors rex_api_content_move_slice::execute()
// (addons/structure/plugins/content/lib/api_functions/api_content.php:29-50).
// For Bearer token calls (`$user === null`), scope grants access.
$user = RouteCollection::getBackendUser($Route);
if (null !== $user && !$user->isAdmin() && !$user->hasPerm('moveSlice[]')) {
return new JsonResponse(['error' => 'Permission denied'], 403);
}
$permResponse = self::checkStructurePerm($user, $Article->getCategoryId());
if (null !== $permResponse) {
return $permResponse;
}
if (null !== $user && !$user->getComplexPerm('modules')->hasPerm($moduleId)) {
return new JsonResponse(['error' => 'Permission denied'], 403);
}

try {
// rex_content_service::moveSlice() handles everything: fires SLICE_MOVE, swaps the
// priority, calls rex_sql_util::organizePriorities(), invalidates the content cache
// via rex_article_cache::deleteContent(), and fires art_content_updated.
// We mirror api_content.php exactly — no extra EPs, no extra cache calls.
$message = rex_content_service::moveSlice($sliceId, $clangId, $direction);
} catch (rex_api_exception $e) {
// moveSlice throws when the slice is already at the boundary (top can't moveup, etc.)
// — surface as 422 rather than 500 since the request was structurally valid but the
// requested state transition is not possible.
return new JsonResponse([
'error' => $e->getMessage(),
'slice_id' => $sliceId,
'direction' => $direction,
], 422);
Comment on lines +1529 to +1537
} catch (Exception $e) {
return new JsonResponse(['error' => $e->getMessage()], 500);
}

return new JsonResponse([
'message' => $message,
'slice_id' => $sliceId,
'direction' => $direction,
], 200);
}

/**
* Load a slice by id and verify it belongs to the given article. Returns null when not found.
*
Expand Down
84 changes: 84 additions & 0 deletions tests/BackendApiTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -759,6 +759,90 @@ public function testAdminSliceCRUD(): void
}
}

public function testAdminCreateArticleSliceAtTop(): void
{
$articleId = self::$config['test_data']['existing_article_id'];
$moduleId = self::$config['test_data']['existing_module_id'];
$clangId = self::$config['test_data']['existing_clang_id'];

$createResponse = $this->adminPost('structure/articles/' . $articleId . '/slices', [
'module_id' => $moduleId,
'clang_id' => $clangId,
'ctype_id' => 1,
'priority' => 1,
'value1' => 'BACKEND_TEST_top_' . uniqid(),
]);
if (201 !== $createResponse['status']) {
$this->markTestSkipped('Slice konnte nicht angelegt werden (Template/Modul-Zuordnung fehlt).');
}
$sliceId = (int) $createResponse['data']['slice_id'];

try {
$getResponse = $this->adminGet('structure/articles/' . $articleId . '/slices/' . $sliceId);
$this->assertSame(200, $getResponse['status']);
$this->assertSame(1, (int) $getResponse['data']['priority']);
} finally {
$this->adminDelete('structure/articles/' . $articleId . '/slices/' . $sliceId);
}
}

public function testAdminMoveArticleSlice(): void
{
$articleId = self::$config['test_data']['existing_article_id'];
$moduleId = self::$config['test_data']['existing_module_id'];
$clangId = self::$config['test_data']['existing_clang_id'];

$first = $this->adminPost('structure/articles/' . $articleId . '/slices', [
'module_id' => $moduleId, 'clang_id' => $clangId, 'ctype_id' => 1,
'priority' => 1, 'value1' => 'BACKEND_TEST_first_' . uniqid(),
]);
if (201 !== $first['status']) {
$this->markTestSkipped('Slice konnte nicht angelegt werden.');
}
$firstId = (int) $first['data']['slice_id'];

$second = $this->adminPost('structure/articles/' . $articleId . '/slices', [
'module_id' => $moduleId, 'clang_id' => $clangId, 'ctype_id' => 1,
'priority' => 2, 'value1' => 'BACKEND_TEST_second_' . uniqid(),
]);
$this->assertSame(201, $second['status']);
$secondId = (int) $second['data']['slice_id'];

try {
$moveResponse = $this->adminPost(
'structure/articles/' . $articleId . '/slices/' . $secondId . '/move',
['direction' => 'moveup'],
);
$this->assertSame(200, $moveResponse['status']);

$getSecond = $this->adminGet('structure/articles/' . $articleId . '/slices/' . $secondId);
$getFirst = $this->adminGet('structure/articles/' . $articleId . '/slices/' . $firstId);
$this->assertLessThan(
(int) $getFirst['data']['priority'],
(int) $getSecond['data']['priority'],
'After moveup the second slice should now have a lower priority than the first',
);
Comment on lines +818 to +824
} finally {
$this->adminDelete('structure/articles/' . $articleId . '/slices/' . $secondId);
$this->adminDelete('structure/articles/' . $articleId . '/slices/' . $firstId);
}
}

public function testRestrictedUserCannotMoveArticleSlice(): void
{
$articleId = self::$config['test_data']['existing_article_id'];

$response = $this->restrictedPost(
'structure/articles/' . $articleId . '/slices/1/move',
['direction' => 'moveup'],
);

// Restricted user lacks both moveSlice[] perm and likely the structure category perm.
// Either 403 (Permission denied) or 404 (slice not visible) is acceptable; what we
// must NOT see is a 200.
$this->assertContains($response['status'], [403, 404]);
}

// ==================== ADMIN CRUD: Media Category ====================

public function testAdminMediaCategoryCRUD(): void
Expand Down
Loading