Dokumentation - Server Grundfunktionen (public)

new file() - Object

`$string id = null`	ID der Datei in der Datenbank
`$string path = null`	Dateipfad
`$string ext = null`	Dateierweiterung des Pfades
`$object mime = null`	enthält das new Mime Object der Datei
`$object charset = null`	enthält das new Charset Object der Datei
`$integer $float size = null`	Größe der Datei in Bytes
`$object langContainer = null`	enthält die Sprachen als new lang\container() Object der Datei
`$object login = null`	enthält das new client\login Object der Datei
`$bool created = false`	gibt true zurück, wenn eine neue Datei erstellt wird

__construct ($string $object $context = null[, $bool $create = false])

`$context`	gibt den Dateipfad als string an, oder die ID der Datei in der Datenbank; oder als new file() Object
`$create`	mit true wird eine neue Datei erstellt, wenn sie noch nicht existiert

erstellt das File Object, kann auch ein neue Datei erzeugen


      // Dateipfad

      $file = new file('pfad/index.php');


      // Datei ID in der Datenbank

      $file = new file('index');


      // neue Datei erstellen

      $file = new file('test.png', true);

      $file->mime = 'txt';

      $file->put_content('Dateiinhalt als Text');


      // new file() Object

      $file = new file('pfad/index.php');

      $fileSecond = new file($file);

__get ($string $name)

$name Name der Variable

gibt die Eigenschaften des File Objekts zurück


      $file = new file('index');

      echo $file->path;

__set ($string $name, $mixed $value)

`$name`	Name der Variable
`$value`	Variable die gespeichert werden soll

speichert die Eigenschaften des File Objekts


      $file = new file('index');

      $file->mime = 'html';

__toString ()

gibt den relativen Pfad der Datei zurück


      $file = new file('index');

      echo $file;

__debugInfo ()

gibt die Eigenschaften des File Objekts zurück


      $file = new file('index');

      print_r ($file);

getInfo ()

gibt alle Eigenschaften des File Objekts zurück


      $file = new file('index');

      print_r ($file->getInfo());

exists ()

gibt true oder false zurück, je nachdem ob die Datei auf der Festplatte existiert


      $file = new file('index');

      $file->exists();

isValid ()

prüft ob das new file() Objekt valid ist. Datei muss als ID in der Datenbank und auf der Festplatte existieren, oder es wird eine neue Datei erstellt.


      $file = new file('index');

      $file->isValid();

put_contents ($string $content = null)

$content Inhalt der Datei

füllt eine neu erzeugte Datei mit Inhalt als string, und gibt bei Erfolg true zurück; ansonsten false


      $file = new file('test/neueDatei.txt');

      $file->put_contents('Hier ist der Inhalt');

rename ($string $name = null)

$name gibt den neuen Dateiname an

Benennt die Datei um und gibt true bei Erfolg zurück; ansonsten false


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

      $file->rename('main.php');

File Objekt

static file::createFile ($string $filename = null)

$filename gibt den Dateipfad an

führt einfach new file ($context, true) aus und gibt ein new file () Objekt zurück, mit einer neu erstellten Datei. Wenn der Dateiname schon existiert, wird automatisch ein neuer Dateiname generiert


    $file = file::createFile ('datei.txt');


    $file->put_contents ('Dateiinhalt');

Überprüfungen

static file::isFile ($mixed $fileObj = null)

$fileObj Übergibt die Variable die überprüft werden soll

gibt true zurück, wenn die Variable ein File Object ist; ansonsten false


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

    file::isFile ($file);

static file::isPath ($mixed $path = null)

$path gibt den Pfad an, der überprüft werden soll

gibt true zurück, wenn die Variable ein gültiger Pfad ist; ansonsten false


    file::isPath ('c:/ordner/datei.txt');

Datei und Ordnerpfade

static file::getFileList ($string $array $path = null[, $string $array $extension = null[, $array $option = null]])

`$path`	gibt den Pfad als $string oder als $array an
`$extension`	optional; gibt die Dateierweiterungen als $string oder als new mime() Objekt an, einzeln oder mehrere als $array
`$option`	optional; legt Optionen als $array fest `[ 'sf' \| 'subfolder' => true // bei true werden Unterordner berücksichtigt 'rp' \| 'realpath' => false // bei true werden die Dateien mit absoluten Pfad zurückgegeben 's' \| 'sort' => true // bei true wird die Dateiliste sortiert zurückgegeben ]`

gibt bei Erfolg ein $array zurück mit allen Dateien als Liste; ansonsten null


    print_r(file::getFileList(MAINDIR));

static file::getFolderList ($string $array $path = null[, $array $option = null])

`$path`	gibt den Pfad als $string oder als $array an
`$option`	optional; legt Optionen als $array fest `[ 'sf' \| 'subfolder' => true // bei true werden Unterordner berücksichtigt 'rp' \| 'realpath' => false // bei true werden die Ordner mit absoluten Pfad zurückgegeben 's' \| 'sort' => true // bei true wird die Ordnerliste sortiert zurückgegeben ]`

gibt bei Erfolg ein $array zurück mit allen Ordnern als Liste; ansonsten null


    print_r(file::getFolderList(MAINDIR));

static file::convertPath ($string $path = null[, $bool $array = false])

`$path`	gibt den Pfad als string an
`$array`	bei true wird der Pfad als array zurückgegeben und in einzelnen Verzeichnisse bzw. Dateien aufgeteilt

konvertiert den Pfad in Linux ähnlichen Pfad


    file::convertPath('E:\apps\new/log/http/reqRes.log'); // Ausgabe: E:/apps/new/log/http/reqRes.log

    file::convertPath('E:\apps\new/log/http/reqRes.log', true); // Ausgabe: array('E:', 'apps', 'new', 'log', 'http', 'reqRes.log')

static file::getRelativePath ($string $to = null[, $string $from = ''])

`$to`	gibt den Zielpfad als $string an
`$from`	optional; gibt den Startpfad als $string an

gibt bei Erfolg den relativen Pfad zwischen Start und Zielpfad als $string zurück; im Fehlerfall null


    echo file::getRelativePath(PUBLICDIR); // Ausgabe: "../../public/"

static file::getMainPath ($array $input = null[, $array $option = null])

`$input`	übergibt die Pfade die geprüft werden sollen als array an
`$option`	optional; legt Optionen als $array fest `[ 'rp' \| 'realpath' => false // bei true werden die gefundenen Dateien mit absoluten Pfad zurückgegeben 's' \| 'sort' => true // bei true wird die Dateiliste sortiert zurückgegeben ]`

gibt ein array zurück, mit den Hauptpfaden, somit wird verhindert, das doppelte Einträge vorhanden sind; im Fehlerfall null


    file::getMainPath([PUBLICDIR, MAINDIR]);

static file::searchFile ($string $array $path = null, $string $filename = null[, $array $option = null])

`$path`	gibt den Pfad als $string oder als $array an
`$filename`	gibt den Dateinamen der gesucht werden soll als $string an, unabhängig von Groß- und Kleinschreibung
`$option`	optional; legt Optionen als $array fest `[ 'sf' \| 'subfolder' => true // bei true werden Unterordner berücksichtigt 'rp' \| 'realpath' => false // bei true werden die gefundenen Dateien mit absoluten Pfad zurückgegeben 's' \| 'sort' => true // bei true wird die Dateiliste sortiert zurückgegeben 'e' \| 'exact' => true // bei true wird genau nach den Dateinamen gesucht, bei false wird nur nach ein Teil des zu suchenden Namens gesucht ]`

gibt bei Erfolg ein $array zurück, mit den gefundenen Dateinamen; im Fehlerfall null


    file::searchFile ('./', 'index.php');


    file::searchFile ('./', 'class.php', ['exact' => false]);

static file::protectFile ($string $file = null)

$file gibt den Dateipfad an, der geschützt werden soll

gibt true zurück, wenn die Datei erfolgreich in der .htaccess Datei gespeichert wurde


    file::protectFile ('config.ini');

Eigenschaften

static file::getFileInfo ($string $file = null)

$file gibt den Pfad als $string an

gibt ein array zurück mit Informationen zu der angegebenen Datei ['path' => #REAL PFAD, 'langContainer' => , 'login' => ]; im Fehlerfall null


    file::getFileInfo ('index.html');

static file::getFileSize ($string $file = null[, $bool $bigSize = false])

`$file`	gibt den Pfad als $string an
`$bigSize`	gibt mit true an, ob die Größe der Datei die größer als 2 GB zurück gegeben wird (bei 32-Bit System relevant)

gibt die Dateigröße als $float zurück, -1 wenn die Dateigröße nicht ermittelt wurden konnte; im Fehlerfall null


    echo file::getFileSize('E:\_Filme\4K\Sully.iso');

static file::getFileCharset ($string $file = null)

$file gibt den Pfad als $string an

gibt ein new charset () Objekt zurück, welcher den Charset der Datei enthält; im Fehlerfall null


    file::getFileCharset('index.html');

static file::getFileMime ($string $file = null)

$file gibt den Pfad als $string an

gibt ein new mime() Objekt zu der Datei zurück; im Fehlerfall null


    file::getFileMime('index.html');

static file::getStringMime ($string $fileContent = null)

$fileContent Inhalt einer Datei als $string

gibt ein new mime() Objekt zu dem Dateiinhalt zurück; im Fehlerfall null


    file::getStringMime('Dies ist ein normaler Text einer Datei');

Datenbank

static file::getFileById ($string $numeric $id = null)

$id übergibt die ID nach der in der Datenbank gesucht werden soll

gibt ein array zurück, mit allen Informationen der Datei aus der Datenbank; ansonsten null


    file::getFileById('index');

static file::getFileByPath ($string $numeric $path = null)

$path übergibt den Pfad nach der in der Datenbank gesucht werden soll

gibt ein array zurück, mit allen Informationen der Datei aus der Datenbank; ansonsten null


    file::getFileByPath('index.html');

static file::dbAddFiles ($string $numeric $array $files = null)

$files gibt die Dateien als string oder array an die in die Datenbank gespeichert werden sollen

gibt true zurück, wenn die Dateien in der Datenbank gespeichert wurden; ansonsten false


    file::dbAddFiles (['index.php', 'boot.php']);

static file::dbDeleteFiles ($string $numeric $array $id = null)

$id gibt die IDs an, die in der Datenbank gelöscht werden sollen

gibt true zurück, wenn die Dateien aus der Datenbank gelöscht wurden; ansonsten false


    file::dbDeleteFiles (['index', 'boot']);

static file::dbCleanup ()

löschte alle Datenbankeinträge, bei denen die Datei nicht mehr existiert und gibt true bei Erfolg zurück; ansonsten false


    file::dbCleanup();

static file::dbUpdate ()

aktualisiert die Datenbankeinträge, und gibt bei Erfolg ein Array mit Informationen zurück; im Fehlerfall null


    file::dbUpdate();