Documentation

Directory extends Alvine
in package

Alvine

IO

File

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.

Constants

APIVERSION = 1: Version der API-Version der Klasse.
IDENTIFICATION = 'Alvine': Identifizierung der Alvine API
ROOT = '': Interner Marker für das Root-Verzeichnis bei UNIX-Systemen
SEPARATOR = \DIRECTORY_SEPARATOR: Verzeichnistrenner
SERIALVERSION = 1: 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.
VERSION = 2: Generelle Alvine-Version

Properties

$dirname : string
$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$parts : array: Zwischenspeicher für den analysierten Pfad
$properties : array
$protocol : string
$separator : string
$dirnameWithoutProtocol : string

Methods

__call() : mixed: Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
__clone() : mixed: 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.
__construct() : mixed: Erstellt ein neues Directory-Objekt
__get() : mixed: 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.
__isset() : boolean: Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
__serialize() : array<string|int, mixed>: Serialization of the object and data. In the serialized object also stores meta-information for matching.
__set() : void: Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
__toString() : string: Pfad
__unserialize() : void
__unset() : mixed: Zurücksetzen von Werten
addChild() : Directory: Unterverzeichnis
create() : Directory: Verzeichnis anlegen
delete() : Directory: Verzeichnis löschen
equals() : boolean: 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.
exists() : boolean: Prüft der Pfad im Dateisystem vorhanden ist und ob es ein Verzeichnis ist.
getClass() : string: Name der Klasse
getClone() : Alvine: Diese Methode gibt ein geklontes Objekt von sich selber zurück.
getClosure() : Closure: 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.
getHashCode() : string: Die Methode Alvine::getID() verwenden!
getID() : string: Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
getLastChild() : Directory: Letzten Eintrag zurückgeben
getLastChilds() : Directory: Letzten Eintrag zurückgeben
getProtocol() : string|null: Protokoll
getShortID() : string: 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.
hasAssociatedProperties() : boolean: Check if the object has associative properties
hasChildren() : boolean: Sind Unterverzeichnisse vorhanden
hasVolatileProperties() : boolean: Prüfen ob das Objekt volatile Eigenschaften besitzt
isAbsolute() : boolean: Prüft ob das Verzeichnis absolut oder relativ im Dateisystem ist.
isCallable() : bool: Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
isInstanceOf() : boolean: 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.
parent() : Directory: Objekt mit Elternverzeichnis
propertyExists() : boolean: Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
removeChild() : Directory: Unterverzeichnis entfernen
analyze() : Directory: Analyse einer Zeichenkette
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions
determineSeperator() : Directory: Pfadtrenner des Verzeichnis bestimmen

APIVERSION

Version der API-Version der Klasse.


    public
        mixed
    APIVERSION
    = 1

IDENTIFICATION

Identifizierung der Alvine API


    public
        mixed
    IDENTIFICATION
    = 'Alvine'

ROOT

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


    public
        mixed
    ROOT
    = ''

SEPARATOR

Verzeichnistrenner


    public
        mixed
    SEPARATOR
    = \DIRECTORY_SEPARATOR

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.


    public
        mixed
    SERIALVERSION
    = 1

https://php.watch/versions/8.1/serializable-deprecated

VERSION

Generelle Alvine-Version


    public
        mixed
    VERSION
    = 2

$dirname


    protected
        string
    $dirname

Directory-Name (aus pathinfo) inkl. Protokoll

$hasAssociatedProperties


    protected
        boolean
    $hasAssociatedProperties
     = null

(nur initialisiert, wenn Serialisierung erfolgte)

$hash

Eindeutige ID


    protected
        string
    $hash
     = null

Die ID wird erst über die Methode \Alvine\Core\Alvine::getID() bei Bedarf ermittelt, deshalb müssen auch abgeleitete Klassen nicht direkt auf den Wert zugreifen, sondern den Wert über getID() holen.

Hash-Wert des Objekts (UUID)

$hasVolatileProperties


    protected
        boolean
    $hasVolatileProperties
     = null

(nur initialisiert, wenn Serialisierung erfolgte)

$parts

Zwischenspeicher für den analysierten Pfad


    protected
        array
    $parts
     = null

Zwischenspeicher

$properties


    protected
        array
    $properties
     = []

Liste mit dynamischen Eigenschaften die über __get und __set bearbeitet werden können.

$protocol


    protected
        string
    $protocol
     = null

Protokoll

$separator


    protected
        string
    $separator

Im Objekt verwendetes Trennzeichen

$dirnameWithoutProtocol


    private
        string
    $dirnameWithoutProtocol

Identisch zu dirname, aber ohne Protokoll (nur zur internen Verwendung)

__call()

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


    public
                    __call(string $name, array $arguments) : mixed

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

$name : string: Funktionsname
$arguments : array: Argumente

Return values

mixed —

Ergebnis des Callbacks

__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.


    public
                    __clone() : mixed

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

__construct()

Erstellt ein neues Directory-Objekt


    public
                    __construct(string $path[, string|null $separator = null ]) : mixed

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

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

__get()

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.


    public
                    __get(string $name) : mixed

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

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

Parameters

$name : string: Name der Eigenschaft

Return values

mixed —

Wert der Eigenschaft

__isset()

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


    public
                    __isset(string $name) : boolean

Parameters

$name : string

Return values

boolean

__serialize()

Serialization of the object and data. In the serialized object also stores meta-information for matching.


    public
                    __serialize() : array<string|int, mixed>

If a derived class is not to be serializable, then this * method must be overridden and throw an exception. this method must be overridden and throw an exception.

Properties starting with volatile or associated. are handled separately. Properties with prefix volatile are not serialized. For properties with the prefix associated, only the * ID of the object is serialized. ID of the object is serialized. If no object is stored in the property is stored in the property, a TypeException is thrown.

Return values

array<string|int, mixed>

__set()

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


    public
                    __set(string $name, mixed $value) : void

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

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

Return values

void

__toString()

Pfad


    public
                    __toString() : string

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

Return values

string —

Verzeichnis

__unserialize()


    public
                    __unserialize(array<string|int, mixed> $serialized) : void

Parameters

$serialized : array<string|int, mixed>

__unset()

Zurücksetzen von Werten


    public
                    __unset(string $name) : mixed

Parameters

$name : string

addChild()

Unterverzeichnis


    public
                    addChild(string $child) : Directory

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

$child : string: Unterverzeichnis

Return values

Directory —

Dieses Objekt

create()

Verzeichnis anlegen


    public
                    create() : Directory

Return values

delete()

Verzeichnis löschen


    public
                    delete() : Directory

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 values

Directory —

Dieses Objekt

equals()

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.


    public
                    equals(Alvine $object) : boolean

class MyObject extends Alvine };

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

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

Parameters

$object : Alvine: Objekt das überprüft werden soll

Return values

boolean —

true wenn beide Objekte identisch sind.

exists()

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


    public
                    exists() : boolean

Return values

boolean —

true oder false

getClass()

Name der Klasse


    public
                    getClass() : string

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

echo $obj->getClass();

Return values

string —

Klassenname

getClone()

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


    public
                    getClone([boolean $deepClone = false ]) : Alvine

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

$deepClone : boolean = false: Clone aller enthaltenen Objekte

Return values

Alvine

getClosure()

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.


    public
                    getClosure(string $name) : Closure

Parameters

$name : string: Name des Closure

Return values

Closure

getHashCode()

Die Methode Alvine::getID() verwenden!


    public
                    getHashCode() : string

Return values

string —

Hashwert des Objektes

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.


    public
                    getID() : string

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 values

string —

UUID des Objektes

getLastChild()

Letzten Eintrag zurückgeben


    public
                    getLastChild() : Directory

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 values

Directory —

Neues Directory-Objekt

getLastChilds()

Letzten Eintrag zurückgeben


    public
                    getLastChilds(int $count) : Directory

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

$count : int

Return values

Directory —

Neues Directory-Objekt

getProtocol()

Protokoll


    public
                    getProtocol() : string|null

Return values

string|null

getShortID()

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.


    public
                    getShortID([int|null $length = null ]) : string

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

$length : int|null = null

Return values

string

hasAssociatedProperties()

Check if the object has associative properties


    public
                    hasAssociatedProperties() : boolean

Return values

boolean

hasChildren()

Sind Unterverzeichnisse vorhanden


    public
                    hasChildren() : boolean

Return values

boolean

hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt


    public
                    hasVolatileProperties() : boolean

Return values

boolean

isAbsolute()

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


    public
                    isAbsolute() : boolean

Return values

boolean

isCallable()

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


    public
                    isCallable(string $name) : bool

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

Parameters

$name : string: Name der Methode

Return values

bool —

Ergebnis

isInstanceOf()

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.


    public
                    isInstanceOf(object $object) : boolean

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

Die Prüfung entspricht

$this instanceof $object

Parameters

$object : object

Return values

boolean

parent()

Objekt mit Elternverzeichnis


    public
                    parent([integer $count = 1 ]) : Directory

Parameters

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

Return values

Directory —

Dieses Objekt mit Elternverzeichnis

propertyExists()

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


    public
                    propertyExists(string $name) : boolean

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

Parameters

$name : string: Name der Eigenschaft

Return values

boolean

removeChild()

Unterverzeichnis entfernen


    public
                    removeChild() : Directory

Return values

Directory —

Dieses Objekt

analyze()

Analyse einer Zeichenkette


    protected
                    analyze(string $path[, string|null $separator = null ]) : Directory

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

Parameters

$path : string: Pfad des Verzeichnisses
$separator : string|null = null

Return values

Directory —

Dieses Objekt

checkAndAdjustSerialisation()

Dealing with versions


    protected
                    checkAndAdjustSerialisation(array $serialization) : array<string|int, mixed>

This method checks an object and ideally repairs older copies. If an old copy cannot be restored be restored, an exception is thrown.

This method must be overridden by the derived classes. be overridden. In the derived class, * the parent method should be called. the parent method should be called.

Parameters

$serialization : array: Daten des serialisiertes Objekts

Return values

array<string|int, mixed>

determineSeperator()

Pfadtrenner des Verzeichnis bestimmen


    protected
                    determineSeperator(string|null $separator) : Directory

Parameters

$separator : string|null: Pfadtrenner

Return values

Directory —

Dieses Objekt

Directory extends Alvine in package Alvine IO File

Tags

Table of Contents

Constants

Properties

Methods

Constants

APIVERSION

IDENTIFICATION

ROOT

SEPARATOR

SERIALVERSION

VERSION

Properties

$dirname

$hasAssociatedProperties

$hash

$hasVolatileProperties

$parts

$properties

$protocol

$separator

$dirnameWithoutProtocol

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Return values

__serialize()

Tags

Return values

__set()

Parameters

Return values

__toString()

Tags

Return values

__unserialize()

Parameters

Tags

__unset()

Parameters

addChild()

Parameters

Return values

create()

Tags

Return values

delete()

Tags

Return values

equals()

Parameters

Return values

exists()

Tags

Return values

getClass()

Tags

Return values

getClone()

Parameters

Tags

Return values

getClosure()

Parameters

Tags

Return values

getHashCode()

Tags

Directory extends Alvine
in package

Alvine

IO

File