Adventure Documentation

FilesController extends CollectionController
in package

This controller describes the behavior of files including images, PDFs, videos and documents.

Use the controller to generate a collection of FileItem entities.

Tags
see
FileItem

Main entity of collection

see
InvoiceFileItem

Entity used to describe order PDFs

see
ImageFileItem

Entity used to describe images

see
WatermarkFileItem

Entity used to describe watermark images (extends ImageFileItem)

see
PlaceholdFileItem

Entity used to describe placehold images (extend ImageFileItem)

see
YoutubeOnlineItem

Entity used to describe Youtube items, mostly used in Media Archive

Table of Contents

ENV_BLOG  = '/upload_dir/blog'
ENV_DESIGN  = '/_design/common/img'
ENV_EVENT  = '/upload_dir/calendar'
ENV_FILES  = '/upload_dir/pics'
ENV_GALLERY  = '/upload_dir/pics'
ENV_NEWS  = '/upload_dir/news'
ENV_PRIVATE  = '/upload_dir/private'
ENV_SHOP  = '/upload_dir/shop'
ENV_USER  = '/upload_dir/users'
__construct()  : mixed
getTranslation()  : string
Get translation data, e.g. title and text for images related to Page entities
preload()  : mixed
Preloads entities differently depending on type parameter
preloadForPriceIndex()  : mixed
Preloads entities for price index display
preloadVariantDataPictures()  : mixed
preloadVariantPictures()  : mixed
Preloads entities differently depending on type parameter

Constants

ENV_BLOG

public mixed ENV_BLOG = '/upload_dir/blog'
Tags

ENV_DESIGN

public mixed ENV_DESIGN = '/_design/common/img'
Tags

ENV_EVENT

public mixed ENV_EVENT = '/upload_dir/calendar'
Tags

ENV_FILES

public mixed ENV_FILES = '/upload_dir/pics'
Tags
public mixed ENV_GALLERY = '/upload_dir/pics'
Tags

ENV_NEWS

public mixed ENV_NEWS = '/upload_dir/news'
Tags

ENV_PRIVATE

public mixed ENV_PRIVATE = '/upload_dir/private'
Tags

ENV_SHOP

public mixed ENV_SHOP = '/upload_dir/shop'
Tags

ENV_USER

public mixed ENV_USER = '/upload_dir/users'
Tags

Methods

__construct()

public __construct([mixed $parseUriParameters = false ]) : mixed
Parameters
$parseUriParameters : mixed = false
Tags
Return values
mixed

getTranslation()

Get translation data, e.g. title and text for images related to Page entities

public getTranslation(mixed $Id[, mixed $Title = 'title' ][, mixed $LanguageIso = null ][, mixed $Module = 'picture_element' ]) : string
Parameters
$Id : mixed
$Title : mixed = 'title'
$LanguageIso : mixed = null
$Module : mixed = 'picture_element'
Tags
Return values
string

preload()

Preloads entities differently depending on type parameter

public preload(mixed $ids) : mixed
Parameters
$ids : mixed
Tags
see
CollectionController::preload
Return values
mixed

preloadForPriceIndex()

Preloads entities for price index display

public preloadForPriceIndex(mixed $ids) : mixed
Parameters
$ids : mixed
Tags
see
CollectionController::preload
Return values
mixed

preloadVariantDataPictures()

public preloadVariantDataPictures(mixed $ids) : mixed
Parameters
$ids : mixed
Tags
Return values
mixed

preloadVariantPictures()

Preloads entities differently depending on type parameter

public preloadVariantPictures(mixed $ids) : mixed
Parameters
$ids : mixed
Tags
see
CollectionController::preload
Return values
mixed

        

Search results