Contao Community Documentation - Benutzerbeiträge [de]

Arbeiten mit Bildern

2014-09-03T11:44:53Z

Mindbird: /* Image Klasse */

[[Category:Dev HOWTOS]]
[[Category:Dev Snippets]]{{AppliesTo
|TLVersion=ab 2.7
|Version=ab 2.9
}}
Das Contao-Framework stellt folgende Methoden für das Arbeiten mit Bildern zur Verfügung:
# generateImage()
# getImage()
# Image Klasse
Die Original-Daten, welche meistens unter dem Ordner '''tl_files''' abgelegt sind werden aufbereitet.
Hierzu wird das Bild in der entsprechenden Größe unter '''system/html''' abgelegt und auf der Webseite werden nur noch Verweise auf diese erzeugte Kopie ausgegeben.

== getImage() ==
Die Methode getImage() ist in der Datei system/libraries/Controller.php angesiedelt und stellt fünf Parameter zur Verfügung, von welchen die ersten drei verpflichtend sind.
Die Methode erstellt eine neue Version des Original-Bildes und legt dieses im Cache Verzeichnis /system/html ab, sofern der Parameter $target nicht übergeben wird.
Es wird der Pfad zum neuen Bild zurück gegeben, wenn die Verarbeitung funktioniert hat.

Aktuell verarbeitet Contao die Bildformate welche von PHP (gdlib) unterstützt werden: jpeg, jpg, png und gif (nur lesen)

=== Parameter ===
# $image: Enthält den Pfad zu dem Bild welches bearbeitet werden soll. (BSP: tl_files/images/foobar.jpg)
# $width: enthält die gewünschte Breite des Bildes (z.B.: 200)
# $height: enthält die gewünschte Höhe des Bildes (z.B.: 250)
# $mode: optionale Angabe der Skallierungsmethode
## proportional
## box
## crop (obsolet seit 2.11)
## left_top (seit 2.11)
## center_top (seit 2.11)
## right_top (seit 2.11)
## left_center (seit 2.11)
## center_center ( seit 2.11 - rückwärtskompatibel für crop)
## right_center (seit 2.11)
## left_bottom (seit 2.11)
## center_bottom (seit 2.11)
## right_bottom (seit 2.11)

# $target: Ort an dem das neue Bild gespeichert werden soll, relativ zu TL_ROOT.

== generateImage() ==
Die Methode generateImage() ist ebenfalls in der Controller.php angesiedelt und erzeugt einen HTML <img> Tag welcher in einem Template ausgegeben werden kann. Diese Methode besitzt 3 Parameter wovon nur der Erste verpflichtend angegeben werden muss. Wird beim Parameter $src kein Pfad angegeben, sondern nur ein Bildname (Pfade beginnen immer mit / und sind relativ zum TL_ROOT zu verstehen, Bildnamen nicht) so sucht Contao das Bild im aktuellen Themes Verzeichnis. (i.d.R.: /system/themes/default/images/ sofern kein anderes Backend-Theme gewählt wurde).

=== Parameter ===
# $src: Der Pfad zum Bild welches eingebunden werden soll. (hier kann z.B. der Rückgabewert der Methode getImage() verwendet werden)
# $alt: Angabe eines Wertes für das alt-Attribut. Dieser ist laut [[w:de:W3C|W3C]] Pflicht und sollte immer angegeben werden.
# $attributes: Angabe weiterer Attribute für das zu erzeugende <img> Tag. (z.B.: inline [[w:de:CSS|CSS]] via style Attribut, etc.)

== Codebeispiele ==
Mit folgendem Code kann eine neue verkleinerte Version eines Bildes im Cache abgelegt und auf der Seite ausgegeben werden:
<source lang="php">
$strReturn = $this->generateImage($this->getImage('tl_files/images/foobar.jpg', 300, 250, 'proportional'), 'my first image');
// nun den Wert an ein Template übergeben.
$this->Template->myFirstImage = $strReturn;
</source>

== Image Klasse ==
Seit Contao 3? steht eine eigene [http://api.contao.org/classes/Contao.Image.html Image Klasse] zur Verfügung. Über diese können Bilder in der Größe geändert und überschrieben werden oder eine Kopie des Originalbildes in der entsprechenden Größe angelegt werden.

Arbeiten mit Bildern

2014-09-03T11:44:09Z

Mindbird:

[[Category:Dev HOWTOS]]
[[Category:Dev Snippets]]{{AppliesTo
|TLVersion=ab 2.7
|Version=ab 2.9
}}
Das Contao-Framework stellt folgende Methoden für das Arbeiten mit Bildern zur Verfügung:
# generateImage()
# getImage()
# Image Klasse
Die Original-Daten, welche meistens unter dem Ordner '''tl_files''' abgelegt sind werden aufbereitet.
Hierzu wird das Bild in der entsprechenden Größe unter '''system/html''' abgelegt und auf der Webseite werden nur noch Verweise auf diese erzeugte Kopie ausgegeben.

== getImage() ==
Die Methode getImage() ist in der Datei system/libraries/Controller.php angesiedelt und stellt fünf Parameter zur Verfügung, von welchen die ersten drei verpflichtend sind.
Die Methode erstellt eine neue Version des Original-Bildes und legt dieses im Cache Verzeichnis /system/html ab, sofern der Parameter $target nicht übergeben wird.
Es wird der Pfad zum neuen Bild zurück gegeben, wenn die Verarbeitung funktioniert hat.

Aktuell verarbeitet Contao die Bildformate welche von PHP (gdlib) unterstützt werden: jpeg, jpg, png und gif (nur lesen)

=== Parameter ===
# $image: Enthält den Pfad zu dem Bild welches bearbeitet werden soll. (BSP: tl_files/images/foobar.jpg)
# $width: enthält die gewünschte Breite des Bildes (z.B.: 200)
# $height: enthält die gewünschte Höhe des Bildes (z.B.: 250)
# $mode: optionale Angabe der Skallierungsmethode
## proportional
## box
## crop (obsolet seit 2.11)
## left_top (seit 2.11)
## center_top (seit 2.11)
## right_top (seit 2.11)
## left_center (seit 2.11)
## center_center ( seit 2.11 - rückwärtskompatibel für crop)
## right_center (seit 2.11)
## left_bottom (seit 2.11)
## center_bottom (seit 2.11)
## right_bottom (seit 2.11)

# $target: Ort an dem das neue Bild gespeichert werden soll, relativ zu TL_ROOT.

== generateImage() ==
Die Methode generateImage() ist ebenfalls in der Controller.php angesiedelt und erzeugt einen HTML <img> Tag welcher in einem Template ausgegeben werden kann. Diese Methode besitzt 3 Parameter wovon nur der Erste verpflichtend angegeben werden muss. Wird beim Parameter $src kein Pfad angegeben, sondern nur ein Bildname (Pfade beginnen immer mit / und sind relativ zum TL_ROOT zu verstehen, Bildnamen nicht) so sucht Contao das Bild im aktuellen Themes Verzeichnis. (i.d.R.: /system/themes/default/images/ sofern kein anderes Backend-Theme gewählt wurde).

=== Parameter ===
# $src: Der Pfad zum Bild welches eingebunden werden soll. (hier kann z.B. der Rückgabewert der Methode getImage() verwendet werden)
# $alt: Angabe eines Wertes für das alt-Attribut. Dieser ist laut [[w:de:W3C|W3C]] Pflicht und sollte immer angegeben werden.
# $attributes: Angabe weiterer Attribute für das zu erzeugende <img> Tag. (z.B.: inline [[w:de:CSS|CSS]] via style Attribut, etc.)

== Codebeispiele ==
Mit folgendem Code kann eine neue verkleinerte Version eines Bildes im Cache abgelegt und auf der Seite ausgegeben werden:
<source lang="php">
$strReturn = $this->generateImage($this->getImage('tl_files/images/foobar.jpg', 300, 250, 'proportional'), 'my first image');
// nun den Wert an ein Template übergeben.
$this->Template->myFirstImage = $strReturn;
</source>

== Image Klasse ==
Seit Contao 3? steht eine eigene [http://http://api.contao.org/classes/Contao.Image.html Image Klasse] zur Verfügung. Über diese können Bilder in der Größe geändert und überschrieben werden oder eine Kopie des Originalbildes in der entsprechenden Größe angelegt werden.