image
extends file
in package
implements
validateFileType, isCopyable
Image file objekt
Tags
Interfaces, Classes, Traits and Enums
- validateFileType
- Interface for fiel type validation function
- isCopyable
- Interface for objects with build in cache loader
Table of Contents
- $allowedExts : array<string|int, mixed>
- Erlaubte Dateiendungen
- $allowedTypes : array<string|int, mixed>
- Erlaubte Dateitypen
- $alttext : string
- Alternate text
- $cache : cache
- Cache-Objekt
- $cacheModule : string
- Cache Modul
- $cacheName : string
- Cache name
- $config : config
- System-Config-Objekt
- $content : string
- Dateiinhalt
- $data : array<string|int, mixed>
- data-Array für nicht weiter definierte Eigenschaften
- $dbcon : database
- DB-Verbindung
- $dbParams : array<string|int, mixed>
- Felder die in Datenbank gespeichert werden können
- $events : events
- Event-Liste
- $extension : string
- Dateierweiterung
- $filename : string
- Dateiname
- $filepath : string
- Dateispfad
- $filesize : int
- Dateigröße
- $filetime : int
- Zeitpunkt des Uploads
- $fullpath : string
- Dateipfad inkl. Dateiname
- $height : int
- Bild-Höhe
- $id : int
- ID von Datei-Eintrag in DB
- $iptcStr : string
- Exif/ IPCT data
- $isIndexed : bool
- Flag if file is in file index
- $language : language
- System-Sprachen-Objekt
- $mimetype : string
- MIME-Dateityp-Info
- $notifications : notifications
- Notifications
- $table : string
- Tabellen-Name
- $userid : int
- Benutzer-ID des Uploaders
- $whstring : string
- String in der Form width="" height=""
- $width : int
- Bild-Breite
- __construct() : bool
- Konstruktor
- addUploadFolder() : bool
- Add upload sub folder string
- copy() : int
- Creates copy of current object
- createFromDbObject() : bool
- Füllt Objekt mit Daten aus Datenbank-Result
- createThumbnail() : bool
- Erzeugt ein Thumbnail für das aktuelle Bild
- delete() : bool
- Löscht Datei-Eintrag in Datenbank und Datei in Dateisystem
- escapeFileName() : mixed
- Bereinigt Dateiname von problematischen Zeichen
- exists() : bool
- Check if image exists
- existsFolder() : bool
- Prüft, ob Bild nur in Dateisystem existiert
- getAltText() : string
- Get alternate text
- getContent() : string
- Dateiinhalt
- getCropperFilename() : string
- Get cropper filename string
- getCryptFileName() : string
- Returns encrypted filename
- getData() : array<string|int, mixed>
- Gibt Inhalt von "data" zurück
- getExtension() : string
- Erweiterung
- getFileHash() : string
- File SHA256 hash
- getFileManagerThumbnail() : string
- Dateimanager-Thumbnail-Pfad ausgeben
- getFileManagerThumbnailUrl() : string
- Dateimanager-Thumbnail ausgeben
- getFilename() : string
- Dateiname
- getFileNameHash() : string
- Return hash based on filename
- getFilepath() : string
- Dateipfad
- getFilesize() : int
- Dateigröße
- getFiletime() : int
- Upload-Zeit ausgeben
- getFullpath() : string
- Dateipfad + Dateiname
- getHeight() : int
- Höhe ausgeben
- getId() : int
- Datensatz-ID
- getImageUrl() : string
- Bild-Url ausgeben
- getIptcStr() : string
- Returns IPTC credit string
- getMimetype() : int
- MIME-Type ausgeben
- getModificationTime() : int
- Return file upload time in file system
- getPropertiesArray() : array<string|int, mixed>
- Return properties array
- getThumbnail() : string
- Thumbnail-Pfad ausgeben
- getThumbnailFull() : string
- kompletten Thumbnail-Pfad ausgeben
- getThumbnailUrl() : string
- Thumbnail-Url ausgeben
- getUserid() : int
- Uploader-ID ausgeben
- getWhstring() : string
- String width="" height="" auslesen
- getWidth() : int
- Breite ausgeben
- hasFileManageThumbnail() : bool
- Checks if file amanager thumbnail exists
- isReadable() : bool
- ist Datei lesbar
- isValidDataFolder() : bool
- Check if fullpath is valid path in /data folder structure
- isValidType() : bool
- Check if file extension and file type is valid
- isWritable() : bool
- ist Datei beschreibbar
- loadContent() : bool
- Lädt Inhalt von gespeicherter Datei
- moveUploadedFile() : bool
- Verschiebt via PHP Upload hochgeladene Datei von tmp-Pfad nach Zielpfad
- parseIptc() : bool
- reads IPTC data from file
- rename() : bool
- Benennt eine Datei um
- retrieveFileExtension() : string
- Retrieve file extension via pathinfo
- retrieveFileName() : string
- Retrieve file name via pathinfo
- retrieveRealType() : string
- Retrieve real file path via finfo
- save() : bool
- Speichert einen neuen Datei-Eintrag in der Datenbank
- setAltText() : mixed
- Set alternate text
- setContent() : mixed
- Dateiinhalt setzen
- setFilename() : mixed
- Dateiname setzen
- setFiletime() : mixed
- Upload-Zeit setzen
- setId() : mixed
- Datensatz-ID setzen
- setUserid() : mixed
- Benutzer-ID setzen
- update() : bool
- Aktualisiert einen Datei-Eintrag in der Datenbank
- writeContent() : bool
- Lädt Inhalt von gespeicherter Datei
- basePath() : string
- Returns base path for file
- getPreparedSaveParams() : array<string|int, mixed>
- Bereitet Eigenschaften des Objects zum Speichern ind er Datenbank vor und entfernt nicht speicherbare Eigenschaften
- getSaveValues() : array<string|int, mixed>
- Gibt Speicher-Values zurück
- init() : bool
- initialisiert Bild-Objekt
- realpathNoExists() : string
- "realpath" wrapper for non-existing files
- splitFilename() : string
- Splits filename with possible folder
Properties
$allowedExts
Erlaubte Dateiendungen
public
static array<string|int, mixed>
$allowedExts
= ['jpeg', 'jpg', 'png', 'gif']
$allowedTypes
Erlaubte Dateitypen
public
static array<string|int, mixed>
$allowedTypes
= ['image/jpeg', 'image/jpg', 'image/png', 'image/gif']
$alttext
Alternate text
protected
string
$alttext
$cache
Cache-Objekt
protected
cache
$cache
$cacheModule
Cache Modul
protected
string
$cacheModule
= ''
Tags
$cacheName
Cache name
protected
string
$cacheName
= false
$config
System-Config-Objekt
protected
config
$config
$content
Dateiinhalt
protected
string
$content
$data
data-Array für nicht weiter definierte Eigenschaften
protected
array<string|int, mixed>
$data
$dbcon
DB-Verbindung
protected
database
$dbcon
$dbParams
Felder die in Datenbank gespeichert werden können
protected
array<string|int, mixed>
$dbParams
= ['userid', 'filename', 'filetime', 'filesize', 'alttext']
$events
Event-Liste
protected
events
$events
$extension
Dateierweiterung
protected
string
$extension
$filename
Dateiname
protected
string
$filename
$filepath
Dateispfad
protected
string
$filepath
$filesize
Dateigröße
protected
int
$filesize
$filetime
Zeitpunkt des Uploads
protected
int
$filetime
$fullpath
Dateipfad inkl. Dateiname
protected
string
$fullpath
$height
Bild-Höhe
protected
int
$height
$id
ID von Datei-Eintrag in DB
protected
int
$id
$iptcStr
Exif/ IPCT data
protected
string
$iptcStr
$isIndexed
Flag if file is in file index
protected
bool
$isIndexed
= false
Tags
$language
System-Sprachen-Objekt
protected
language
$language
$mimetype
MIME-Dateityp-Info
protected
string
$mimetype
$notifications
Notifications
protected
notifications
$notifications
Tags
$table
Tabellen-Name
protected
string
$table
$userid
Benutzer-ID des Uploaders
protected
int
$userid
$whstring
String in der Form width="" height=""
protected
string
$whstring
$width
Bild-Breite
protected
int
$width
Methods
__construct()
Konstruktor
public
__construct([string $filename = '' ][, bool $initDB = true ]) : bool
Parameters
- $filename : string = ''
-
file name including sub path
- $initDB : bool = true
-
Datenbank-Eintrag initialisieren
Return values
bool —addUploadFolder()
Add upload sub folder string
public
addUploadFolder() : bool
Tags
Return values
bool —copy()
Creates copy of current object
public
copy() : int
Return values
int —createFromDbObject()
Füllt Objekt mit Daten aus Datenbank-Result
public
createFromDbObject(object $object) : bool
Parameters
- $object : object
Tags
Return values
bool —createThumbnail()
Erzeugt ein Thumbnail für das aktuelle Bild
public
createThumbnail() : bool
Return values
bool —delete()
Löscht Datei-Eintrag in Datenbank und Datei in Dateisystem
public
delete() : bool
Return values
bool —escapeFileName()
Bereinigt Dateiname von problematischen Zeichen
public
escapeFileName(string &$filename) : mixed
Parameters
- $filename : string
Return values
mixed —exists()
Check if image exists
public
exists([type $dbOnly = false ]) : bool
Parameters
- $dbOnly : type = false
Return values
bool —existsFolder()
Prüft, ob Bild nur in Dateisystem existiert
public
existsFolder() : bool
Tags
Return values
bool —getAltText()
Get alternate text
public
getAltText() : string
Tags
Return values
string —getContent()
Dateiinhalt
public
getContent() : string
Return values
string —getCropperFilename()
Get cropper filename string
public
static getCropperFilename(string &$filename) : string
Parameters
- $filename : string
Tags
Return values
string —getCryptFileName()
Returns encrypted filename
public
getCryptFileName() : string
Tags
Return values
string —getData()
Gibt Inhalt von "data" zurück
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getExtension()
Erweiterung
public
getExtension() : string
Return values
string —getFileHash()
File SHA256 hash
public
getFileHash() : string
Tags
Return values
string —getFileManagerThumbnail()
Dateimanager-Thumbnail-Pfad ausgeben
public
getFileManagerThumbnail() : string
Return values
string —getFileManagerThumbnailUrl()
Dateimanager-Thumbnail ausgeben
public
getFileManagerThumbnailUrl() : string
Return values
string —getFilename()
Dateiname
public
getFilename() : string
Return values
string —getFileNameHash()
Return hash based on filename
public
getFileNameHash() : string
Tags
Return values
string —getFilepath()
Dateipfad
public
getFilepath() : string
Return values
string —getFilesize()
Dateigröße
public
getFilesize() : int
Return values
int —getFiletime()
Upload-Zeit ausgeben
public
getFiletime() : int
Return values
int —getFullpath()
Dateipfad + Dateiname
public
getFullpath() : string
Return values
string —getHeight()
Höhe ausgeben
public
getHeight() : int
Return values
int —getId()
Datensatz-ID
public
getId() : int
Return values
int —getImageUrl()
Bild-Url ausgeben
public
getImageUrl() : string
Return values
string —getIptcStr()
Returns IPTC credit string
public
getIptcStr() : string
Return values
string —getMimetype()
MIME-Type ausgeben
public
getMimetype() : int
Return values
int —getModificationTime()
Return file upload time in file system
public
getModificationTime() : int
Return values
int —getPropertiesArray()
Return properties array
public
getPropertiesArray(string $userName) : array<string|int, mixed>
Parameters
- $userName : string
Tags
Return values
array<string|int, mixed> —getThumbnail()
Thumbnail-Pfad ausgeben
public
getThumbnail() : string
Return values
string —getThumbnailFull()
kompletten Thumbnail-Pfad ausgeben
public
getThumbnailFull() : string
Return values
string —getThumbnailUrl()
Thumbnail-Url ausgeben
public
getThumbnailUrl() : string
Return values
string —getUserid()
Uploader-ID ausgeben
public
getUserid() : int
Return values
int —getWhstring()
String width="" height="" auslesen
public
getWhstring() : string
Return values
string —getWidth()
Breite ausgeben
public
getWidth() : int
Return values
int —hasFileManageThumbnail()
Checks if file amanager thumbnail exists
public
hasFileManageThumbnail() : bool
Tags
Return values
bool —isReadable()
ist Datei lesbar
public
isReadable() : bool
Tags
Return values
bool —isValidDataFolder()
Check if fullpath is valid path in /data folder structure
public
isValidDataFolder([string $path = '' ][, string $type = '/' ]) : bool
Parameters
- $path : string = ''
- $type : string = '/'
Tags
Return values
bool —isValidType()
Check if file extension and file type is valid
public
static isValidType(string $ext, string $type[, array<string|int, mixed> $map = [] ]) : bool
Parameters
- $ext : string
- $type : string
- $map : array<string|int, mixed> = []
Tags
Return values
bool —isWritable()
ist Datei beschreibbar
public
isWritable() : bool
Tags
Return values
bool —loadContent()
Lädt Inhalt von gespeicherter Datei
public
loadContent() : bool
Tags
Return values
bool —moveUploadedFile()
Verschiebt via PHP Upload hochgeladene Datei von tmp-Pfad nach Zielpfad
public
moveUploadedFile(string $uploadedPath) : bool
Parameters
- $uploadedPath : string
Tags
Return values
bool —parseIptc()
reads IPTC data from file
public
parseIptc(array<string|int, mixed> $info) : bool
Parameters
- $info : array<string|int, mixed>
Tags
Return values
bool —rename()
Benennt eine Datei um
public
rename(string $newname[, int $userId = false ]) : bool
Parameters
- $newname : string
- $userId : int = false
Return values
bool —retrieveFileExtension()
Retrieve file extension via pathinfo
public
static retrieveFileExtension(string $filename) : string
Parameters
- $filename : string
Tags
Return values
string —retrieveFileName()
Retrieve file name via pathinfo
public
static retrieveFileName(string $filename) : string
Parameters
- $filename : string
Tags
Return values
string —retrieveRealType()
Retrieve real file path via finfo
public
static retrieveRealType(string $path) : string
Parameters
- $path : string
Tags
Return values
string —save()
Speichert einen neuen Datei-Eintrag in der Datenbank
public
save() : bool
Return values
bool —setAltText()
Set alternate text
public
setAltText(string $alttext) : mixed
Parameters
- $alttext : string
-
#@since 4.5
Return values
mixed —setContent()
Dateiinhalt setzen
public
setContent(string $content) : mixed
Parameters
- $content : string
Return values
mixed —setFilename()
Dateiname setzen
public
setFilename(string $filename) : mixed
Parameters
- $filename : string
Return values
mixed —setFiletime()
Upload-Zeit setzen
public
setFiletime(int $filetime) : mixed
Parameters
- $filetime : int
Return values
mixed —setId()
Datensatz-ID setzen
public
setId(int $id) : mixed
Parameters
- $id : int
Return values
mixed —setUserid()
Benutzer-ID setzen
public
setUserid(int $userid) : mixed
Parameters
- $userid : int
Return values
mixed —update()
Aktualisiert einen Datei-Eintrag in der Datenbank
public
update() : bool
Return values
bool —writeContent()
Lädt Inhalt von gespeicherter Datei
public
writeContent() : bool
Tags
Return values
bool —basePath()
Returns base path for file
protected
basePath(string $filename) : string
Parameters
- $filename : string
Return values
string —getPreparedSaveParams()
Bereitet Eigenschaften des Objects zum Speichern ind er Datenbank vor und entfernt nicht speicherbare Eigenschaften
protected
getPreparedSaveParams() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getSaveValues()
Gibt Speicher-Values zurück
protected
getSaveValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —init()
initialisiert Bild-Objekt
protected
init(bool $initDB) : bool
Parameters
- $initDB : bool
Return values
bool —realpathNoExists()
"realpath" wrapper for non-existing files
protected
realpathNoExists(string $path) : string
Parameters
- $path : string
Tags
Return values
string —splitFilename()
Splits filename with possible folder
protected
splitFilename(string $filename) : string
Parameters
- $filename : string