Öffentliche Methoden
	__construct ($source=null, $pool='', $dir='')

	convertImage ($format, $reset=false)

	clearConvertedImages ($format='')

	getConvertedImages ()

	error ($image=false, $code=404)

	setName ($name)

	getName ()

	read ($download=false)

	download ()

	pdf ($name='', $temporary=true, $cookie=true, $return=1)

	transform ($width, $height, $modify=array())

	setFile ($file)

	removeFile ()

	setCache ($cache, $etag='')

	setTemporary ($temporary)

	createArchive ($path, $type='tar')

	getFile ()

Öffentliche, statische Methoden
static	export ($key, $type)

Statische öffentliche Attribute
static	$convert_types

Ausführliche Beschreibung

Mit dieser Klasse lässt sich eine Dateiausgabe durchführen.

Der Konstruktor kann in drei Arten verwendet werden: new Ego_Output($page): Multimedia Datei einer Page new Ego_Output($page, 'Datei.png'): Mediapool Datei einer Page new Ego_Output('Datei.png'): Direkte Datei

Mit read() wird die Datei im Browser ausgegeben. Mit download() wird die Datei im Browser zum Download angeboten.

Mit $_REQUEST['width'] und $_REQUEST['height'], bzw. mit transform(width, height), kann die Datei vor der Ausgabe skaliert werden (sofern es sich um ein Bild handelt).

Ist $_REQUEST['max'] gesetzt, dann verhalten sich die Werte wie maxWidth und maxHeight.

Autor: dg

Definiert in Zeile 28 der Datei Ego_Output.php.

Beschreibung der Konstruktoren und Destruktoren

◆ __construct()

__construct	(	$source = `null`,
		$pool = `''`,
		$dir = `''`
	)

Konstruktor

Parameter

Page \| string	$source
string	$pool
string	$dir

Definiert in Zeile 178 der Datei Ego_Output.php.

Benutzt convertImage(), Ego_System\dateEncode(), Ego_System\file_exists(), Ego_System\file_put_contents(), Ego_System\getFormats(), setFile(), setTemporary() und Ego_System\VIDEO_RESOLUTIONS.

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Dokumentation der Elementfunktionen

◆ clearConvertedImages()

clearConvertedImages ( $format = '' )

Alle umgewandelten Bilder dieser Datei löschen

Parameter

string $format Alle Formate oder nur ein bestimmtes Format

Rückgabe: void

Definiert in Zeile 512 der Datei Ego_Output.php.

Wird benutzt von convertImage().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ convertImage()

convertImage	(	$format,
		$reset = `false`
	)

Eine Bild-Datei umwandeln

Parameter

string	$format
boolean	$reset	Auch umwandeln, wenn bereits eine umgewandelte Version existiert

Rückgabe: boolean

Definiert in Zeile 436 der Datei Ego_Output.php.

Benutzt clearConvertedImages(), Ego_System\copy(), Ego_System\exec(), Ego_System\file_exists(), getName() und Ego_System\mkdir().

Wird benutzt von __construct().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ createArchive()

createArchive	(	$path,
		$type = `'tar'`
	)

Ein tar.gz Archiv erstellen

Parameter

string	$path
string	$type	Typ "tar" oder "zip"

Rückgabe: string

Definiert in Zeile 1355 der Datei Ego_Output.php.

Wird benutzt von read().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ download()

download ( )

Datei der Seite herunterladen

Rückgabe: Page

Definiert in Zeile 1032 der Datei Ego_Output.php.

Benutzt read().

Wird benutzt von pdf().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ error()

error	(	$image = `false`,
		$code = `404`
	)

Fehler ausgeben

Parameter

boolean	$image
integer	$code

Rückgabe: Page

Definiert in Zeile 576 der Datei Ego_Output.php.

Benutzt Ego_System\header(), Ego_System\isDevMode(), read() und setTemporary().

Wird benutzt von pdf(), read() und transform().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ export()

static export	(	$key,
		$type
	)

static

Daten exportieren

Parameter

string	$key
string	$type

Rückgabe: void

Definiert in Zeile 1402 der Datei Ego_Output.php.

◆ getConvertedImages()

getConvertedImages ( )

Alle umgewandelten Bilder ermitteln

Rückgabe: array

Definiert in Zeile 532 der Datei Ego_Output.php.

Benutzt Ego_System\byte_format().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ getFile()

getFile ( )

Den verwendeten Dateipfad ermitteln

Rückgabe: string

Definiert in Zeile 1446 der Datei Ego_Output.php.

◆ getName()

getName ( )

Dateiname generieren

Rückgabe: string

Definiert in Zeile 694 der Datei Ego_Output.php.

Wird benutzt von convertImage() und pdf().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ pdf()

pdf	(	$name = `''`,
		$temporary = `true`,
		$cookie = `true`,
		$return = `1`
	)

Datei als PDF ausgeben

Es werden die Einstellungen für die PDF Generierung des aktuellen Mandanten verwendet.

Parameter

string	$name	Name der auszugebenden Datei
boolean	$temporary	Datei nach der Ausgabe löschen
boolean	$cookie	Anmeldung bei der PDF Generierung beibehalten
integer	$return	1 = Download, 2 = Ausgabe, 3 = Pfad zur generierten PDF Datei

Rückgabe: Page|string

Definiert in Zeile 1048 der Datei Ego_Output.php.

Benutzt download(), error(), Ego_System\file_get_contents(), Ego_System\file_put_contents(), getName(), read(), removeFile(), setFile(), setName() und setTemporary().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ read()

read ( $download = false )

Datei der Seite auslesen

Parameter

boolean $download

Rückgabe: Page

Definiert in Zeile 894 der Datei Ego_Output.php.

Benutzt createArchive(), error(), Ego_System\header(), setFile(), setTemporary() und transform().

Wird benutzt von download(), error() und pdf().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ removeFile()

removeFile ( )

Datei löschen

Rückgabe: void

Definiert in Zeile 1320 der Datei Ego_Output.php.

Wird benutzt von pdf().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ setCache()

setCache	(	$cache,
		$etag = `''`
	)

Ausgabe in eine Cachedatei schreiben (ggf. auch Etag setzen)

Parameter

string	$cache
string	$etag

Rückgabe: void

Definiert in Zeile 1333 der Datei Ego_Output.php.

◆ setFile()

setFile ( $file )

Eine andere Datei verwenden

Parameter

string $file

Rückgabe: void

Definiert in Zeile 1309 der Datei Ego_Output.php.

Wird benutzt von __construct(), pdf() und read().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ setName()

setName ( $name )

Dateiname setzen

Parameter

string $name

Rückgabe: void

Definiert in Zeile 685 der Datei Ego_Output.php.

Wird benutzt von pdf().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ setTemporary()

setTemporary ( $temporary )

Temporäre Datei setzen

Parameter

boolean $temporary

Rückgabe: void

Definiert in Zeile 1344 der Datei Ego_Output.php.

Wird benutzt von __construct(), error(), pdf() und read().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ transform()

transform	(	$width,
		$height,
		$modify = `array()`
	)

Bild transformieren

Parameter

integer	$width
integer	$height
array	$modify

Rückgabe: boolean

Definiert in Zeile 1106 der Datei Ego_Output.php.

Benutzt Ego_System\copy(), Ego_System\dateEncode(), error(), Ego_System\file_exists(), Ego_Image\getDimensions(), Ego_System\header() und Ego_System\mkdir().

Wird benutzt von read().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Dokumentation der Felder

◆ $convert_types

$convert_types

static

Initialisierung:

= [
        'avif' => [
            'label' => 'Avif',
            'mime' => 'image/avif'
        ],
        'webp' => [
            'label' => 'WebP',
            'mime' => 'image/webp'
        ]
    ]

Definiert in Zeile 146 der Datei Ego_Output.php.

Wird benutzt von Mediapool\file() und Page\isValidSuffix().

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

/media/ssd/workspace/egocms/develop/lib/base/Ego_Output.php

Öffentliche Methoden

Öffentliche, statische Methoden

Statische öffentliche Attribute

Ausführliche Beschreibung

Beschreibung der Konstruktoren und Destruktoren

◆ __construct()

Dokumentation der Elementfunktionen

◆ clearConvertedImages()

◆ convertImage()

◆ createArchive()

◆ download()

◆ error()

◆ export()

◆ getConvertedImages()

◆ getFile()

◆ getName()

◆ pdf()

◆ read()

◆ removeFile()

◆ setCache()

◆ setFile()

◆ setName()

◆ setTemporary()

◆ transform()

Dokumentation der Felder

◆ $convert_types