Dokumentation - Server Grundfunktionen (public)

Streamfunktionen

new doc() - Object

__construct ()

erstellt ein neues in sich getrenntes Dokument welche Streamfunktionen speichert


      $doc = new doc();

__destruct ()

schließt das Dokument ab


      $doc = new doc();

      doc::dlAble(true);

      unset($doc);

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

$new optional; speichert die Variable

gibt an ob das Dokument downloadbar ist; wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe von true oder false, default ist true


    doc::dlAble(); // gibt die Variable zurück

    doc::dlAble(true); // speichert die Variable

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

$new optional; speichert die Variable

gibt an ob das Dokument ein Footer enthält; wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe von true oder false, default ist false


    doc::footer(); // gibt die Variable zurück

    doc::footer(false); // speichert die Variable

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

$new optional; speichert die Variable

gibt an ob das Dokument ein Header enthält; wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe von true oder false, default ist false


    doc::header(); // gibt die Variable zurück

    doc::header(false); // speichert die Variable

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

$new optional; speichert die Variable, als string oder new lang() Objekt

gibt die Sprache des Dokuments an; wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe von new lang(), default ist new lang(lang::getDefault())


    doc::lang(); // gibt die Variable zurück

    doc::lang('de'); // speichert die Variable

    doc::lang(new lang('de')); // speichert die Variable

static doc::langContainer ([$array $string $object $new = null])

$new optional; speichert die Variable als string, array, new lang() oder new lang\container() Object

gibt die Sprache(n) des Dokuments an; wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe eines new lang\container() Objects


    doc::langContainer(); // gibt die Variable zurück

    doc::langContainer('de'); // speichert die Variable

    doc::langContainer(new lang('de')); // speichert die Variable

    doc::langContainer(['de', 'en', 'fr']); // speichert die Variable

    doc::langContainer(['de', new lang('en'), 'fr']); // speichert die Variable

static doc::lastModified ([$numeric $new = null])

$new optional; speichert die Variable

gibt das Datum der letzten Änderung des Dokuments an; wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe eines integer als Unix-Timestamp, default ist filemtime($_SERVER['SCRIPT_FILENAME'])


    doc::lastModified(); // gibt die Variable zurück

static doc::login ([$bool $string $array $object $new = null])

$new optional; speichert die Variable als new client\login() Objekt

gibt die Login Informationen des Dokuments an; wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe eines new client\login(), default ist new client\login(false)


    doc::login(); // gibt die Variable zurück

    doc::login('webmaster@xenec.com'); // speichert die Variable

    doc::login(new client\login('webmaster@xenec.com')); // speichert die Variable

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

$new optional; speichert die Variable als Mime-Code string oder new mime() Objekt

gibt die Mime Informationen des Dokuments an; wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe von new mime(), default ist new mime(mime::getDefault())


    doc::mime(); // gibt die Variable zurück

    doc::mime('html'); // speichert die Variable

    doc::mime(new mime('html')); // speichert die Variable

static doc::mimeContainer ([$array $string $object $new = null])

$new optional; speichert die Variable als string, array, new mime() oder new mime\container() Object

gibt die Mime Informationen des Dokuments an; wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe eines new mime\container() Object


    doc::mimeContainer(); // gibt die Variable zurück

    doc::mimeContainer('html'); // speichert die Variable

    doc::mimeContainer(['html', 'xml']); // speichert die Variable

    doc::mimeContainer(['html', new mime('xml')]); // speichert die Variable

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

$new optional; speichert die Variable als string oder new assist\trans() Objekt

gibt den Namen des Dokuments an; wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe von new assist\trans(), default ist pathinfo($_SERVER['SCRIPT_FILENAME'], PATHINFO_FILENAME)


    doc::name(); // gibt die Variable zurück

static doc::parse ([$bool $new = null])

$new optional; speichert die Variable

gibt an ob das Dokument geparst werden soll; wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe von true oder false, default ist doc::mime()->parse


    doc::parse(); // gibt die Variable zurück

    doc::parse(true); // speichert die Variable

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

$new optional; speichert die Variable

gibt an ob das Dokument statisch ist; wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe von true oder false, default ist !doc::mime()->parse


    doc::static(); // gibt die Variable zurück

    doc::static(false); // speichert die Variable

Stream Optionen

static doc::getAllOption ()

gibt alle Optionen des Dokuments als array zurück


    doc::getAllOption();

static doc::getChangeOption ()

gibt nur geänderte Optionen des Dokuments als array zurück


    doc::getChangeOption();

static doc::debugInfo ()

gibt alle Stream Informationen des Dokuments als array zurück


    doc::debugInfo();

Klassenfunktionen

static doc::author ([$object $string $author = null])

$author optional; gibt den Namen des Authors an, als string oder new assist\trans()

wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe von new assist\trans(), im Fehlerfall null


    doc::author('Daniel Schumann'); // speichert den Namen 'Daniel Schumann'

    doc::author(new assist\trans(['de' => 'Daniel Schumann', 'en' => 'Schumann']));


    doc::author(); // gibt den Namen des Authors zurück

static doc::copyright ([$object $string $copyright = null])

$copyright optional; gibt den Text für Copyright an, als string oder new assist\trans()

wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe von new assist\trans(), im Fehlerfall null


    doc::copyright('Daniel Schumann'); // speichert den Text 'Daniel Schumann'

    doc::copyright(new assist\trans(['de' => 'Daniel Schumann', 'en' => 'Schumann']));


    doc::copyright(); // gibt den Text für Copyright zurück

static doc::description ([$object $string $description = null])

$description optional; gibt die Beschreibung des Dokuments an, als string oder new assist\trans()

wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe von new assist\trans(), im Fehlerfall null


    doc::description('dies ist ein neues Dokument'); // speichert den Text 'dies ist ein neues Dokument'

    doc::description(new assist\trans(['de' => 'dies ist ein neues Dokument', 'en' => 'this is a new document']));


    doc::description(); // gibt die Beschreibung des Dokuments zurück

static doc::keywords ([$object $string $keywords = null])

$keywords optional; gibt die Keywords des Dokuments an, als string oder new assist\trans()

wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe von new assist\trans(), im Fehlerfall null


    doc::keywords('Dokument, Webseite, Öffentlich'); // speichert den Text 'Dokument, Webseite, Öffentlich'

    doc::keywords(new assist\trans(['de' => 'Dokument, Webseite, Öffentlich', 'en' => 'document, website, public']));


    doc::keywords(); // gibt die keywords des Dokuments zurück

static doc::title ([$object $string $title = null])

$title optional; gibt den Titel des Dokuments an, als string oder new assist\trans()

wird die Variable gespeichert, Rückgabe von true, im Fehlerfall false; wird die Variable abgerufen, Rückgabe von new assist\trans(), im Fehlerfall null


    doc::title('Dies ist der Titel');