File

Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.

Soll eine abgeleitete Klasse nicht serialisierbar sein, so muss diese Methode überschrieben werden und eine Exception werfen.

Eigenschaften die mit volatile oder associated beginnen werden gesonder behandelt. Eigenschaften mit Prefix volatile werde nicht serialisiert. Bei Eigenschaften mit der Vorsilbe associated wird nur die ID des Objektes serialisiert. Wird in der Eigenschaft kein Objekt gespeichert wird eine TypeException geworfen.

Prüfen ob das Objekt associative Eigenschaften besitzt

Prüfen ob das Objekt volatile Eigenschaften besitzt

Umgang mit Versionen

Diese Methode überprüft ein Objekt und repariert im idealfall ältere Kopien. Kann eine alte Kopie nicht wieder hergestellt werden, so wird eine Exeption geworfen.

Diese Methode muss von den abgeleiteten Klassen überschrieben werden. In der abgeleiteten Klasse sollte die Parent-Methode aufgerufen werden.

Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.

Pfad auf die Datei als String zurückgeben

Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.

Diese Methode wird indirekt aufgerufen, sobald ein Wert oder eine Funktion einem Objekt zugeordnet wird, die nicht definiert wurde.

class MyObject extends Alvine {
}

$obj = new MyObject();
$obj->myValue = 4;

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

Zurücksetzen von Werten

Diese Methode wird inplizit aufgerufen wenn eine nicht definierte Eigenschaft abgefragt wird. Ist die Eigenschaft eine Anonyme-Funktion (Closure), so wird diese Funktion aufgerufen und die Klasse als Parameter übergeben.

Vor der Abfrage sollte, damit keine Exception geworfen wird, die Existenz der Eigenschaft geprüft werden.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

Closure über den definierten Namen holen. Ist keine Eigenschaft mit dem Namen definiert, so wird eine BadPropertyException geworfen. Gibt es eine Eigenchaft mit dem Namen, ist diese aber kein Closure, so wird eine NotFoundException geworfen.

Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.

Achtung: Wird das Closure in einem Objekt definiert, so ist die Variable $this nicht das Objekt des Closures, sondern des, in dem das Closure definiert wurde.

// als erster Parameter wird immer das Objekt übergeben
$a->myfunction = function($obj, $b) { echo $b.'!'; };
// Aufruf als Eigenschaft ohne Parameter
$a->myfunction;  // Ausgabe ist ein !
//
// Aufruf als Methode mit Parametern
$a->myfunction('OK');  // Ausgabe ist  OK!

Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).

if($obj->isCallable('myfunction')) {
  $obj->myfunction();
}

Die Methode Alvine::getID() verwenden!

Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.

Objekte haben bei der Erstellung noch keine eindeutige ID, erst mit dem expliziten Aufruf der ID wird diese einmalig erstellt und im Objekt gepseichert.

Diese Methode wird implizit beim Serialisieren aufgerufen.

Die UUID ist dabei vom Type4 (Random)

Diese Methode entfernt alle Minuszeichen aus der UUID des Hash. Wird eine Länge definiert, so wird nach dem entfernen der Minuszeichen die ersten $length Zeichen zurückgegeben.

Diese Methode ist hilfreich um Platz zu sparen.

Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision mit anderen Hash vergleichbarer Objekte.

Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der Wert, der von Alvine::getID() zurückgeliefert wird ermittelt und das Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.

class MyObject extends Alvine {};

$objA = new MyObject();
$objB = new MyObject();

if($objA->equals($objB)) {
  // ...
}

Diese Methode gibt ein geklontes Objekt von sich selber zurück.

Wenn eine abgeleitete Klasse diese Methode nicht unterstützt, so muss diese die Methode überschreiben und eine CloneNotSupportedException werfen. Die Standardmethode klont eine seichte Kopie der Eigenschaften. Das bedeutet das Objekte in den Eigenschaften nicht geclont werden. Sollen diese auch geclont werden muss true übergeben werden.

Wenn weitere Funktionen implementiert werden sollen, so muss __clone überschrieben werden

Interne Hook für das Clonen des Objektes. Wenn das zu klonende Objekt bereits eine eindeutige ID hat, dann wird auch für das neue Objekt eine eindeutige ID erstellt.

Alvine-Objekte werden rekursive geclont, so das ein vollständiger Clone vorhanden ist.

Name der Klasse

class MyObject extends Alvine {};
$obj = new MyObject();

echo $obj->getClass();

Prüft ob das übergebene Objekt eine Instanz dieses Objektes ist. Allerdings ist darauf zu achten, das vorher definiert wurde, das das neue Objekt von Alvine abgeleitet wurde.

if($obj instanceof Alvine &&
   $obj->isInstanceOf($object)) { };

Die Prüfung entspricht

$this instanceof $object

Neues Dateiobjekt erstellen

Neues Verzeichnis setzen.

Verzeichnis

Falls ein Protokoll angegeben wurd, so wird das Verzeichnis mit dem Protokoll zurückgegeben

Ist die Datei vorhanden und ausführbar?

Ist die Datei vorhanden und ist sie lesbar?

Ist File schreibbar?

Existiert das File-Objekt im Dateisystem?

Ist das Objekt vom Typ Datei oder Stream

Ist das Objekt vom Typ Stream zum Beispiel php://memory

Prüft im Dateisystem ob der Pfad ein Verzeichnis ist.

Prüft im Dateisystem ob der Pfad ein Verzeichnis ist.

Verzeichnis oder Datei löschen. Wurde mit dem File-Objekt ein Stream erstellt, so wird dieser vor dem Löschen geschlossen.

Datei im Dateisystem umbenennen. Das Dateiobjekt hat danach den neuen Namen. Das Verzeichnis wird vom aktuellen Objekt genommen.

Analysieren

Interne Funktion zum analysieren des Dateipfades

Wird ein anderes als Protokoll als file: (zum Beispiel phar:) angegeben, so wird diese in der Protokoll-Eigenscahft gespeichert. Das file: Protokoll wird ignoriert und abgeschnitten, da es redundant ist.

Prtokoll

Datei anlegen

Legt eine leere Datei unter dem definierten Dateinamen an. Existiert die Datei bereits, so wird eine Exception geworfen. Ist $overwrite gesetzt, so wird eine bestehende Datei überschrieben und keine Exception geworfen.

Basisname

Name der Datei (inkl. Erweiterung)

Dateiname

Name der Datei (ohne Erweiterung)

Wrapper für Directory::isAbsolute();

Erweiterung des Dateinamens

Diese Methode gibt den rechten Teil des Dateinamens nach dem Punkt zurück. Sind mehrere Punkte im Dateinamen, so wird der letzte genommen.

readme.txt liefert txt zurück.

Factory

Factory um ein File-Objekt auf einen Datei im aktuellen Verzeichnis zu erstellen. Dies ist eine Bequemlichkeitfunktion.

// File-Properties
$stream = Alvine\IO\File::fromCurrentFilename('file.properties');

Wichtig: Es wird immer das Verzeichnis des direkten aufrufers ermittelt.

Erstellt aus dem File-Objekt ein Stream und merkt sich diesen. Beim mehrfachen Aufruf der Methode wird immer das gleiche Streamobjekt zurückgegeben. Dadurch wird auch der Dateizeiger nicht zurückgesetzt und am aktuellen Stand der Datei weitergelesen.

Möchte man die Datei wieder von vorne lesen, so muss vorher FileInputStream::rewind() aufgerufen werden.

Erstellt aus dem File-Objekt ein Stream und merkt sich diesen. Beim mehrfachen Aufruf der Methode wird immer das gleiche Streamobjekt zurückgegeben.

Ermittelt den MediaType der Datei. Wird eine leere Datei mit der Endung .txt angegeben, so wird nicht inode/x-empty sondern text/plain zurückgegeben.

Bei einer leeren Datei mit der Endung .txt wird als MediaType 'text/plain' zurückgegeben.

Installation

Windows

Um diese Erweitrung auf Windows verwenden zu können, muss zum einen die Erweiterung mittels extension=php_fileinfo.dll in der php.ini eingeschalten werden. Zum anderen werden die magic-Dateien (magic und magic.mgc) aus dem winGNU Projekt benötigt. Beide Dateien müssen in das PHP-Root-Verzeichnis kopoiert werden. Sollen die Dateien an einem anderen Ort liegen, so muss diese Speicherstelle über die Umgebungs- variable MAGIC bekannt gegeben werden. werden.

*nux

Je nach installation können die magic-Dateien an einem anderen Ort liegen. Der Speicherort der Dateien muss über die Umgebungsvariable MAGIC bekannt gegeben werden.

Überprüfen ob Datei hochgeladen wurde

Bereitet die $_FILE Struktur für die weitere Verwendung in der Klasse auf. Zusätzlich zu den Einträgen aus der $_FILE Struktur werden die beiden Schlüssel isList und index eingetragen.

isList ist true, wenn der verwendete HTML-Name ein Array mittels [] definert index ist der Wert des aktuell angesprochenen Eintrages.

Eine Liste mit allen über den HTML-Variablenname übertragenen Dateien. Wird kein Variablenname angegeben, so werden alle Dateien in der Liste zusammengefasst.

Größe der Datei

Fehlercode

Dateiname

Vom Client übergebener Name der Datei, ist nicht identisch mit der temporären Datei dieses Objekts.

macht aus der temporären Datei ein Fileobjekt und gibt diese zurück

MimeType wie vom Client übetragen.

Dies muss nicht identisch mit dem Type der echten Datei sein.