FEATURE: Edit preview mode support for Neos 9 #4067
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Neos.Neos 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\Controller\Exception; | ||
|
|
||
| use Neos\Neos\Controller\Exception; | ||
|
|
||
| /** | ||
| * A "Node Creation" exception | ||
| * | ||
| */ | ||
| class InvalidEditPreviewModeException extends Exception | ||
| { | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Neos.Neos 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\Model; | ||
|
|
||
| final class EditPreviewMode | ||
| { | ||
| protected function __construct( | ||
| public readonly string $name, | ||
| public readonly string $title, | ||
| public readonly ?string $fusionPath, | ||
| public readonly bool $isEditMode, | ||
| public readonly bool $isPreviewMode | ||
| ) { | ||
| } | ||
|
Comment on lines
+25
to
+26
There was a problem hiding this comment. We were talking about this model. It should contain a check, so that There was a problem hiding this comment. I didn't :D But yeah, that would probably be better. |
||
|
|
||
| /** | ||
| * @param string $name | ||
| * @param array{'title'?:string, 'fusionRenderingPath'?:string, 'isEditingMode'?:bool, 'isPreviewMode'?:bool} $configuration | ||
| * @return self | ||
| */ | ||
| public static function fromNameAndConfiguration(string $name, array $configuration): self | ||
| { | ||
| return new static( | ||
| $name, | ||
| $configuration['title'] ?? $name, | ||
| $configuration['fusionRenderingPath'] ?? null, | ||
| $configuration['isEditingMode'] ?? false, | ||
| $configuration['isPreviewMode'] ?? false | ||
| ); | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,44 @@ | ||||||
| <?php | ||||||
|
|
||||||
| /* | ||||||
| * This file is part of the Neos.Neos 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\Repository; | ||||||
|
|
||||||
| use Neos\Neos\Controller\Exception\InvalidEditPreviewModeException; | ||||||
| use Neos\Neos\Domain\Model\EditPreviewMode; | ||||||
| use Neos\Flow\Annotations as Flow; | ||||||
|
|
||||||
| class EditPreviewModeRepository | ||||||
| { | ||||||
| #[Flow\InjectConfiguration(path:"userInterface.defaultEditPreviewMode")] | ||||||
| protected string $defaultEditPreviewMode; | ||||||
|
|
||||||
| /** | ||||||
| * @var array<string, array{'title'?:string, 'fusionRenderingPath'?:string, 'isEditingMode'?:bool, 'isPreviewMode'?:bool}> | ||||||
| */ | ||||||
| #[Flow\InjectConfiguration(path:"userInterface.editPreviewModes")] | ||||||
| protected array $editPreviewModeConfigurations; | ||||||
|
|
||||||
| public function findDefault(): EditPreviewMode | ||||||
| { | ||||||
| return EditPreviewMode::fromNameAndConfiguration($this->defaultEditPreviewMode, $this->editPreviewModeConfigurations[$this->defaultEditPreviewMode]); | ||||||
| } | ||||||
|
|
||||||
| public function findByName(string $name): EditPreviewMode | ||||||
| { | ||||||
| if (array_key_exists($name, $this->editPreviewModeConfigurations)) { | ||||||
| return EditPreviewMode::fromNameAndConfiguration($name, $this->editPreviewModeConfigurations[$name]); | ||||||
| } | ||||||
| throw new InvalidEditPreviewModeException(sprintf('"%s" is not a valid editPreviewMode', $name), 1683790077); | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| } | ||||||
| } | ||||||
|
There was a problem hiding this comment. I'm very unsure whether it's wise to check for the current edit/preview mode via this EEL-Helper and by analyzing the request. As a consequence of this strategy, this is what needs to be done for out-of-band rendering in the UI: https://github.com/neos/neos-ui/blob/0a858bb1cd5a31e4143f9b06144b0704c3acaad7/Classes/Domain/Model/Feedback/Operations/ReloadContentOutOfBand.php#L136-L146 Intuitively, I'd say it'd be better to just throw the current On the other hand, that fake controller context may not be the worst idea after all, because usually integrators wouldn't expect (and shouldn't notice) their code to go through such different execution paths. However, semantically it seems very arbitrary to me to bind the current edit preview mode to a specific controller action... There was a problem hiding this comment. Yes i rather have this additional context too. I remember that we discussed this at the Dresden sprint, but the discussion came up that in fusion we can't currently add new context variables because users would have to account for them in caching. There is a way though: We need to pass the context variable behind fusions back like I will prepare a draft pr to show you what i mean ;) There was a problem hiding this comment. @grebaldi i prepared a concept over here: #4425 this way we open the api of the runtime to allow other variables like This would allow us to add a global There was a problem hiding this comment. new Runtime(
defaultContextVariables: [
'request' => $request,
'Neos' => [
'UiMode' => new UiModeHelper($isBackend)
]
]
) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would also prefer to move this logic closer to the domain, by letting the
EditPreviewModeRepositoryprovide more specific retrieval methods: