subugoe/iiif-bundle

IIIF Bundle for symfony

IIIF Bundle

This is a Symfony 5.x/6.x Bundle to get an IIIF Representation out of arbitrary data structures., _(*1)

Example configuration

subugoe_iiif:
  image:
    http:
        scheme:           "https"
        host:             "images.example.com"
    tile_width:           512
    thumbnail_size:       "96,"
    zoom_levels:          [1, 2, 4, 8, 16]
  presentation:
    logo:                 "http://service.example.com/fileadmin/gdz/layout/head_logo.jpg"
    service_id:           "http://service.exmple.com/"
    http:
        scheme:           "https"
        host:             "manifests.example.com"

Format translator

It is also necessary to define a so-called translator-service with the name subugoe_iiif.translator, i.e.:, _(*2)

  Subugoe\IIIFBundle\Translator\TranslatorInterface:
    class:      Subugoe\IIIFBundle\Translator\SubugoeTranslator
    arguments:  ["@subugoe_find.search_service"]

The translator has to implement the Subugoe\IIIFBundle\Translator\TranslatorInterface. An example translator is bundled, see the SubugoeTranslator class., _(*3)

File systems

This bundle uses Flysystem, for retrieving and storing (a.k.a. caching) the tiles and thumbnails. If caching should not be enabled the Null Adapter should be used. The FlysystemBundle is already required in the composer manifest. Please have a look at the FlysystemBundle documentation for the configuration options and available bundles. The adapter that fits to your needs has to be required in the main composer manifest of your application., _(*4)

For caching, a flysystem configuration has to be enabled like that:, _(*5)

oneup_flysystem:
    adapters:
        cache_adapter:
            awss3v3:
                client: foo.s3_client
                bucket: 'foo'
                prefix: 'cache'
        source_adapter:
            custom:
                service: httpfilesystem_service

    filesystems:
        subugoe_iiif_cache:
            adapter: cache_adapter
            alias: cache_filesystem
        subugoe_iiif_source:
            adapter: source_adapter
            alias: source_filesystem

Please note, that it has to be named cache_filesystem to be used. The source filesystem (where the original scans reside) has to be aliased or named source_filesystem., _(*6)