[5.x] Make Photoswipe work with any ContentEntity entity type

Open on Drupal.org →

Created on 20 June 2024, 6 months ago

Updated 25 July 2024, 5 months ago

Problem/Motivation

The photoswipe field formatter works fine with multi-value entity_reference fields associated with a media entity, but lacks support for paragraphs, ECK, and other content-based entities.

Context: specifically, we are storing images inside Paragpaphs. Now migrated on 5.x. Before we used custom twig templates to make Photoswipe 3.x work with referenced Paragpaph.

Proposed resolution

1. Introduce support for other entity types within ImageDTO class.
2. Ensure that photoswipe_dynamic_caption can provide tokens based on referenced entity.
3. Allow photoswipe*_entity_field_formatter to work with entity_reference_revisions field type.

Remaining tasks

- Merge ✨ [5.x] Separate image and entity_reference formatters Needs work
- Adjust photoswipe_entity_field_formatter, photoswipe_responsive_entity_field_formatter with adding entity_reference_revisions for field_types
- Ensure ImageDTO store correct $this->item when ContentEntity entity received from $variables.
- Ensure photoswipe_dynamic_caption module can build custom tokens based on entity that hosts an image field ( 💬 Dynamic caption: How to use a dedicated caption field on a media entity? Needs review )!
- Write hook updates to assoc entity_reference_revisions field type with correct formatter.

User interface changes

User can select Photoswipe field formatter for entity reference fields linked to ContentEntity entity, like: Paragrpaph, ECK, etc.

API changes

-

Data model changes

ImageDTO::item can contain a ContentEntity entity .

✨ Feature request

Status

Active

Version

5.0

Component

Code

Created by

🇺🇦Ukraine vlad.dancer Kyiv

Live updates comments and jobs are added and updated live.

Needs tests
The change is currently missing an automated test that fails when run with the original code, and succeeds when the bug has been fixed.

Sign in to follow issues

Merge Requests

!124[5.x] Make Photoswipe work with any ContentEntity entity type
Open
🇺🇦Ukraine vlad.dancer
updated 5 months ago

Comments & Activities

Issue created by @vlad.dancer
Comment 6 months ago →
🇺🇦Ukraine vlad.dancer Kyiv
Merge request !124Issue #3455963: Ensure ImageDTO store correct item when ContentEntity entity received → (Open) created by vlad.dancer
Pipeline finished with Success
6 months ago
Total: 251s
#203797
Comment 6 months ago →
🇩🇪Germany Anybody Porta Westfalica
Thank you very much @vlad.dancer. Can we perhaps have a test that doesn't work with the current state, but after the fix?

Tests are very important for Photoswipe due to its popularity. Thank you!
Comment 6 months ago →
🇺🇦Ukraine vlad.dancer Kyiv
@Anybody, sure, I just have no time for that. Maybe someone else can write them. One step a time to get further.
Comment 6 months ago →
🇩🇪Germany Anybody Porta Westfalica
Yes, happy to merge this, once the tests exist. Same for the other issue.
Comment 5 months ago →
🇺🇦Ukraine vlad.dancer Kyiv
FYI: there is no Photoswipe Dynamic Plugin field formatter settings inside views field settings (when you select show fields and use Photoswipe as field formatter). For that you need to apply this patch 🐛 Formatter third party settings missing from Views UI Needs work
Pipeline finished with Success
5 months ago
Total: 265s
#234040

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024