ValumsFileUploader: Unterschied zwischen den Versionen
Aus Contao Community Documentation
(13 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
− | {{ | + | [[Category:Extensions]] |
+ | '''valumsFileUploader''' ist ein Mehrfachuploader und bietet eine flashfreie Alternative zu FancyUpload im Backend und Frontend. Dateien können des weiteren via Drag&Drop hochgeladen werden. | ||
+ | {{ExtInfo | ||
+ | | DevSite=http://www.men-at-work.de | ||
+ | | ExtVersion=3.1.0 | ||
+ | | Version=2.9.0 - 2.11.0 | ||
+ | | ERLink=http://www.contao.org/erweiterungsliste/view/valumsFileUploader.html | ||
+ | | VCSLink=https://github.com/menatwork/valumsFileUploader | ||
+ | }} | ||
− | valumsFileUploader ist | + | ==Verwendung im Backend== |
+ | |||
+ | ===Konfiguration=== | ||
+ | |||
+ | Aktiviert werden muss der valumsFileUploader nach der Installation bei jedem Benutzer in den Persönlichen Daten. Sobald der neue Uploader aktiviert wurde, stehen 2 weitere Optionen zur Verfügung: "Dateien überschreiben" und "Bilder skalieren". Ab der Version 2.10 ist es möglich die maximale Bildbreite und maximale Bildhöhe zu berücksichtigen, in diesem Fall werden die Bilder auf die eingestellten Werte skaliert. Nach Vollendung der Konfiguration steht dem Benutzer beim Dateiupload der neue Uploader zur Verfügung. | ||
+ | |||
+ | ===Upload=== | ||
+ | |||
+ | valumsFileUploader begrenzt keinen Upload und kann auch für sehr große Dateien genutzt werden. In diesem Fall sollte der Server auf dem die Contao Installation liegt dafür ausgestattet sein und große Dateiuploads erlauben. Dateien können mit Hilfe des "Durchsuchen" Buttons hochgeladen werden oder man zieht alle Dateien via Drag&Drop in die Schaltfläche. | ||
+ | |||
+ | Die Dateien werden umgehend hochgeladen, ein Absenden des Formulars ist nicht notwendig. | ||
+ | |||
+ | ==Verwendung im Frontend== | ||
+ | |||
+ | ===Konfiguration=== | ||
+ | |||
+ | Um in Frontend-Formularen ein Uploadfeld vom Typ "valumsFileUploader" verwenden zu können, legt man im Formulargenerator ein neues Feld an. Beim Feldtyp wählt man "valumsFileUploader". Im nächsten Schritt gibt man die "erlaubten Dateitypen" und die "maximale Dateigröße" an. Möchte man die hochgeladenen Dateien desweiteren auch in einem bestimmten Ordner auf dem Server speichern, wählt man die Option "Hochgeladene Dateien speichern" aus. Nun muss man nur noch den Ordner für den Upload auswählen. | ||
+ | |||
+ | ===Mögliche Problemfälle=== | ||
+ | |||
+ | Der Uploader ohne korrekt ausgeführte Schreibrechte auf dem Server keine Dateien hochladen. Ein SMH ist daher zurzeit keine Lösung. An einer Änderung dieses Verhaltens wird gearbeitet. | ||
+ | |||
+ | ==Verwendung als Backend Widget== | ||
+ | |||
+ | Mit einigen wenigen Einstellungen erhält jeder Entwickler die Möglichkeit den valumsFileUploader in sein "DCA" zu integrieren. | ||
+ | |||
+ | ===Codebeispiel=== | ||
+ | <source lang="php"> | ||
+ | $GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample'] = array | ||
+ | ( | ||
+ | // Set the button label and the help text | ||
+ | 'label' => array('Button label', 'Help text'), | ||
+ | |||
+ | // Set field to "valumsFileUploader" | ||
+ | 'inputType' => 'valumsFileUploader', | ||
+ | |||
+ | // Set special options | ||
+ | 'eval' => array( | ||
+ | |||
+ | // Set path for files to save | ||
+ | 'path' => 'tl_files', | ||
+ | |||
+ | // Set the maximum allowed file size | ||
+ | 'maxFileSize' => 2048000000, | ||
+ | |||
+ | // Set the allowed file extensions comma seperated | ||
+ | 'extensions' => 'jpeg, jpg, png', | ||
+ | |||
+ | // Set the the value to not override existing files and | ||
+ | // choose the value to handle the files (useSuffix, useTimeStamp) | ||
+ | 'overwrite' => 'useSuffix', | ||
+ | |||
+ | // Set the this value with height and with to resize the file | ||
+ | 'resize' => array('800', '800'), | ||
+ | |||
+ | // Set debug mode | ||
+ | 'debug' => true, | ||
+ | |||
+ | // Set label for drop field | ||
+ | 'dropTextLabel' => 'Drop text label' | ||
+ | ) | ||
+ | ); | ||
+ | </source> | ||
+ | |||
+ | ===Verfügbare Eval-Optionen=== | ||
+ | |||
+ | {| cellpadding="20" cellspacing="0" | ||
+ | |- | ||
+ | | '''Schlüssel''' || '''Wert''' || '''Beschreibung''' || '''Beispiel''' | ||
+ | |- | ||
+ | | path || ''string'' || Legt das Upload Verzeichnis Fest. || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample']['eval']['path'] = 'tl_files';</source> | ||
+ | |- | ||
+ | | maxFileSize || ''integer'' || Legt die maximal erlaubte Dateigröße in Bytes fest. | ||
+ | || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample']['eval']['maxFileSize'] = 2048000000;</source> | ||
+ | |- | ||
+ | | extensions || ''string'' || Legt die Dateierweiterungen Komma separiert fest. || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample']['eval']['extensions'] = 'jpeg, jpg, png';</source> | ||
+ | |- | ||
+ | | overwrite || ''string'' || Legt fest das die existieren Dateien in dem Upload Verzeichnis nicht überschrieben werden dürfen, und wie mit den Duplikaten verfahren werden soll. Mögliche Werte sind "useSuffix" und "useTimeStamp". || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample']['eval']['overwrite'] = 'useSuffix';</source> | ||
+ | |- | ||
+ | | resize || ''array'' || Durch Setzen der breite und höhe in einem Array wird das Bild beim Upload auf diese Werte runter skaliert. || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample']['eval']['resize'] = array('800', '800');</source> | ||
+ | |- | ||
+ | | debug || ''bool'' || Durch setzen dieses Wertes wird der Debug Modus aktiviert oder deaktiviert. || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample']['eval']['debug'] = true;</source> | ||
+ | |- | ||
+ | | dropTextLabel || ''string'' || Legt das Label für die Drop Zone des Uploaders Fest. || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample']['eval']['dropTextLabel'] = 'Drop text label';</source> | ||
+ | |- | ||
+ | |} |
Aktuelle Version vom 6. März 2012, 12:30 Uhr
valumsFileUploader ist ein Mehrfachuploader und bietet eine flashfreie Alternative zu FancyUpload im Backend und Frontend. Dateien können des weiteren via Drag&Drop hochgeladen werden.
Erweiterungs-Übersicht | |
---|---|
Entwickler Webseite | http://www.men-at-work.de |
Version der Erweiterung | 3.1.0 |
Kompatibilität mit Contao Version | 2.9.0 - 2.11.0 |
Link zum Extension Repository | http://www.contao.org/erweiterungsliste/view/valumsFileUploader.html |
Link zum VCS | https://github.com/menatwork/valumsFileUploader |
Inhaltsverzeichnis
Verwendung im Backend
Konfiguration
Aktiviert werden muss der valumsFileUploader nach der Installation bei jedem Benutzer in den Persönlichen Daten. Sobald der neue Uploader aktiviert wurde, stehen 2 weitere Optionen zur Verfügung: "Dateien überschreiben" und "Bilder skalieren". Ab der Version 2.10 ist es möglich die maximale Bildbreite und maximale Bildhöhe zu berücksichtigen, in diesem Fall werden die Bilder auf die eingestellten Werte skaliert. Nach Vollendung der Konfiguration steht dem Benutzer beim Dateiupload der neue Uploader zur Verfügung.
Upload
valumsFileUploader begrenzt keinen Upload und kann auch für sehr große Dateien genutzt werden. In diesem Fall sollte der Server auf dem die Contao Installation liegt dafür ausgestattet sein und große Dateiuploads erlauben. Dateien können mit Hilfe des "Durchsuchen" Buttons hochgeladen werden oder man zieht alle Dateien via Drag&Drop in die Schaltfläche.
Die Dateien werden umgehend hochgeladen, ein Absenden des Formulars ist nicht notwendig.
Verwendung im Frontend
Konfiguration
Um in Frontend-Formularen ein Uploadfeld vom Typ "valumsFileUploader" verwenden zu können, legt man im Formulargenerator ein neues Feld an. Beim Feldtyp wählt man "valumsFileUploader". Im nächsten Schritt gibt man die "erlaubten Dateitypen" und die "maximale Dateigröße" an. Möchte man die hochgeladenen Dateien desweiteren auch in einem bestimmten Ordner auf dem Server speichern, wählt man die Option "Hochgeladene Dateien speichern" aus. Nun muss man nur noch den Ordner für den Upload auswählen.
Mögliche Problemfälle
Der Uploader ohne korrekt ausgeführte Schreibrechte auf dem Server keine Dateien hochladen. Ein SMH ist daher zurzeit keine Lösung. An einer Änderung dieses Verhaltens wird gearbeitet.
Verwendung als Backend Widget
Mit einigen wenigen Einstellungen erhält jeder Entwickler die Möglichkeit den valumsFileUploader in sein "DCA" zu integrieren.
Codebeispiel
$GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample'] = array ( // Set the button label and the help text 'label' => array('Button label', 'Help text'), // Set field to "valumsFileUploader" 'inputType' => 'valumsFileUploader', // Set special options 'eval' => array( // Set path for files to save 'path' => 'tl_files', // Set the maximum allowed file size 'maxFileSize' => 2048000000, // Set the allowed file extensions comma seperated 'extensions' => 'jpeg, jpg, png', // Set the the value to not override existing files and // choose the value to handle the files (useSuffix, useTimeStamp) 'overwrite' => 'useSuffix', // Set the this value with height and with to resize the file 'resize' => array('800', '800'), // Set debug mode 'debug' => true, // Set label for drop field 'dropTextLabel' => 'Drop text label' ) );
Verfügbare Eval-Optionen
Schlüssel | Wert | Beschreibung | Beispiel |
path | string | Legt das Upload Verzeichnis Fest. | $GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample']['eval']['path'] = 'tl_files'; |
maxFileSize | integer | Legt die maximal erlaubte Dateigröße in Bytes fest. | $GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample']['eval']['maxFileSize'] = 2048000000; |
extensions | string | Legt die Dateierweiterungen Komma separiert fest. | $GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample']['eval']['extensions'] = 'jpeg, jpg, png'; |
overwrite | string | Legt fest das die existieren Dateien in dem Upload Verzeichnis nicht überschrieben werden dürfen, und wie mit den Duplikaten verfahren werden soll. Mögliche Werte sind "useSuffix" und "useTimeStamp". | $GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample']['eval']['overwrite'] = 'useSuffix'; |
resize | array | Durch Setzen der breite und höhe in einem Array wird das Bild beim Upload auf diese Werte runter skaliert. | $GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample']['eval']['resize'] = array('800', '800'); |
debug | bool | Durch setzen dieses Wertes wird der Debug Modus aktiviert oder deaktiviert. | $GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample']['eval']['debug'] = true; |
dropTextLabel | string | Legt das Label für die Drop Zone des Uploaders Fest. | $GLOBALS['TL_DCA']['tl_example']['fields']['vfuExample']['eval']['dropTextLabel'] = 'Drop text label'; |