wThumbnail::getPathThumbnail

Ermittelt den Pfad eines Vorschaubildes

Funktionsaufruf

String getPathThumbnail(String path, Integer width, Integer height, String mode)

Parameter

path

Pfad des Orginalbildes, aus dem das Vorschaubild generiert werden soll

width

Breite des zu erstellenden Vorschaubildes

height

Höhe des zu erstellenden Vorschaubildes

mode

default: Das Bild wird so weit verkleinert, dass beide Seiten in die Vorgabe passen und der ggf. entstehende Leerraum abgeschnitten wird. So kann es sein, dass eine Seite kleiner als angegeben dargestellt wird.
crop: Das Bild wird so weit verkleinert, dass eine Seite in die Vorgabe passt und die ggf. überstehenden Seiten abgeschnitten werden.
cropTop: Wie crop mit Ausrichtung oben
cropRight: Wie crop mit Ausrichtung right
cropBottom: Wie crop mit Ausrichtung unten
cropLeft: Wie crop mit Ausrichtung links
embed: Das Bild wird so weit verkleinert, dass beide Seiten in die Vorgabe passen und der ggf. entstehende Leerraum aufgefüllt wird.
embedTop: Wie embed mit Ausrichtung oben
embedRight: Wie embed mit Ausrichtung rechts
embedBottom: Wie embed mit Ausrichtung unten
embedLeft: Wie embed mit Ausrichtung links
embedTopLeft: Wie embed mit Ausrichtung oben links
embedTopRight: Wie embed mit Ausrichtung oben rechts
embedBottomRight: Wie embed mit Ausrichtung unten rechts
embedBottomLeft: Wie embed mit Ausrichtung unten links
force: Die Größe wird angepasst und das Bild ggf. verzerrt

options

Zusatzoptionen

cutLeft: Linke Position beim Ausschneiden
cutTop: Obere Position beim Ausschneiden
cutWidth: Breite beim Ausschneiden
cutHeight: Höhe beim Ausschneiden
cryptPath: Gibt an, ob der Bildpfad verkryptet werden soll
useTransparency: Falls keine Transparenz benutzt werden darf, muss der Wert auf no stehen
backgroundColor: Falls die Hintergrundfarbe definiert werden soll (z.B. #fcfcfc)
quality: Falls die Qualität bei JPG-Bildern reduziert werden soll (0-100)
filenameOnly: Dateiname (ohne Endung) des generierten Bildes

Beispiel: Ermittelt den Pfad eines Vorschaubildes

Quelltext

<?php

$path    = "/devAssets/img/bild-rot.png";
$width   = "234";
$height  = "123";
$mode    = "embed";
$options = "";
print wPathName::removeDocumentRoot(wThumbnail::getPathThumbnail($path, $width, $height, $mode, $options));

?>

Ergebnis

/devAssets/img/weblication/wThumbnails/bild-rot-219eec19e938a03g3436e090cd6fdecc.png

Hinweis
Beim Einsatz von Framework-Funktionen in eigenen Skripten beachten Sie bitte den Artikel "So verwenden Sie das PHP-Framework in eigenen Scripten".
Wenn Sie eine Funktion innerhalb einer Weblication® Seite z.B. über das PHP-Quelltext Element oder in einem XSL-Template über wsl:php einbinden, muss das Framework über die grid.php nicht mehr referenziert werden.

FAQs

Wofür ist die Funktion wThumbnail::getPathThumbnail gedacht?: Sie ermittelt den Pfad eines Vorschaubildes (Thumbnail) ausgehend von einem Originalbildpfad. Dabei werden Breite/Höhe und ein Darstellungsmodus genutzt, um das Vorschaubild entsprechend zu erzeugen bzw. zu adressieren.
Welche Parameter benötigt wThumbnail::getPathThumbnail?: Die Funktion besitzt die Signatur: <code class="codeInline">String getPathThumbnail(String path, Integer width, Integer height, String mode)</code>. - <code class="codeInline">path</code>: Pfad des Originalbildes - <code class="codeInline">width</code>: gewünschte Breite des Vorschaubildes - <code class="codeInline">height</code>: gewünschte Höhe des Vorschaubildes - <code class="codeInline">mode</code>: Darstellungsmodus (z. B. <code class="codeInline">default</code>, <code class="codeInline">crop</code>, <code class="codeInline">embed</code>, <code class="codeInline">force</code>)
Was macht der Darstellungsmodus <code class="codeInline">default</code>?: Das Bild wird so weit verkleinert, dass beide Seiten in die Vorgabe passen. Entstehender Leerraum kann abgeschnitten werden; dadurch kann eine Seite kleiner als die angegebenen Werte dargestellt werden.
Was bedeutet <code class="codeInline">crop</code> im Modus wThumbnail::getPathThumbnail?: <code class="codeInline">crop</code> verkleinert das Bild so, dass eine Seite in die Vorgabe passt; überstehende Bildbereiche werden abgeschnitten.
Welche Varianten gibt es für <code class="codeInline">crop</code> (z. B. cropTop, cropRight, cropBottom, cropLeft)?: Es gibt Ausrichtungen, die wie <code class="codeInline">crop</code> arbeiten, jedoch mit fester Ausrichtung: - <code class="codeInline">cropTop</code>: wie <code class="codeInline">crop</code>, Ausrichtung oben - <code class="codeInline">cropRight</code>: wie <code class="codeInline">crop</code>, Ausrichtung rechts - <code class="codeInline">cropBottom</code>: wie <code class="codeInline">crop</code>, Ausrichtung unten - <code class="codeInline">cropLeft</code>: wie <code class="codeInline">crop</code>, Ausrichtung links
Was macht der Modus <code class="codeInline">embed</code>?: <code class="codeInline">embed</code> verkleinert das Bild so, dass beide Seiten in die Vorgabe passen. Entstehender Leerraum wird nicht abgeschnitten, sondern aufgefüllt (also „eingebettet“).
Welche <code class="codeInline">embed</code>-Varianten mit Ausrichtung gibt es?: Zusätzlich zu <code class="codeInline">embed</code> gibt es ausgerichtete Varianten: - <code class="codeInline">embedTop</code>, <code class="codeInline">embedRight</code>, <code class="codeInline">embedBottom</code>, <code class="codeInline">embedLeft</code> - sowie Kombinationen wie <code class="codeInline">embedTopLeft</code>, <code class="codeInline">embedTopRight</code>, <code class="codeInline">embedBottomRight</code>, <code class="codeInline">embedBottomLeft</code>
Was macht der Modus <code class="codeInline">force</code>?: Die Zielgröße wird erzwungen; das Bild kann dadurch verzerrt werden, falls das Seitenverhältnis nicht exakt passt.
Welche Zusatzoptionen gibt es (options) für die Vorschaubild-Erstellung?: Als <code class="codeInline">options</code> werden zusätzliche Parameter unterstützt, u. a.: - <code class="codeInline">cutLeft</code>, <code class="codeInline">cutTop</code>, <code class="codeInline">cutWidth</code>, <code class="codeInline">cutHeight</code>: Position und Abmessungen beim Ausschneiden - <code class="codeInline">cryptPath</code>: steuert, ob der Bildpfad verkryptet werden soll - <code class="codeInline">useTransparency</code>: falls keine Transparenz erlaubt ist, muss der Wert auf <code class="codeInline">no</code> stehen - <code class="codeInline">backgroundColor</code>: Hintergrundfarbe für Flächen (z. B. <code class="codeInline">#fcfcfc</code>) - <code class="codeInline">quality</code>: JPG-Qualität (0–100) - <code class="codeInline">filenameOnly</code>: Dateiname (ohne Endung) des generierten Bildes
Wie sieht ein Beispiel-Usage von wThumbnail::getPathThumbnail aus?: Beispiel (vereinfacht): <pre><code class="codeBlock" style="color: #000000">php $path = "/devAssets/img/bild-rot.png"; $width = "234"; $height = "123"; $mode = "embed"; $options = ""; print wPathName::removeDocumentRoot( wThumbnail::getPathThumbnail($path, $width, $height, $mode, $options) ); </code></pre>
Welches Ergebnis (Pfad) kann wThumbnail::getPathThumbnail liefern (Beispiel)?: Im Beispiel wird ein generierter Thumbnail-Pfad zurückgegeben, z. B.: <code class="codeInline">/devAssets/img/weblication/wThumbnails/bild-rot-219eec19e938a03g3436e090cd6fdecc.png</code>.