Skip to content

[codex] Refactor breadcrumb label resolution #702

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

Closed
dvlpp wants to merge 1 commit into from
Closed

[codex] Refactor breadcrumb label resolution #702

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
182 changes: 97 additions & 85 deletions src/Http/Context/SharpBreadcrumb.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,43 +152,7 @@ private function getFrontTypeNameFor(string $type): string

private function getBreadcrumbLabelFor(BreadcrumbItem $item, bool $isLeaf): string
{
switch ($item->type) {
case 's-list':
return app(SharpMenuManager::class)
->getEntityMenuItem($item->key)
?->getLabel() ?: trans('sharp::breadcrumb.entityList');
case 's-dashboard':
return app(SharpMenuManager::class)
->getEntityMenuItem($item->key)
?->getLabel() ?: trans('sharp::breadcrumb.dashboard');
case 's-show':
return trans('sharp::breadcrumb.show', [
'entity' => $this->getEntityLabelForInstance($item, $isLeaf),
]);
case 's-form':
// A Form is always a leaf
$previousItem = $this->breadcrumbItems()[$item->depth - 1];

if (
($previousItem->isShow() && ! $this->isSameEntityKeys($previousItem->key, $item->key, true))
|| ($item->isForm() && $this->currentInstanceLabel)
) {
// The form entityKey is different from the previous entityKey in the breadcrumb: we are in a EEL case.
return isset($item->instance)
? trans('sharp::breadcrumb.form.edit_entity', [
'entity' => $this->getEntityLabelForInstance($item, true),
])
: trans('sharp::breadcrumb.form.create_entity', [
'entity' => $this->getEntityLabelForInstance($item, true),
]);
}

return isset($item->instance) || ($previousItem->type === 's-show' && ! isset($previousItem->instance))
? trans('sharp::breadcrumb.form.edit')
: trans('sharp::breadcrumb.form.create');
}

return $item->key;
return $this->resolveLabelForItem($item, $isLeaf, false) ?? $item->key;
}

/**
Expand All @@ -197,25 +161,7 @@ private function getBreadcrumbLabelFor(BreadcrumbItem $item, bool $isLeaf): stri
*/
private function getDocumentTitleLabelFor(BreadcrumbItem $item, bool $isLeaf): ?string
{
if (! $isLeaf) {
return null;
}

$previousItem = $this->breadcrumbItems()[$item->depth - 1] ?? null;

return match ($item->type) {
's-show' => trans('sharp::breadcrumb.show', [
'entity' => $this->getEntityLabelForInstance($item, $isLeaf),
]),
's-form' => isset($item->instance) || ($previousItem->type === 's-show' && ! isset($previousItem->instance))
? trans('sharp::breadcrumb.form.edit_entity', [
'entity' => $this->getEntityLabelForInstance($item, $isLeaf),
])
: trans('sharp::breadcrumb.form.create_entity', [
'entity' => $this->getEntityLabelForInstance($item, $isLeaf),
]),
default => null
};
return $this->resolveLabelForItem($item, $isLeaf, true);
}

public function getParentShowCachedBreadcrumbLabel(): ?string
Expand Down Expand Up @@ -266,40 +212,106 @@ private function isSameEntityKeys(string $key1, string $key2, bool $compareBaseE

private function buildBreadcrumbFromRequest(): void
{
$this->breadcrumbItems = new Collection();
$segments = $this->getSegmentsFromRequest();
$this->breadcrumbItems = $this->buildItemsFromSegments($segments);
}

private function resolveLabelForItem(BreadcrumbItem $item, bool $isLeaf, bool $forDocumentTitle): ?string
{
if ($forDocumentTitle && ! $isLeaf) {
return null;
}

return match ($item->type) {
's-list' => $forDocumentTitle ? null : (app(SharpMenuManager::class)
->getEntityMenuItem($item->key)
?->getLabel() ?: trans('sharp::breadcrumb.entityList')),
's-dashboard' => $forDocumentTitle ? null : (app(SharpMenuManager::class)
->getEntityMenuItem($item->key)
?->getLabel() ?: trans('sharp::breadcrumb.dashboard')),
's-show' => trans('sharp::breadcrumb.show', [
'entity' => $this->getEntityLabelForInstance($item, $isLeaf),
]),
's-form' => $this->resolveFormLabel($item, $isLeaf, $forDocumentTitle),
default => $forDocumentTitle ? null : $item->key,
};
}

private function resolveFormLabel(BreadcrumbItem $item, bool $isLeaf, bool $forDocumentTitle): string
{
if ($forDocumentTitle) {
$previousItem = $this->breadcrumbItems()[$item->depth - 1] ?? null;

return isset($item->instance) || ($previousItem->type === 's-show' && ! isset($previousItem->instance))
? trans('sharp::breadcrumb.form.edit_entity', [
'entity' => $this->getEntityLabelForInstance($item, $isLeaf),
])
: trans('sharp::breadcrumb.form.create_entity', [
'entity' => $this->getEntityLabelForInstance($item, $isLeaf),
]);
}

// A Form is always a leaf
$previousItem = $this->breadcrumbItems()[$item->depth - 1];

if (
($previousItem->isShow() && ! $this->isSameEntityKeys($previousItem->key, $item->key, true))
|| ($item->isForm() && $this->currentInstanceLabel)
) {
// The form entityKey is different from the previous entityKey in the breadcrumb: we are in a EEL case.
return isset($item->instance)
? trans('sharp::breadcrumb.form.edit_entity', [
'entity' => $this->getEntityLabelForInstance($item, true),
])
: trans('sharp::breadcrumb.form.create_entity', [
'entity' => $this->getEntityLabelForInstance($item, true),
]);
}

return isset($item->instance) || ($previousItem->type === 's-show' && ! isset($previousItem->instance))
? trans('sharp::breadcrumb.form.edit')
: trans('sharp::breadcrumb.form.create');
}

private function buildItemsFromSegments(Collection $segments): Collection
{
$items = new Collection();
$depth = 0;

if (count($segments) !== 0) {
$this->breadcrumbItems()->add(
(new BreadcrumbItem($segments[0], $segments[1]))->setDepth($depth++),
);
if (count($segments) === 0) {
return $items;
}

$segments = $segments->slice(2)->values();

while ($segments->count() > 0) {
$type = $segments->shift();
$key = $instance = null;
$segments
->takeWhile(fn (string $segment) => ! in_array($segment, ['s-show', 's-form']))
->values()
->each(function (string $segment, $index) use (&$key, &$instance) {
if ($index === 0) {
$key = $segment;
} elseif ($index === 1) {
$instance = $segment;
}
});

$segments = $segments->slice($instance !== null ? 2 : 1)->values();

$this->breadcrumbItems()->add(
(new BreadcrumbItem($type, $key))
->setDepth($depth++)
->setInstance($instance),
);
}
$items->add(
(new BreadcrumbItem($segments[0], $segments[1]))->setDepth($depth++),
);

$segments = $segments->slice(2)->values();

while ($segments->count() > 0) {
$type = $segments->shift();
$key = $instance = null;
$segments
->takeWhile(fn (string $segment) => ! in_array($segment, ['s-show', 's-form']))
->values()
->each(function (string $segment, $index) use (&$key, &$instance) {
if ($index === 0) {
$key = $segment;
} elseif ($index === 1) {
$instance = $segment;
}
});

$segments = $segments->slice($instance !== null ? 2 : 1)->values();

$items->add(
(new BreadcrumbItem($type, $key))
->setDepth($depth++)
->setInstance($instance),
);
}

return $items;
}

protected function getSegmentsFromRequest(): Collection
Expand Down
Loading