Class: base_thumbnail

Quellcode Position: Program_Root/base_thumbnail.php

Class base_thumbnail

Class Overview

thumbnail creation

Implementiert in Program_Root/base_thumbnail.php [Zeile 16]

Author(s):

Thomas Weinert <weinert@papaya-cms.com>

Information Tags:

Properties

Methods

[ Seitenanfang ]

Properties Summary

string	$basepath	base path for images
string	$bicubic	use php emulation for bicubic resize - really slow
string	$createall	ignore cache and create
string	$error	error messages
string	$height	thumbnail height
string	$imgtypes	supported image types
string	$jpegquality	jpeg quality for thumbnail output
string	$resizeflag	resize mode (max = maximal, min = minimal, mincrop = minimal cropped, abs = absolute)
string	$thumbpath	base path for thumbnails
string	$thumbtype	output filetype
string	$tmpfile	path to a template file for thumbnails
string	$width	thumbnail width

[ Seitenanfang ]

Method Summary

base_thumbnail	base_thumbnail()	Constructor
array	calcSize()	Berechnet die ...
boolean	checkTypeInGD()	Prueft, ob der Server das uebergebene Bildformat verarbeiten kann.
mixed	createThumb()	Ein neues Thumbnail wird erstellt
boolean	deleteThumb()	Loescht den uebergebenen Thumbnail mit Namen $filename.
boolean	deleteThumbs()	Loescht alle Thumbnails, die von einem angegebenen Bild stammen.
string	getFilename()	Berechnet die ...
???	getThumb()	??? helpme
ImageCopyResampleBicubic()	Image copy resample bicubic
boolean	ImageCrop()	Das Bild wird beschnitten
Das	loadFile()	Es wird im Speicher eine Kopie der in den Parametern uebergebenen Datei angelegt und als Ergebnis zurueckgeliefert.
integer	return_bytes()	Convert memory amounts to bytes
mixed	saveFile()	Die im Speicher gehaltene Thumbnail wird nun gespeichert.
void	setError()	Schreibt einen Fehler in die Fehlervariable.

[ Seitenanfang ]

Properties

string $basepath [Zeile 21]

base path for images

[ Seitenanfang ]

string $bicubic = false [Zeile 87]

use php emulation for bicubic resize - really slow

[ Seitenanfang ]

string $createall = false [Zeile 51]

ignore cache and create

[ Seitenanfang ]

string $error [Zeile 81]

error messages

[ Seitenanfang ]

string $height = 100 [Zeile 39]

thumbnail height

[ Seitenanfang ]

string $imgtypes [Zeile 75]

supported image types

[ Seitenanfang ]

string $jpegquality = 60 [Zeile 63]

jpeg quality for thumbnail output

[ Seitenanfang ]

string $resizeflag = max [Zeile 45]

resize mode (max = maximal, min = minimal, mincrop = minimal cropped, abs = absolute)

[ Seitenanfang ]

string $thumbpath [Zeile 27]

base path for thumbnails

[ Seitenanfang ]

string $thumbtype = PAPAYA_THUMBS_FILETYPE [Zeile 57]

output filetype

[ Seitenanfang ]

string $tmpfile = ./border.jpg [Zeile 69]

path to a template file for thumbnails

[ Seitenanfang ]

string $width = 100 [Zeile 33]

thumbnail width

[ Seitenanfang ]

Methods

Constructor base_thumbnail [Zeile 92]

base_thumbnail base_thumbnail(
)

Constructor

[ Seitenanfang ]

calcSize [Zeile 144]

array calcSize(
integer
$org_width, integer
$org_height, [integer
$mode = NULL] 
)

Berechnet die ...

von ...???helpme

??? helpme

Parameters:

integer	$org_width:	???
integer	$org_height:	???
integer	$mode:	???

API Tags:

Return:

array($new_width,$new_height)

[ Seitenanfang ]

checkTypeInGD [Zeile 106]

boolean checkTypeInGD(
integer
$type 
)

Prueft, ob der Server das uebergebene Bildformat verarbeiten kann.

Parameters:

integer

$type:

Bildtyp

API Tags:

Return:

true, wenn das Bildformat vom Server unterstuetzt wird und false, wenn der Server das Bildformat nicht unterstuetzt.

[ Seitenanfang ]

createThumb [Zeile 286]

mixed createThumb(
string
$imgfile, string
$thumbfile, integer
$org_type, integer
$org_width, integer
$org_height, integer
$thumb_width, integer
$thumb_height 
)

Ein neues Thumbnail wird erstellt

Parameters:

string	$imgfile:	Die Bilddatei, von der ein Thumbnail erstellt werden soll
string	$thumbfile:	Dateiname der zu erstellenden Thumbnail-Datei
integer	$org_type:
integer	$org_width:	Breite von ??? helpme
integer	$org_height:	Hoehe von ??? helpme
integer	$thumb_width:	Breite von ??? helpme
integer	$thumb_height:	Hoehe von ??? helpme

API Tags:

Return:

Wenn Datei erstellt werden konnte, dann wird der Pfad der neuen Datei zurueckgegeben, bei einem Fehler wird false geliefert.

[ Seitenanfang ]

deleteThumb [Zeile 434]

boolean deleteThumb(
$filename
$filename 
)

Loescht den uebergebenen Thumbnail mit Namen $filename.

Parameters:

$filename

$filename:

Dateiname

API Tags:

Return:

True, wenn Datei geloscht werden konnte und false, wenn Datei nicht geloscht werden konnte.

[ Seitenanfang ]

deleteThumbs [Zeile 364]

boolean deleteThumbs(
$filename
$imgfile 
)

Loescht alle Thumbnails, die von einem angegebenen Bild stammen.

Es konnen naemlich durchaus mehrere Thumbnails eines Bildes existieren.

Parameters:

$filename

$imgfile:

Dateiname

API Tags:

Return:

True, wenn Datei geloscht werden konnte und false, wenn Datei nicht geloscht werden konnte.

[ Seitenanfang ]

getFilename [Zeile 240]

string getFilename(
string
$string, integer
$width, integer
$height, integer
$imgtype, [string
$filter = ''] 
)

Berechnet die ...

von ...???helpme

??? helpme

Parameters:

string	$string:
integer	$width:	Die Breite des Bildes
integer	$height:	Die Hoehe des Bildes
integer	$imgtype:	Bildtyp der Bilddatei
string	$filter:	??? helpme

API Tags:

Return:

Name der Datei??? helpme

[ Seitenanfang ]

getThumb [Zeile 384]

??? getThumb(
$filename
$filename 
)

??? helpme

Parameters:

$filename

$filename:

Dateiname

API Tags:

Return:

helpme

[ Seitenanfang ]

ImageCopyResampleBicubic [Zeile 534]

 ImageCopyResampleBicubic(
&$dst_img
&$dst_img, &$src_img
&$src_img, integer
$dst_x, integer
$dst_y, integer
$src_x, integer
$src_y, integer
$dst_w, integer
$dst_h, mixed
$src_w, mixed
$src_h 
)

Image copy resample bicubic

Parameters:

integer	$dst_x:
integer	$dst_y:
integer	$src_x:
integer	$src_y:
integer	$dst_w:
integer	$dst_h:
&$dst_img	&$dst_img:
&$src_img	&$src_img:

API Tags:

Access:

public

[ Seitenanfang ]

ImageCrop [Zeile 480]

boolean ImageCrop(
string
$src_filename, string
$dest_filename, integer
$width, integer
$height 
)

Das Bild wird beschnitten

Parameters:

string	$src_filename:	Quell-Dateiname
string	$dest_filename:	Ziel-Dateiname
integer	$width:	Breite
integer	$height:	Hoehe

API Tags:

Return:

True, wenn Datei beschnitten und gespeichert werden konnte und false, wenn ein Fehler auftrat.

[ Seitenanfang ]

loadFile [Zeile 186]

Das loadFile(
string
$filename, mixed
$filetype, integer
$fieltype 
)

Es wird im Speicher eine Kopie der in den Parametern uebergebenen Datei angelegt und als Ergebnis zurueckgeliefert.

Parameters:

string	$filename:	Dateiname der Bilddatei
integer	$fieltype:	Bildtyp der Datei

API Tags:

Return:

im Speicher neu erzeugte Bild

[ Seitenanfang ]

return_bytes [Zeile 257]

integer return_bytes(
string
$val 
)

Convert memory amounts to bytes

Parameters:

string

$val:

API Tags:

Access:

public

[ Seitenanfang ]

saveFile [Zeile 210]

mixed saveFile(
object
$im, string
$filename, integer
$filetype 
)

Die im Speicher gehaltene Thumbnail wird nun gespeichert.

Parameters:

object	$im:	Die erzeugte Bilddatei im Speicher
string	$filename:	Dateiname der zu speichernden Datei
integer	$filetype:	Dateityp der Thumbnaildatei

API Tags:

Return:

Wenn Datei geschrieben werden konnte, dann wird der Pfad der neuen Datei zurueckgegeben, bei einem Fehler wird false geliefert.

[ Seitenanfang ]

setError [Zeile 466]

void setError(
$level
$level, $msg
$msg 
)

Schreibt einen Fehler in die Fehlervariable.

Es wird immer nur die letzt Fehlermeldung gespeichert.

Parameters:

$level	$level:	Level
$msg	$msg:	Fehlermeldung

[ Seitenanfang ]