Jet\Form_Field_FileImage / Form_Field::TYPE_FILE_IMAGE

Představuje formulářové pole pro nahrání obrázku, nebo obrázků.

Pro zobrazení samotného formulářového pole využívá renderer Jet\Form_Renderer_Field_Input_File.

Výchozí chybové kódy

Kód Význam
Form_Field::ERROR_CODE_EMPTY Pole je označené jako požadované a hodnota není zadána - soubor není vybrán.
Form_Field::ERROR_CODE_FILE_IS_TOO_LARGE Soubor je příliš velký - jeho velikost přesahuje nastavený limit.
Form_Field::ERROR_CODE_DISALLOWED_FILE_TYPE Soubor nemá povolený typ, tedy nejedná se o podporovaný obrázek.

Parametry

Parametr Typ Povinný Význam
allowed_mime_types (array) array ne Seznam povolených MIME typů souborů.

Je již přednastaveno, ale výchozí nastavení je možno přepsat.
maximal_file_size (int) int ne Maximální velikost souboru v bajtech.
allow_multiple_upload bool ne Je / není povoleno nahrání více souborů naráz.
maximal_width int ne Maximální šířka obrázku - pokud ji nahraný obrázek přesáhne, bude na danou velikost automaticky zmenšen.
maximal_height int ne Maximální výška obrázku - pokud ji nahraný obrázek přesáhne, bude na danou velikost automaticky zmenšen.

Metody

Metoda Význam
public getMaximalFileSize(
) : int|null		 Vrátí nastavenou maximální velikost nahrávaného souboru v bajtech.
public setMaximalFileSize(
int|null $maximal_file_size
) : void		 Nastaví maximální velikost nahrávaného souboru v bajtech.
public setMaximalSize(
int $maximal_width,
int $maximal_height
)		 Nastavuje maximální povolené rozměry obrázku. Pokud tyto rozměry obrázek přesáhne, tak je automaticky zmenšen tak, aby se do limitu vešel. Poměry stran jsou zachovány.
public getMaximalHeight(
) : int|null		 Vrátí nastavenou maximální výšku.
public getMaximalWidth(
) : int|null		 Vrátí nastavenou maximální šířku.
public getAllowedMimeTypes(
) : array		 Vrátí nastavený seznam povolených MIME typů nahrávaných souborů.
public setAllowedMimeTypes(
array $allowed_mime_types
) : void		 Nastaví seznam povolených MIME typů nahrávaných souborů.

Hodnoty jsou již přednastaveny, ale je samozřejmě možné nastavení změnit.
public getAllowMultipleUpload(
) : bool		 Indikuje zda je / není povoleno nahrávání více souborů naráz.
public setAllowMultipleUpload(
bool $allow_multiple_upload
) : void		 Povoluje / zakazuje nahrávání více souborů naráz.
public getAllFiles(
) : Form_Field_File_UploadedFile[]		 Vrátí seznam všech zachycených nahraný souborů bez ohledu na to zda vyhovují validaci, či nikoliv.
public getValidFiles(
) : Form_Field_File_UploadedFile[]		 Vrátí seznam těch zachycených nahraných souborů, které vyhověly validaci.
public getValue(
) : Form_Field_File_UploadedFile[]		 Vrátí seznam těch zachycených nahraných souborů, které vyhověly validaci.
public getProblematicFiles(
) : Form_Field_File_UploadedFile[]		 Vrátí seznam těch zachycených nahraných souborů, které nevyhověly validaci.
Předchozí kapitola
Jet\Form_Field_File_UploadedFile
Další kapitola
Možnosti výběru
GitHub