Dokumentation - Server Grundfunktionen (public)

static stream::all ([$integer $position = null])

$position optional; gibt eine einzelne Postion im array an, die ausgegeben werden soll

gibt alle gespeicherten Streams als array aus, oder eine einzige


    stream::all(); // Ausgabe: array(#HEAD, #MAIN, #FOOT)

static stream::head ([$integer $position = null])

$position optional; gibt eine einzelne Postion im array an, die ausgegeben werden soll

gibt alle gespeicherten Streams im #HEAD als array aus, oder eine einzige


    stream::head(); // Ausgabe: array(#HEAD)

static stream::main ([$integer $position = null])

$position optional; gibt eine einzelne Postion im array an, die ausgegeben werden soll

gibt alle gespeicherten Streams im #MAIN als array aus, oder eine einzige


    stream::main(); // Ausgabe: array(#MAIN)

static stream::foot ([$integer $position = null])

$position optional; gibt eine einzelne Postion im array an, die ausgegeben werden soll

gibt alle gespeicherten Streams im #FOOT als array aus, oder eine einzige


    stream::foot(); // Ausgabe: array(#FOOT)

Hinzufügen und Entfernen

static stream::add ($object $stream[, $integer $position = 1])

`$stream`	gibt das einzufügende Stream Objekt an
`$position`	optional; Position < 0, Stream wird am Anfang von #MAIN eingefügt, ansonsten am Ende

fügt das Stream in #MAIN ein


    stream::add(new stream\blob('Hallo Welt'));

static stream::addHead ($object $stream[, $integer $position = 1])

`$stream`	gibt das einzufügende Stream Objekt an
`$position`	optional; Position < 0, Stream wird am Anfang von #HEAD eingefügt, ansonsten am Ende

fügt das Stream in #HEAD ein


    stream::addHead(new stream\blob('Hallo Welt'));

static stream::addFoot ($object $stream[, $integer $position = 1])

`$stream`	gibt das einzufügende Stream Objekt an
`$position`	optional; Position < 0, Stream wird am Anfang von #FOOT eingefügt, ansonsten am Ende

fügt das Stream in #FOOT ein


    stream::addFoot(new stream\blob('Hallo Welt'));

static stream::resetStream ()

löscht alle Stream Objekte aus dem Stream


    stream::resetStream();

static stream::resetAll ()

löscht alle Stream Objekte aus dem Stream und setzt auch alle Eigenschaften zurück


    stream::resetAll();

Eigenschaften

static stream::basename()

gibt den Namen und die Dateierweiterung zurück


    stream::basename(); // Ausgabe: index.html

static stream::dl ([$bool $new = null])

$new optional; gibt mit true an, dass der Stream als Download ausgeführt werden soll

gibt mit true an, dass der Stream als Download ausgeführt werden soll


    stream::dl(); // Ausgabe: true/false

static stream::buffer ([$integer $new = null])

$new optional; gibt an wie groß der Buffer in Bytes sein soll

gibt an wie groß der Buffer in Bytes ist


    stream::buffer(1024); // Eingabe: 1024 Bytes

static stream::dlAble ([$bool $new = null])

$new optional; gibt an ob das Stream gedownloaded werden darf

gibt an ob das Stream gedownloaded werden darf; Ausgabe true oder false


    stream::dlAble(); // Ausgabe: true

static stream::footer ([$bool $new = null])

$new optional; gibt mit true an ob der Stream mit einem Footer ausgegeben werden soll

gibt mit true an ob der Stream mit einem Footer ausgegeben werden soll


    stream::footer(); // Ausgabe: true

static stream::header ([$bool $new = null])

$new optional; gibt mit true an ob der Stream mit einem Header ausgegeben werden soll

gibt mit true an ob der Stream mit einem Header ausgegeben werden soll


    stream::header(); // Ausgabe: true

static stream::lastModified ()

gibt das Datum aus, der letzten bearbeiteten Datei, als Unix Timestamp und kann mit Hilfe der Funktion date() verarbeitet werden


    stream::lastModified(); // Ausgabe: 1664802267

static stream::lang ([$string $object $new = null])

$new optional; gibt den neuen Sprachcode an, der ausgegeben werden soll; als string nach ISO 639-1 oder new lang() Objekt

gibt den new lang() Objekt zurück, der ausgegeben werden soll aus


    stream::lang(new lang('de')); // Eingabe: Deutsch

static stream::languages ([$array $new = null])

$new optional; gibt die neuen Sprachcodes als array an, die in dem Stream verfügbar sind; als strings nach ISO 639-1 oder new lang() Objekte

gibt ein array zurück, mit allen verfügbaren Sprachcodes nach ISO 639-1; die Reihenfolge entscheidet welche Sprache zuerst versucht wird auszugeben


    stream::languages(['de', 'en', new lang('es')]); // Eingabe: Deutsch, Englisch und Spanisch

static stream::mime ([$string $object $new = null])

$new optional; gibt den neuen Mimetyp an, der ausgegeben werden soll; als string oder new mime() Objekt

gibt den new mime() Objekt zurück, der ausgegeben werden soll aus


    stream::mime(new mime('jpg')); // Eingabe: image/jpg Dateierweiterung

static stream::mimetypes ([$array $new = null])

$new optional; gibt die Mimetypen als array an, die in dem Stream verfügbar sind; als strings oder new mime() Objekte

gibt ein array zurück, mit allen verfügbaren Mimetypen; die Reihenfolge entscheidet welcher Mimetyp zuerst versucht wird auszugeben


    stream::mimetypes(['html', 'jpg', new mime('xml')]); // Eingabe: html, jpg und xml

static stream::name ([$string $new = null])

$new optional; gibt den neuen Namen der Datei an

gibt den Namen der Datei des Streams an


    stream::name('index'); // Eingabe: index

static stream::size ()

gibt die Größe des Streams in Bytes an


    stream::size(); // Ausgabe: 1024 Bytes

static stream::static ([$bool $new = null])

$new optional; gibt mit true an ob der Stream statisch ist

gibt mit true an ob der Stream statisch ist


    stream::static(true); // Eingabe: true

static stream::login ([$object $new = null])

$new optional; gibt das new client\login() Objekt an

gibt das new client\login() Objekt zurück, oder null wenn kein Login für den Stream gespeichert wurde


    stream::login(new client\login('admin@xenec.com')); // Eingabe: admin@xenec.com

Ausgabe

static stream::output()

gibt den kompletten Stream aus, dabei erfolgt die Ausgabe jeder Stream Objekte


    stream::output();

static stream::outputRange([$numeric $start = null[, $numeric $end = null]])

`$start`	optional; gibt den Startwert in Bytes an
`$end`	optional; gibt den Endwert in Bytes an

gibt ein Teil des Streams aus, dabei erfolgt die Ausgabe jeder Stream Objekte


    stream::outputRange(5, 10);

static stream::parse()

parst PHP Code von allen Stream Objekten


    stream::parse();

Informationen

static stream::empty()

gibt true oder false zurück, je nachdem ob der Stream leer ist oder nicht


    stream::empty(); // Ausgabe: true/false

static stream::debugInfo()

funktioniert wie die magische Methode __debugInfo() und gibt ein array zurück mit allen Eigenschaften des Streams


    stream::debugInfo(); // Ausgabe: array(#INFOS)

static stream::count()

gibt die Anzahl der Stream Objekte zurück


    stream::count(); // Ausgabe: array(#INFOS)

Zugriffsberechtigung und Schutz vor Veränderungen

static stream::loginPass()

prüft ob der Client die Zugriffsberechtigung für den Stream Inhalt hat


    stream::loginPass(); // Ausgabe: true

static stream::lock()

schützt den Stream vor Veränderungen


    stream::lock(); // Ausgabe: true

static stream::isLock()

prüft ob der Stream vor Veränderungen geschützt ist


    stream::lock();


    stream::isLock(); // Ausgabe: true

Stream Objects

static stream::isStream ($mixed $stream = null)

$stream übergibt das zu überprüfende Objekt

gibt true zurück wenn das Objekt ein new stream\blob(), new stream\data() oder new stream\file() Objekt ist; ansonsten false


    $blob = new stream\blob('Hallo Welt');

    stream::isStream($blob); // Ausgabe: true

static stream::isBlobStream ($mixed $stream = null)

$stream übergibt das zu überprüfende Objekt

gibt true zurück wenn das Objekt ein new stream\blob() Objekt ist; ansonsten false


    $blob = new stream\blob('Hallo Welt');

    stream::isBlobStream($blob); // Ausgabe: true

static stream::isDataStream ($mixed $stream = null)

$stream übergibt das zu überprüfende Objekt

gibt true zurück wenn das Objekt ein new stream\data() Objekt ist; ansonsten false


    $data = new stream\data(//##PRÜFEN);

    stream::isDataStream($data); // Ausgabe: true

static stream::isFileStream ($mixed $stream = null)

$stream übergibt das zu überprüfende Objekt

gibt true zurück wenn das Objekt ein new stream\file() Objekt ist; ansonsten false


    $file = new stream\file('index.html');

    stream::isFileStream($file); // Ausgabe: true