Introduzione al Sistema AutoPermissions

🚧 BOZZA

Il MediaService è un modulo Shared che gestisce l'upload e lo store di files (a prescindere dal loro mime type) connettendoli ad oggetti generici identificati da classe e id. Tramite il MediaService è possibile effettuare l'upload e lo store in un qualsi disco di sistema. Possono essere memorizzati file, stringhe in formato base64, url o file temporanei precedentemente caricati e non ancora finalizzati.

Il modulo, nel caso di store di dati di tipo image, pdf, excel e doc, genera una anteprima reperibile nel campo "preview" nel mediaDto (è necessario installare nella macchina il package "libreoffice").

Come si usa:

UploadFile

Questa chiamata può essere utile in fase di "create" di un oggetto (id non ancora definito). Per ottenere un oggetto MediaUploadFileDto, utile in fase successiva per lo store, è necessario inviare il file (in POST) all'endpoint https://nomedominio.xx/api/shared/media/upload.

Il nome del nodo DEVE essere "file". Verrò restituito un dto di tipo MediaUploadedFileDto.

Field

PHP Type

Note

file

UploadedFile

required

GetAllMedia

Tramite una chiamata GET all'endpoint https://nomedominio.xx/api/shared/media/get-all si può recuperare un paginator di MediaDto filtrati per criteria.

Field

PHP Type

Note

id

string

required

class

string

required

collection_name

string

required

page

int|Optional

perPage

int|Optional

StoreMedia

Tramite una chiamata POST all'endpoint https://nomedominio.xx/api/shared/media/store si può recuperare un paginator di MediaDto. Oltre ai campi "required", nella request deve essere valorizzato almeno uno dei campi seguenti campi: file, files, url, urls, base64, bases64, temporary_file e temporary_files.

Field

PHP Type

Note

id

string

required

class

string

required

collection_name

string

required

file

UploadedFile|Optional

url

string|Optional

base64

string|Optional

temporary_file[temporary_file_name]|Optional

string

temporary_file[original_file_name]|Optional

string

temporary_files[0][temporary_file_name]|Optional

string

temporary_file[0][original_file_name]|Optional

string

files

<UploadedFile>[]|Optional

urls

<string>[]|Optional

bases64

<string>[]|Optional

temporary_files

<MediaUploadedFileDto>[]|Optional