ICT:Drupal opener explained - Revision history

Mngr at 10:09, 12 March 2026

2026-03-12T10:09:10Z

@@ Line 219: / Line 219: @@
 # The '''Insert/Save''' action buttons at the bottom.
 [[Category:Gin Theme Compatibility]]
 [[Category:Drupal Development]]
 [[Category:Heritage Project Documentation]]

Mngr at 10:04, 12 March 2026

2026-03-12T10:04:10Z

@@ Line 185: / Line 185: @@
 * '''Integrity''': Historians cannot accidentally select an existing asset if the requirement is always a fresh upload.
 [[Category:Drupal Development]]
 [[Category:Heritage Project Documentation]]

Mngr at 10:00, 12 March 2026

2026-03-12T10:00:33Z

@@ Line 141: / Line 141: @@
 * The backend storage should be configured as a '''Required''' field to match this UI behavior.
 [[Category:Drupal Development]]
 [[Category:Heritage Project Documentation]]

Mngr at 09:54, 12 March 2026

2026-03-12T09:54:32Z

← Older revision		Revision as of 09:54, 12 March 2026
Line 135:		Line 135:
	</source>		</source>

			=== Data Integrity: Immutable Selection ===
			To maintain strict archival standards, this tool '''does not''' provide a "Remove" button.
			* Once an asset is linked, it can only be '''replaced''' by launching the Media Library again.
			* This prevents "orphaned" Digital Asset nodes in the database that lack an associated file.
			* The backend storage should be configured as a '''Required''' field to match this UI behavior.

Mngr at 09:53, 12 March 2026

2026-03-12T09:53:04Z

@@ Line 104: / Line 104: @@
 * <code>id="asset-preview-container"</code>: Where the thumbnail will appear.
 * <code>id="selected-asset-id"</code>: A hidden input to store the ID for the backend.
 [[Category:Drupal Development]]
 [[Category:Heritage Project Documentation]]

Mngr: Created page with "== Custom Media Library Opener for Heritage Digital Assets == In '''Drupal 11.3.5''', a custom "Opener" service allows the Media Library to be used as a standalone modal. This implementation restricts selection to '''one and only one''' asset and returns a rendered thumbnail to the parent page, mimicking the "classical" Media Library behavior without the full Field API overhead. === 1. Define the Service === Register the opener in your module's `your_module.servic..."`


2026-03-12T09:50:52Z
Created page with "== Custom Media Library Opener for Heritage Digital Assets ==  In '''Drupal 11.3.5''', a custom "Opener" service allows the Media Library to be used as a standalone modal. This implementation restricts selection to '''one and only one''' asset and returns a rendered thumbnail to the parent page, mimicking the "classical" Media Library behavior without the full Field API overhead.  === 1. Define the Service === Register the opener in your module's <code>your_module.servic..."
New page
== Custom Media Library Opener for Heritage Digital Assets ==



In '''Drupal 11.3.5''', a custom "Opener" service allows the Media Library to be used as a standalone modal. This implementation restricts selection to '''one and only one''' asset and returns a rendered thumbnail to the parent page, mimicking the "classical" Media Library behavior without the full Field API overhead.



=== 1. Define the Service ===

Register the opener in your module's <code>your_module.services.yml</code>. You must tag it with <code>media_library.opener</code> so the system can identify it.



<source lang="yaml">

services:

  your_module.heritage_opener:

    class: Drupal\your_module\HeritageAssetOpener

    arguments: ['@entity_type.manager']

    tags:

      - { name: media_library.opener }

</source>



=== 2. The Opener Logic ===

Create <code>src/HeritageAssetOpener.php</code>. This class handles the permission check and generates the AJAX response to inject the thumbnail.



<source lang="php">

namespace Drupal\your_module;



use Drupal\Core\Access\AccessResult;

use Drupal\Core\Ajax\AjaxResponse;

use Drupal\Core\Ajax\HtmlCommand;

use Drupal\Core\Ajax\InvokeCommand;

use Drupal\Core\Entity\EntityTypeManagerInterface;

use Drupal\Core\Session\AccountInterface;

use Drupal\media\Entity\Media;

use Drupal\media_library\MediaLibraryOpenerInterface;

use Drupal\media_library\MediaLibraryState;



class HeritageAssetOpener implements MediaLibraryOpenerInterface {



  protected $entityTypeManager;



  public function __construct(EntityTypeManagerInterface $entity_type_manager) {

    $this->entityTypeManager = $entity_type_manager;

  }



  /**

   * Checks if the user can access the media library in this context.

   */

  public function checkAccess(MediaLibraryState $state, AccountInterface $account) {

    return AccessResult::allowedIfHasPermission($account, 'view media');

  }



  /**

   * Logic executed after clicking "Insert" in the modal.

   */

  public function getSelectionResponse(MediaLibraryState $state, array $selected_ids) {

    $selected_id = reset($selected_ids); // Force single selection logic

    $media = Media::load($selected_id);

    

    $response = new AjaxResponse();



    if ($media) {

      // Build the thumbnail using the 'media_library' view mode

      $view_builder = $this->entityTypeManager->getViewBuilder('media');

      $render_array = $view_builder->view($media, 'media_library');

      

      // Inject the thumbnail into the UI

      $response->addCommand(new HtmlCommand('#asset-preview-container', $render_array));

      

      // Update a hidden field with the ID for form submission

      $response->addCommand(new InvokeCommand('#selected-asset-id', 'val', [$selected_id]));

    }



    return $response;

  }

}

</source>



=== 3. Triggering the Modal ===

To launch the modal from a controller or form, build a link using the <code>MediaLibraryState</code>. Setting <code>media_library_remaining</code> to '''1''' enforces the single-item limit.



<source lang="php">

use Drupal\Core\Url;

use Drupal\media_library\MediaLibraryState;



// Create the state for our custom opener

$state = MediaLibraryState::create(

  'your_module.heritage_opener', // Our service ID

  ['image', 'document'],         // Allowed types

  'image',                       // Default tab

  1                              // Quantity limit (1 for single asset)

);



$build['select_button'] = [

  '#type' => 'link',

  '#title' => $this->t('Select Heritage Asset'),

  '#url' => Url::fromRoute('media_library.ui', [], ['query' => $state->all()]),

  '#attributes' => [

    'class' => ['use-ajax', 'button'],

    'data-dialog-type' => 'modal',

    'data-dialog-options' => json_encode(['width' => '80%']),

  ],

  '#attached' => ['library' => ['core/drupal.dialog.ajax']],

];

</source>



=== 4. Required HTML Placeholders ===

Ensure your template or form contains these matching IDs:

* <code>id="asset-preview-container"</code>: Where the thumbnail will appear.

* <code>id="selected-asset-id"</code>: A hidden input to store the ID for the backend.



[[Category:Drupal Development]]

[[Category:Heritage Project Documentation]]