edee.oneDocs
EdeeShop · Implementace

Konfigurace médií

Upraveno

Popis TODO odkaz do funkční specifikace.

Konfigurace médií je vždy součástí konfigurace entity, která media podporuje, tedy produkty, kategorie, skupiny nebo značky.

Konfiguraci lze specifikovat pro konkrétní katalog pomocí elementu catalogSpecific.

Konfigurace

Příklad základní konfigurace médií pro produkty

xml
<product><!-- ... nebo <category>, <group>, <brand> -->    <mediaConfig>        <mediaList>            <!-- Hlavní motivový obrázek produktů, zobrazený v seznamech, detailu v košíku atd. -->            <media>                <code>hlavni-motiv</code>                <maxItems>1</maxItems>                <allowedFileExtensions>jpg,png,webp</allowedFileExtensions>                <frequentlyAccessed>true</frequentlyAccessed>            </media>            <!-- Další obrázky produktu zobrazené v detailu -->            <media>                <code>galerie</code>                <type>GALLERY</type>                <maxItems>5</maxItems>                <allowedFileExtensions>jpg,png,webp</allowedFileExtensions>            </media>        <mediaList>       </mediaConfig></product>

Příklad konfigurace

xml
<mediaConfig>    <mediaList>        <media>            <allowedFileExtensions>jpg,png,webp</allowedFileExtensions>            <code>hlavni-motiv</code>            <folder>/edeeshop/#{catalog.code}/#{edeeShopEntity.entityType.code}/#{gallery.code}/#{edeeShopEntity.code}/</folder>            <frequentlyAccessed>false</frequentlyAccessed>            <maxItems>1</maxItems>            <storage>f.file</storage>            <type>MOTIVE</type>        </media>    </mediaList></mediaConfig>

Popis

mediaConfig/mediaList/media

Konfigurace médií pro daný typ entity.

Konfigurace se po inicializaci registruje do mediaGalleryFeature, odkud s ním nadále tato feature pracuje.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
allowedFileExtensions

Obsahuje seznam povolených přípon souborů oddělený čárkami.

String

-

-

code

Unikátní kód galerie v rámci katalogu a typu entity.

Jedná se o identifikátor, který se následně používá pro zobrazení odpovídající zobrazená na FE nebo AR.

String

-

-

folder

Cestu ve storage pro ukládání souborů této galerie.

Jedná se o SPeL výraz, ve kterém lze použít tyto proměnné:

Default hodnota je /edeeshop/#{catalog.code}/#{edeeShopEntity.entityType.code}/#{gallery.code}/#{edeeShopEntity.code}/.

String

-

/edeeshop/#{catalog.code}/#{edeeShopEntity.entityType.code}/#{gallery.code}/#{edeeShopEntity.code}/

frequentlyAccessed

Pokud je hodnota true data se publikují do dat a jsou tedy k dispozici v seznamech. (Typicky hlavní motiv). Pokud je hodnota false data se publikují pouze do fatData a jsou k dispozici pouze v detailu entity.

boolean

-

false

maxItems

Umožňuje omezit počet souborů, který lze do takovéto galerie přidat.

Integer

-

-

storage

Specifikuje CPS storage, do které budou ukládány soubory media galerií.

Default hodnota f.file, která vyhovuje všem běžným případům. V případě použití jiné storage je možné, že některá funkčnost nebude plně dostupná.

String

-

f.file

type

Typ souboru: obrázek, galerie nebo příloha. Ovlivní způsob zadávání v administraci.

  • MOTIVE - Typicky se jedná o hlavní motiv (např. produktů), který je zobrazován v seznamech.

Položky tohoto typu galerie jsou typu STORAGE_FILE, tedy soubory uložené v CPS storage.

V AR představuje komponentu pro upload jediného obrázkového souboru s náhledem.

  • GALLERY - Typicky se jedná o doplňující obrázky k hlavní motivu zobrazeny například v detailu produktu.

Položky tohoto typu galerie jsou typu STORAGE_FILE, tedy soubory uložené v CPS storage.

V AR Představuje komponentu pro upload a zobrazení většího množství obrázků.

  • ATTACHMENT - Jedná o další přílohy entitám, jako například produktové list, návody v PDF apod.

Položky tohoto typu galerie jsou typu STORAGE_FILE, tedy soubory uložené v CPS storage.

V AR představuje komponentu pro upload a zobrazení většího množství neobrázkových příloh.

  • LINKS - Galerie odkazů (linky na externí zdroje). Odkazy jsou spravovány modulem edeelinkmodule, tedy tento typ media vyžaduje jeho konfigurace.

V AR představuje komponentu pro zadávání a správu odkazů.

-

MOTIVE