Skip to content

FEATURE: New link value object for new link editor (inspector) #5682

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

Merged
mhsdesign merged 3 commits into from
Nov 18, 2025
+298 −9
Merged

FEATURE: New link value object for new link editor (inspector) #5682

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
3e44380
FEATURE: New link value object for new link editor
mhsdesign Nov 12, 2025
2a2cc1c
FEATURE: Link value object with asset id as link must be indexed via …
mhsdesign Nov 15, 2025
8cbe35a
TASK: Remove auto trim of values in `Link` and introduce single `with…
mhsdesign Nov 18, 2025
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
2 changes: 1 addition & 1 deletion Neos.ContentRepository.TestSuite/Classes/Behavior/Features/Bootstrap/CRTestSuiteTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ protected function deserializeProperties(array $properties): PropertyValuesToWri
{
return PropertyValuesToWrite::fromArray(
array_map(
static fn (mixed $value) => is_array($value) && isset($value['__type']) ? new $value['__type']($value['value']) : $value,
static fn (mixed $value) => is_array($value) && isset($value['__type']) ? (is_array($value['value']) ? $value['__type']::fromArray($value['value']) : new $value['__type']($value['value'])) : $value,
$properties
)
);
Expand Down
9 changes: 9 additions & 0 deletions Neos.Neos/Classes/AssetUsage/Service/AssetUsageIndexingService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
use Neos\Neos\AssetUsage\Domain\AssetUsageRepository;
use Neos\Neos\AssetUsage\Dto\AssetIdAndOriginalAssetId;
use Neos\Neos\AssetUsage\Dto\AssetIdsByProperty;
use Neos\Neos\Domain\Link\Link;
use Neos\Utility\TypeHandling;

/**
Expand Down Expand Up @@ -217,6 +218,14 @@ private function extractAssetIds(string $type, mixed $value): array
preg_match_all('/asset:\/\/(?<assetId>[\w-]*)/i', $value, $matches, PREG_SET_ORDER);
return array_map(static fn (array $match) => $match['assetId'], $matches);
}

if ($value instanceof Link) {
if ($value->href->getScheme() === 'asset') {
return [$value->href->getHost() . $value->href->getPath()];
}
return [];
}

if (is_subclass_of($type, ResourceBasedInterface::class)) {
return [$this->persistenceManager->getIdentifierByObject($value)];
}
Expand Down
146 changes: 146 additions & 0 deletions Neos.Neos/Classes/Domain/Link/Link.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
<?php

/*
* This file is part of the Neos.Neos.Ui package.
*
* (c) Contributors of the Neos Project - www.neos.io
*
* This package is Open Source Software. For the full copyright and license
* information, please view the LICENSE file which was distributed with this
* source code.
*/

declare(strict_types=1);

namespace Neos\Neos\Domain\Link;

use GuzzleHttp\Psr7\Uri;
use Neos\Flow\Annotations as Flow;
use Psr\Http\Message\UriInterface;

/**
* Link value object modeled partially after the html spec for <a> tags.
*
* Note that currently the link editor can only handle and write to
* the property {@see Link::$target} "_blank" | null
* and to {@see Link::$rel} ["noopener"] | null
*
* The Link values can be accessed in Fusion the following:
*
* ```fusion
* href = ${q(node).property("link").href}
* title = ${q(node).property("link").title}
* # ...
* ```
*
* In case you need to cast the uri in {@see Link::$href} explicitly to a string
* you can use: `String.toString(link.href)`
*
* @Flow\Proxy(false)
*/
final readonly class Link implements \JsonSerializable
{
/**
* A selection of frequently used target attribute values
*/
public const TARGET_SELF = '_self';
public const TARGET_BLANK = '_blank';

/**
* A selection of frequently used rel attribute values
*/
public const REL_NOOPENER = 'noopener';
public const REL_NOFOLLOW = 'nofollow';

/**
* @param array<int, string> $rel
*/
private function __construct(
public UriInterface $href,
Copy link
Member Author

@mhsdesign mhsdesign Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as this resides in Neos it can be an generic uri but also something specific like a Neos asset uri or node uri.

we could add the following methods to simplify handling all cases:

public function extractForScheme(string $scheme): string|null
{
    if ($this->href->getScheme() !== $scheme) {
        return null;
    }
    return $this->href->getPath();
}

public function extractNodeAggregateId(): ?NodeAggregateId
{
    $rawNodeId = $this->extractForScheme('node');
    return $rawNodeId ? NodeAggregateId::fromString($rawNodeId) : null;
}

public function extractAssetId(): ?string
{
    $assetId = $this->extractForScheme('asset');
    // todo introduce value object
    return $assetId;
}

Copy link
Member Author

@mhsdesign mhsdesign Nov 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Implemented in #5683

public ?string $title,
public ?string $target,
public array $rel,
public bool $download
) {
}

/**
* Note: The signature of this method might be extended in the future, so it should always be used with named arguments
* @see https://www.php.net/manual/en/functions.arguments.php#functions.named-arguments
*
* @param array<int, string> $rel
*/
public static function create(
UriInterface $href,
?string $title = null,
?string $target = null,
array $rel = [],
bool $download = false,
): self {
$relMap = [];
foreach ($rel as $value) {
$relMap[strtolower($value)] = true;
}
return new self(
$href,
($title === '' || $title === null) ? null : $title,
($target === '' || $target === null) ? null : strtolower($target),
array_keys($relMap),
$download
);
}

/**
* @param array<string, mixed> $array
*/
public static function fromArray(array $array): self
{
return self::create(
new Uri($array['href']),
$array['title'] ?? null,
$array['target'] ?? null,
$array['rel'] ?? [],
$array['download'] ?? false,
);
}

public static function fromString(string $string): self
{
return self::create(
href: new Uri($string)
);
}

/**
* Note: The signature of this method might be extended in the future, so it should always be used with named arguments
* @see https://www.php.net/manual/en/functions.arguments.php#functions.named-arguments
*
* @param array<int, string>|null $rel
*/
public function with(
?UriInterface $href = null,
?string $title = null,
?string $target = null,
?array $rel = null,
?bool $download = null,
): self {
return self::create(
$href ?? $this->href,
$title ?? $this->title,
$target ?? $this->target,
$rel ?? $this->rel,
$download ?? $this->download,
);
}

public function jsonSerialize(): mixed
{
return [
'href' => $this->href->__toString(),
'title' => $this->title,
'target' => $this->target,
'rel' => $this->rel,
'download' => $this->download,
];
}
}
26 changes: 18 additions & 8 deletions ...tures/AssetUsage/01-NodeCreation/01-CreateNodeAggregateWithNode_WithoutDimensions.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ Feature: Create node aggregate with node without dimensions
properties:
text:
type: string
assetLinkString:
type: string
assetLinkObject:
type: Neos\Neos\Domain\Link\Link
asset:
type: Neos\Media\Domain\Model\Asset
assets:
Expand All @@ -35,6 +39,8 @@ Feature: Create node aggregate with node without dimensions
When an asset exists with id "asset-1"
And an asset exists with id "asset-2"
And an asset exists with id "asset-3"
And an asset exists with id "asset-4"
And an asset exists with id "asset-5"

When the command CreateWorkspace is executed with payload:
| Key | Value |
Expand All @@ -46,16 +52,20 @@ Feature: Create node aggregate with node without dimensions
Given I am in workspace "live"

And the following CreateNodeAggregateWithNode commands are executed:
| nodeAggregateId | nodeName | parentNodeAggregateId | nodeTypeName | initialPropertyValues |
| sir-david-nodenborough | node | lady-eleonode-rootford | Neos.ContentRepository.Testing:NodeWithAssetProperties | {"asset": "Asset:asset-1"} |
| nody-mc-nodeface | child-node | sir-david-nodenborough | Neos.ContentRepository.Testing:NodeWithAssetProperties | {"assets": ["Asset:asset-2"]} |
| sir-nodeward-nodington-iii | esquire | lady-eleonode-rootford | Neos.ContentRepository.Testing:NodeWithAssetProperties | {"text": "Link to asset://asset-3."} |
| nodeAggregateId | nodeName | parentNodeAggregateId | nodeTypeName | initialPropertyValues |
| sir-david-nodenborough | node | lady-eleonode-rootford | Neos.ContentRepository.Testing:NodeWithAssetProperties | {"asset": "Asset:asset-1"} |
| nody-mc-nodeface | child-node | sir-david-nodenborough | Neos.ContentRepository.Testing:NodeWithAssetProperties | {"assets": ["Asset:asset-2"]} |
| sir-nodeward-nodington-iii | esquire | lady-eleonode-rootford | Neos.ContentRepository.Testing:NodeWithAssetProperties | {"text": "Link to asset://asset-3."} |
| sir-nodeward-lincoln | | lady-eleonode-rootford | Neos.ContentRepository.Testing:NodeWithAssetProperties | {"assetLinkString": "asset://asset-4"} |
| sir-objectward-lincoln | | lady-eleonode-rootford | Neos.ContentRepository.Testing:NodeWithAssetProperties | {"assetLinkObject": {"__type": "Neos\\\\Neos\\\\Domain\\\\Link\\\\Link", "value": { "href": "asset://asset-5" }}} |

Then I expect the AssetUsageService to have the following AssetUsages:
| assetId | nodeAggregateId | propertyName | workspaceName | originDimensionSpacePoint |
| asset-1 | sir-david-nodenborough | asset | live | {} |
| asset-2 | nody-mc-nodeface | assets | live | {} |
| asset-3 | sir-nodeward-nodington-iii | text | live | {} |
| assetId | nodeAggregateId | propertyName | workspaceName | originDimensionSpacePoint |
| asset-1 | sir-david-nodenborough | asset | live | {} |
| asset-2 | nody-mc-nodeface | assets | live | {} |
| asset-3 | sir-nodeward-nodington-iii | text | live | {} |
| asset-4 | sir-nodeward-lincoln | assetLinkString | live | {} |
| asset-5 | sir-objectward-lincoln | assetLinkObject | live | {} |

Scenario: Nodes on user workspace have been created
Given I am in workspace "user-workspace"
Expand Down
124 changes: 124 additions & 0 deletions Neos.Neos/Tests/Unit/Domain/Link/LinkTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
<?php

declare(strict_types=1);

namespace Neos\Neos\Tests\Unit\Domain\Link;

use GuzzleHttp\Psr7\Uri;
use Neos\Neos\Domain\Link\Link;
use PHPUnit\Framework\TestCase;

class LinkTest extends TestCase
{
/**
* @test
*/
public function emptyLink()
{
$link = Link::create(
href: new Uri('#')
);
self::assertEquals('', (string)$link->href);
self::assertEquals(null, $link->title);
self::assertEquals(null, $link->target);
self::assertEquals([], $link->rel);
self::assertEquals(false, $link->download);

// another way to create it
self::assertEquals(
$link,
Link::fromString('#')
);
}

/**
* @test
*/
public function linkWithAttributes()
{
$link = Link::create(
href: new Uri('/bar'),
title: 'My link',
target: Link::TARGET_BLANK,
rel: [Link::REL_NOFOLLOW],
download: true
);

self::assertEquals('/bar', (string)$link->href);
self::assertEquals('My link', $link->title);
self::assertEquals('_blank', $link->target);
self::assertEquals(['nofollow'], $link->rel);
self::assertEquals(true, $link->download);
}

/**
* @test
*/
public function linkWithAttributesViaWither()
{
$emptyLink = Link::create(
href: new Uri('#')
);

$link = $emptyLink->with(
href: new Uri('/bar'),
title: 'My link',
target: Link::TARGET_BLANK,
rel: [Link::REL_NOFOLLOW],
download: true
);

self::assertEquals('/bar', (string)$link->href);
self::assertEquals('My link', $link->title);
self::assertEquals('_blank', $link->target);
self::assertEquals(['nofollow'], $link->rel);
self::assertEquals(true, $link->download);
}

/**
* @test
*/
public function linkWithAttributesOneUpdated()
{
$link = Link::create(
href: new Uri('/bar'),
title: 'My link',
target: Link::TARGET_BLANK,
rel: [Link::REL_NOFOLLOW],
download: true
)->with(
title: 'My updated link'
);

self::assertEquals('/bar', (string)$link->href);
self::assertEquals('My updated link', $link->title);
self::assertEquals('_blank', $link->target);
self::assertEquals(['nofollow'], $link->rel);
self::assertEquals(true, $link->download);
}

/**
* @test
*/
public function linkWithAttributesCanBeResetViaWith()
{
$link = Link::create(
href: new Uri('/bar'),
title: 'My link',
target: Link::TARGET_BLANK,
rel: [Link::REL_NOFOLLOW],
download: true
)->with(
title: '',
target: '',
rel: [],
download: false
);

self::assertEquals('/bar', (string)$link->href);
self::assertEquals(null, $link->title);
self::assertEquals(null, $link->target);
self::assertEquals([], $link->rel);
self::assertEquals(false, $link->download);
}
}