class Exclusive extends Restricted

LockedFile bietet eine Möglichkeit eine eine Datei exklusiv zu sperren.

Diese Klasse verwendet für die Sperre flock. Alle Hinweise von flock in der PHP-Dokumentation sind zu beachten.

Wurde eine Datei mittels EXCLUSIVELOCK gesperrt, so können keine anderen Prozesse auf diese Datei zugreifen.

$file = new \Alvine\IO\File\Restricted\Exclusive('/readme.txt');
$file->disableBlocking();
$stream = $file->getOutputStream();

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.

SHAREDLOCK

Lese oder geteilter Lock

EXCLUSIVELOCK

Exklusiver Lock

UNLOCK

Sperre aufheben

NONBLOCKING

Nicht blockieren

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine
protected string $protocol from File
protected string $path from File
protected array $pathinfo Zwischenspeicher für den analysierten Pfad from File
protected Directory $directory from File
protected string $filename from File
protected string $basename from File
protected string $extension from File
protected FileInputStream $outputStream from File
protected FileInputStream $inputStream from File
protected boolean $blocking from Restricted
protected resource $resource from Restricted
protected boolean $locked from Restricted

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 auf die Datei als String zurückgeben

from File
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 $file, Directory $base = null)

File-Objekt

from File
setDirectory(Directory $directory = null)

Neues Verzeichnis setzen.

from File
setDirecotory(Directory $directory = null) deprecated

No description

from File
Directory|null
getDirectory()

Verzeichnis

from File
bool
canExecute()

Ist die Datei vorhanden und ausführbar?

from File
bool
canRead()

Ist die Datei vorhanden und ist sie lesbar?

from File
bool
canWrite()

Ist File schreibbar?

from File
bool
exists()

Existiert das File-Objekt im Dateisystem?

from File
bool
isFile()

Ist das Objekt vom Typ Datei oder Stream

from File
bool
isStream()

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

from File
bool
isDirectory()

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

from File
bool
isLink()

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

from File
delete()

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

from File
rename(string $name)

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

from File
void
analyzeAndAssign(string $file)

Analysieren

from File
string|null
getProtocol()

Prtokoll

from File
create(bool $overwrite = false)

Datei anlegen

from File
string
getBasename()

Basisname

from File
string
getName()

Dateiname

from File
bool
isAbsolute()

Wrapper für Directory::isAbsolute();

from File
string|null
getExtension()

Erweiterung des Dateinamens

from File
static File
fromCurrentFilename(string $filename)

Factory

from File
getInputStream()

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.

from File
getOutputStream()

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

from File
getMimeType()

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.

from File
lock(resource $resource = null)

Lock durchführen

doLock(type $resource, type $flag)

Locking durchführen

unlock(type $resource = null)

Unlock

bool
isLocked()

Prüfen ob Datei gesperrt

enableBlocking()

Blocking aktivieren

disableBlocking()

Blocking deaktivieren

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

in File at line 391
string __toString()

Pfad auf die Datei als String zurückgeben

Return Value

string Daten des Objekts

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

in File at line 105
__construct(string $file, Directory $base = null)

File-Objekt

Neues File-Objekt erstellen. Wird ein Directory-Objekt übergeben, so wird dieses als Basisverzeichnis verwendet.

Parameters

string $file Dateiname oder Datei mit Verzeichnis
Directory $base Verzeichnis wenn bei $file nur der Name angegeben wurde.

in File at line 123
File setDirectory(Directory $directory = null)

Neues Verzeichnis setzen.

Parameters

Directory $directory | \null $directory Neues Verzeichnis

Return Value

File Dieses Objekt

in File at line 140
File setDirecotory(Directory $directory = null) deprecated

deprecated since version 20190916

Parameters

Directory $directory | \null $directory Neues Verzeichnis

Return Value

File Dieses Objekt

in File at line 153
Directory|null getDirectory()

Verzeichnis

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

Return Value

Directory|null Verzeichnis

in File at line 162
bool canExecute()

Ist die Datei vorhanden und ausführbar?

Return Value

bool true oder false

in File at line 171
bool canRead()

Ist die Datei vorhanden und ist sie lesbar?

Return Value

bool true oder false

in File at line 180
bool canWrite()

Ist File schreibbar?

Return Value

bool true oder false

in File at line 189
bool exists()

Existiert das File-Objekt im Dateisystem?

Return Value

bool true oder false

in File at line 198
bool isFile()

Ist das Objekt vom Typ Datei oder Stream

Return Value

bool true oder false

in File at line 207
bool isStream()

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

Return Value

bool true oder false

in File at line 218
bool isDirectory()

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

Return Value

bool true oder false

Exceptions

IOException

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

Return Value

bool true oder false

Exceptions

IOException

in File at line 254
File delete()

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

Return Value

File

Exceptions

IOException Fehler beim löschen
NotFoundException Die Datei existiert nicht

in File at line 306
File rename(string $name)

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

Parameters

string $name Neuer Name der Datei

Return Value

File

in File at line 339
protected void analyzeAndAssign(string $file)

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.

Parameters

string $file Dateiname mit Pfadangabe

Return Value

void

Exceptions

MalformedFileException Geworfen, wenn der Pfad falsch ist.

in File at line 400
string|null getProtocol()

Prtokoll

Return Value

string|null

in File at line 419
File create(bool $overwrite = false)

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.

Parameters

bool $overwrite Überschreiben

Return Value

File

in File at line 436
string getBasename()

Basisname

Name der Datei (inkl. Erweiterung)

Return Value

string Name

in File at line 447
string getName()

Dateiname

Name der Datei (ohne Erweiterung)

Return Value

string Name

in File at line 456
bool isAbsolute()

Wrapper für Directory::isAbsolute();

Return Value

bool

in File at line 472
string|null getExtension()

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.

Return Value

string|null Extension einer Datei ohne Punkt

in File at line 497
static File fromCurrentFilename(string $filename)

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.

Parameters

string $filename Dateiname ohne Pfadangaben

Return Value

File Neues Objekt

Exceptions

InvalidArgumentException

in File at line 518
FileInputStream getInputStream()

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.

Return Value

FileInputStream Stream-Objekt

in File at line 530
FileOutputStream getOutputStream()

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

Return Value

FileOutputStream Stream-Objekt

in File at line 561
MediaType getMimeType()

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.

Return Value

MediaType MediaType

at line 58
Restricted lock(resource $resource = null)

Lock durchführen

Parameters

resource $resource

Return Value

Restricted

Exceptions

RestrictedException
TypeException

in Restricted at line 110
protected Restricted doLock(type $resource, type $flag)

Locking durchführen

Parameters

type $resource
type $flag

Return Value

Restricted

Exceptions

RestrictedException
TypeException

in Restricted at line 139
Restricted unlock(type $resource = null)

Unlock

Parameters

type $resource

Return Value

Restricted

Exceptions

RestrictedException

in Restricted at line 161
bool isLocked()

Prüfen ob Datei gesperrt

Return Value

bool

in Restricted at line 170
Restricted enableBlocking()

Blocking aktivieren

Return Value

Restricted

in Restricted at line 180
Restricted disableBlocking()

Blocking deaktivieren

Return Value

Restricted