class Directory extends Alvine

Verwaltung eines Verzeichnisses für Dateien.

$dir = new \Alvine\IO\File\Directory('C:\\temp\\test.txt');
$dir->parent()->parent(); // zwei Ebene hoch zu c:\
$dir->parent()->addChild('abc'); // C:\abc
$dir->removeChild(); // C:\  (aktuelles Objekt)

Diese Methode untersützt auf Windows auch die Schreibweise ab Arbeitsplatz: \c:\temp\dir\ bzw in URI-Schreibweise /c:/temp/dir. Diese Schreibweise wird nach c:\temp\dir geändert.

Traits

SerializableImplementation

Constants

VERSION

Generelle Alvine-Version

APIVERSION

Version der API-Version der Klasse.

IDENTIFICATION

Identifizierung der Alvine API

SERIALVERSION

Version der Klasse (wird für die Serialisierung verwendet. Ändert sich der interne Aufbau der Klasse, so muss dieser Wert nach oben gesetzt werden. Die Serialisierung muss diesen Wert abfragen und bei Bedarf einen Wrapper für das Arbeiten mit veralteten Objekten implmenetieren.

SEPARATOR

Verzeichnistrenner

ROOT

Interner Marker für das Root-Verzeichnis bei UNIX-Systemen

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine
protected array $parts Zwischenspeicher für den analysierten Pfad
protected string $protocol
protected string $dirname
protected string $separator

Methods

string
serialize()

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

bool
hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

bool
hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

checkAndAdjustSerialisation(array $serialization)

Umgang mit Versionen

void
unserialize(string $serialized)

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

string
__toString()

Pfad

void
__set(string $name, mixed $value)

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

from Alvine
boolean
__isset(string $name)

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

from Alvine
__unset(string $name)

Zurücksetzen von Werten

from Alvine
mixed
__get(string $name)

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.

from Alvine
getClosure(string $name)

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.

from Alvine
boolean
propertyExists(string $name)

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

from Alvine
mixed
__call(string $name, array $arguments)

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

from Alvine
boolean
isCallable(type $name)

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

from Alvine
string
getHashCode() deprecated

Die Methode Alvine::getID() verwenden!

from Alvine
string
getID()

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

from Alvine
string
getShortID(int|null $length = null)

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.

from Alvine
boolean
equals(Alvine $object)

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.

from Alvine
Alvine
getClone(boolean $deepClone = false)

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

from Alvine
__clone()

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.

from Alvine
string
getClass()

Name der Klasse

from Alvine
boolean
isInstanceOf(object $object)

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.

from Alvine
__construct(string|null $path, string|null $separator = null)

Erstellt ein neues Directory-Objekt

boolean
exists()

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

string|null
getProtocol()

Protokoll

bool
isAbsolute()

Prüft ob das Verzeichnis absolut oder relativ im Dateisystem ist.

delete()

Verzeichnis löschen

create()

Verzeichnis anlegen

determineSeperator(string|null $separator)

Pfadtrenner des Verzeichnis bestimmen

analyze(string|null $path, string|null $separator = null)

Analyse einer Zeichenkette

parent(integer $count = 1)

Objekt mit Elternverzeichnis

addChild(string $child)

Unterverzeichnis

removeChild()

Unterverzeichnis entfernen

getLastChild()

Letzten Eintrag zurückgeben

getLastChilds(int $count)

Letzten Eintrag zurückgeben

bool
hasChildren()

Sind Unterverzeichnisse vorhanden

Details

string serialize()

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.

Return Value

string String-Repräsentation des Objektes

bool hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

Return Value

bool

bool hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

Return Value

bool

protected checkAndAdjustSerialisation(array $serialization)

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.

Parameters

array $serialization Daten des serialisiertes Objekts

Exceptions

UnserializeException Keine Übereinstimmung

void unserialize(string $serialized)

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

Parameters

string $serialized

Return Value

void

at line 393
string __toString()

Pfad

Pfad des Verzeichnisses als String zurückgeben. Der Pfad ist immer mit einem Separator abgeschlossen

Return Value

string Daten des Objekts

See also

Directory::SEPARATOR

in Alvine at line 211
void __set(string $name, mixed $value)

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;

Parameters

string $name Name der Eigenschaft
mixed $value Wert der Eigenschaft

Return Value

void

in Alvine at line 222
boolean __isset(string $name)

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

Parameters

string $name

Return Value

boolean

in Alvine at line 231
__unset(string $name)

Zurücksetzen von Werten

Parameters

string $name

in Alvine at line 256
mixed __get(string $name)

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;
}

Parameters

string $name Name der Eigenschaft

Return Value

mixed Wert der Eigenschaft

Exceptions

BadPropertyException

in Alvine at line 281
Closure getClosure(string $name)

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.

Parameters

string $name Name des Closure

Return Value

Closure

Exceptions

NotFoundException
BadPropertyException

in Alvine at line 307
boolean propertyExists(string $name)

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;
}

Parameters

string $name Name der Eigenschaft

Return Value

boolean

in Alvine at line 339
mixed __call(string $name, array $arguments)

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!

Parameters

string $name Funktionsname
array $arguments Argumente

Return Value

mixed Ergebnis des Callbacks

Exceptions

NotCallableException Exception

in Alvine at line 362
boolean isCallable(type $name)

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();
}

Parameters

type $name Name der Methode

Return Value

boolean Ergebnis

in Alvine at line 376
string getHashCode() deprecated

deprecated 20140611

Die Methode Alvine::getID() verwenden!

Return Value

string Hashwert des Objektes

in Alvine at line 396
string getID()

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)

Return Value

string UUID des Objektes

in Alvine at line 416
string getShortID(int|null $length = null)

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.

Parameters

int|null $length

Return Value

string

in Alvine at line 442
boolean equals(Alvine $object)

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)) {
  // ...
}

Parameters

Alvine $object Objekt das überprüft werden soll

Return Value

boolean true wenn beide Objekte identisch sind.

in Alvine at line 463
Alvine getClone(boolean $deepClone = false)

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

Parameters

boolean $deepClone Clone aller enthaltenen Objekte

Return Value

Alvine

See also

Alvine::__clone

in Alvine at line 475
__clone()

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.

in Alvine at line 493
string getClass()

Name der Klasse

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

echo $obj->getClass();

Return Value

string Klassenname

See also

ClassType::getNormalizedName

in Alvine at line 518
boolean isInstanceOf(object $object)

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

Parameters

object $object

Return Value

boolean

at line 101
__construct(string|null $path, string|null $separator = null)

Erstellt ein neues Directory-Objekt

Es kann ein explizites Trennzeichen übergeben werden. So kann z.B. auf einem Windowssystem auch mit einem UNIX-Pfad umgegangen werden. In der Regel wird für Windows \ und Unix / verwendet. Zeigt der Pfad innerhalb eines phar-Archives (phar://) so wird als Trennzeichen / verwendet.

Parameters

string|null $path Pfad
string|null $separator Pfadtrenner (Defalt self::SEPARATOR)

at line 116
boolean exists()

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

Return Value

boolean true oder false

at line 125
string|null getProtocol()

Protokoll

Return Value

string|null

at line 134
bool isAbsolute()

Prüft ob das Verzeichnis absolut oder relativ im Dateisystem ist.

Return Value

bool

at line 177
Directory delete()

Verzeichnis löschen

Das letzte Verzeichnis in der Kette und alle Unterverzeichnisse und Dateien löschen. Angewendet auf den Pfad /a/b/c würde c und alle in c enthaltenen Verzeichnisse und Dateien entfernt werden.

Das DirectoryObjekt zeigt nach dem löschen, aber weiterhin auf das gelöschte Verzeichnis. Der Wert des Objekts ist also weiterhin /a/b/c

Return Value

Directory Dieses Objekt

Exceptions

IOException Verzeichnis konnte nicht entfernt werden.

at line 222
Directory create()

Verzeichnis anlegen

Return Value

Directory

Exceptions

IOException Objekt konnte nicht erstellt werden.

at line 251
protected Directory determineSeperator(string|null $separator)

Pfadtrenner des Verzeichnis bestimmen

Parameters

string|null $separator Pfadtrenner

Return Value

Directory Dieses Objekt

at line 290
protected Directory analyze(string|null $path, string|null $separator = null)

Analyse einer Zeichenkette

Interne Funktion, die eine Zeichenkette analysiert und die interne Struktur anlegt. Fehlerbehebung: Doppelte Trennzeichen hintereinander werden zu einem Trennzeichen zusammengefasst.

Parameters

string|null $path Pfad des Verzeichnisses
string|null $separator | \null $separator Pfadtrenner

Return Value

Directory Dieses Objekt

Exceptions

TypeException

at line 376
Directory parent(integer $count = 1)

Objekt mit Elternverzeichnis

Parameters

integer $count Anzahl der Verzeichnisse, die nach oben gegangen werden soll.

Return Value

Directory Dieses Objekt mit Elternverzeichnis

at line 414
Directory addChild(string $child)

Unterverzeichnis

Neues Unterverzeichnis hinzufügen. Als Verzeichnis kann ein Name oder ein kompletter Pfad angegeben werden. Als Trennzeichen ist dabei plattformunabhängig das / zu verwenden.

$dir->appendChild('verzeichnis1/verzeichnis2');

Parameters

string $child Unterverzeichnis

Return Value

Directory Dieses Objekt

at line 425
Directory removeChild()

Unterverzeichnis entfernen

Return Value

Directory Dieses Objekt

at line 446
Directory getLastChild()

Letzten Eintrag zurückgeben

Gibt den letzten Teil des Verzeichnisses zurück. Der Teil wird nicht entfernt.

Ist kein Verzeichniss definiert oder es handelt sich um das Root-Verzeichnis, so ist das Ergebnis ein leeres Directory-Objekt

Return Value

Directory Neues Directory-Objekt

at line 467
Directory getLastChilds(int $count)

Letzten Eintrag zurückgeben

Gibt den letzten Teil des Verzeichnisses zurück. Der Teil wird nicht entfernt.

Ist kein Verzeichniss definiert oder es handelt sich um das Root-Verzeichnis, so ist das Ergebnis ein leeres Directory-Objekt

Parameters

int $count

Return Value

Directory Neues Directory-Objekt

at line 487
bool hasChildren()

Sind Unterverzeichnisse vorhanden

Return Value

bool