ArgumentText

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.

Gespeicherten Text als Zeichenkette zurückgeben, wenn nichts definiert wurde ist der Text UTF-8

Wert setzen

Wird beim Setzen einer Eigenschaft aufgerufen. Wird auf die Eigenschaft string zugegriffen, so wird diese im Stringobjekt verarbeitet, ansonsten im Alvine-Objekt als Eigenschaft. Bei Zugriff auf die Eigenschaft string wird zudem das encoding geprüft.

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

Zurücksetzen von Werten

Wert abfragen

Je nach Name wird entweder der String-Wert der Klasse, oder der Wert einer beliebigen Eigenschaft zurückgegeben.

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 Text-Objekt

Erstellt ein neues Text-Objekt. Der Inhalt kann entweder eine Zeichenkette, oder ein Objekt mit einer __toString Methode sein. Dieses Objekt speichert allerdings nur den Text und nicht das Objekt. Das bedeutet, das der Text zum Zeitpunkt der Objekterstellung statisch ist.

Der Text darf das Sonderzeichen :: nicht enthalten.

Encoding setzen

Für jeden String kann eine eigene Codierung für die Ausgabe angegeben werden. Diese wird sowohl von __toString als auch bei einem direkten Zugriff verwendet $string->string.

Anzahl der Bytes

Diese Funktion gibt anders als length() die Anzahl der verwendeten Bytes zurück

Länge

Bei der Längenberechnung werden Zeichen die Größer als 127 sind, von der PHP-Funktion strlen als 2 Zeichen zurückgemeldet. Diese Funktion berechnet die echten Zeichenlänge und nicht die Anzahl der Bytes.

Diese Funktion wandelt den String in kleine Zeichen um A wird zu a und Ä wird zu ä Diese Funktion gibt eine Referenz auf sich zurück. Damit kann eine Verkettung erstellt werden.

In Großbuchstaben umwandeln

Diese Funktion wandelt den String in große Zeichen um a wird zu A und ä wird zu Ä Diese Funktion gibt eine Referenz auf sich zurück. Damit kann eine Verkettung erstellt werden.

Zuschneiden

Diese Funktion löscht alle Leerzeichen am Anfang und Ende der Zeichenkette.

Prüfen ob Leer

Diese Funktion prüft ob der String leer ist und gibt in diesem Fall true zurück. Wichtig: Anders als die PHP Funktion empty wird bei 0 nicht true zurückgegeben.

Splittet einen String am Zeilenende und gibt die einzelnen Zeilen als StringList zurück. Die Funktion prüft sowohl auf LF, CRLF und CR als auch auf die UTF-8-Trennzeichen.

Explode

Splittet eine Zeichenkette anhand eines Trennzeichen auf und gibt eine Stringliste zurück. Die StringList kann per foreach durchlaufen werden.

Wandelt Sonderzeichen in HTML-Entities um und gibt diese zurück

Anhängen

Hängt einen String an das Ende des Strings an. Es kann entweder ein PHP-Typ oder eine Stringklasse übergeben werden.

Index

Sucht das erste Auftreten von $string im String und gibt die Position zurück. Ist $string nicht enthalten so wird false zurück gegeben.

Index

Sucht das erste Auftreten von $string von hinten im String und gibt die Position zurück. Ist $string nicht enthalten so wird false zurück gegeben.

Substring

Liefert ein neues String-Objekt mit dem definierten Teilstring zurück. Ist der erste Wert eine negative Zahl, so wird der Startwert von rechts gezählt. Ist die Länge eine negative Zahl, so werden $length Zeichen von rechts abgezogen.

$string = new String('1234567890');
echo $string->getSubstring(3,4);  // 4567
echo $string->getSubstring(3,-2); // 45678
echo $string->getSubstring(-4,2); // 56
echo $string->getSubstring(-6,-2); // 5678
echo $string->getSubstring(-2); // 90
echo $string->getSubstring(7); // 890

Ersetzen

Ersetzen einer Zeichenkette im String-Objekt. Intern wird die Funktion mb_ereg_replace verwendet. Es müssen / können keine Delimiter angegeben werden. Das Pattern muß also statt /.+/ nur .+ sein.

$string = 'new String('Iñtërnâtiônàlizætiøn');
// Die ganze Zeichenfolge ersetzen.
$string->replace('Iñtërnâtiônàlizætiøn', 'Test');
echo $string; // Test

Prüfen auf Inhalt

Prüft ob die übergebene Zeichenkette im String enthalten ist. Die Funktion gibt true oder false zurück.

Prüft ob der reguläre Ausdruck im String enthalten ist.

Überprüfung ob der Vergleichswert identisch zu diesem Objekt ist. Es wird der Inhalt von $this->string geprüft.

Wandelt eine Zeichenkette in das gewünschte Zielencoding um und gibt diese Zeichenkette zurück. Diese Funktion benötigt bei einem von UTF-8 abweichenden encoding die Erweiterung mb_convert_encoding

Gibt den Inhalt des aktuellen Textes mit den Argumenten zurück.

Schlüssel Wert setzen