class StringType extends Any

Die String-Klasse von Alvine bringt die für Alvine2 benötigten Unterstüzung für UTF-8 mit und stellt nützliche Methoden zur Bearbeitung von UTF-8 Strings zur Verfügung. Die Klasse ist auf die Verwendung der Multi-Byte Erweiterung zugeschnitten.

In späteren Versionen kann aber auch eine andere Erweiterung zum Einsatz kommen.

$string = new \Alvine\Core\String();
$string->string='Ich esse gerne Äpfel';  // Inhalt setzen
echo $string;  // Gibt folgendes aus: Ich esse gerne Äpfel

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.

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 $string Speicherung des Stringinhaltes
static protected array $lineFeedMap

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

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

void
__set(string $name, mixed $value)

Wert setzen

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)

Wert abfragen

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|object $value = null)

Neue Zeichenkette anlegen und die Erweiterung festlegen. Beim ersten Erstellen eines Strings wird die interne Kodierung der Multbyte Erweiterung auf UTF-8 umgestellt.

setEncoding(string $encoding)

Encoding setzen

int
bytes()

Anzahl der Bytes

int
length()

Länge

toLowerCase()

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.

toUpperCase()

In Großbuchstaben umwandeln

trim(string $maskChar = null)

Zuschneiden

boolean
isEmpty()

Prüfen ob Leer

getLines()

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(string $delimiter)

Explode

string
getHtmlEntities()

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

append(string|StringType $string)

Anhängen

int|mixed
indexOf(string|StringType $string, string $offset = null)

Index

int|mixed
lastIndexOf(string|StringType $string, string $offset = null)

Index

getSubstring(int $start, int $length = null)

Substring

replace(string|StringType $pattern, string|StringType $replacement)

Ersetzen

boolean
contains(string|StringType $string)

Prüfen auf Inhalt

boolean
match(string|StringType $pattern)

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

boolean
compareTo(string|StringType $string)

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

static string
encode(string $string, string $encoding = \Alvine\i18n\Encoding::UTF_8)

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

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 177
string __toString()

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

Return Value

string Daten des Objekts

at line 114
void __set(string $name, mixed $value)

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.

Parameters

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

Return Value

void

See also

Alvine

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

at line 135
mixed __get(string $name)

Wert abfragen

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

Parameters

string $name Name der Eigenschaft

Return Value

mixed Wert der Eigenschaft

See also

Alvine

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 85
__construct(string|object $value = null)

Neue Zeichenkette anlegen und die Erweiterung festlegen. Beim ersten Erstellen eines Strings wird die interne Kodierung der Multbyte Erweiterung auf UTF-8 umgestellt.

Wird als Parameter ein Objekt übergeben, so muss die Klasse eine __toString Methode besitzen.

Parameters

string|object $value Initialisierung der Zeichenkette

at line 157
StringType setEncoding(string $encoding)

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.

Parameters

string $encoding

Return Value

StringType

Exceptions

StringException

at line 191
int bytes()

Anzahl der Bytes

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

Return Value

int Anzahl der benötigten Bytes die zur Speicherung des UTF-8 Strings notwendig sind.

See also

String->length()

at line 206
int length()

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.

Return Value

int Länge des UTF-8 Strings

See also

String->bytes()

at line 217
StringType toLowerCase()

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.

Return Value

StringType Referenz auf eigenes Objekt

at line 230
StringType toUpperCase()

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.

Return Value

StringType Referenz auf eigenes Objekt

at line 245
StringType trim(string $maskChar = null)

Zuschneiden

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

Parameters

string $maskChar

Return Value

StringType

at line 264
boolean isEmpty()

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.

Return Value

boolean Wenn der String leer ist wird true zurückgegeben.

at line 281
StringList getLines()

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.

Return Value

StringList Liste mit den Array-Objekten

See also

StringList

at line 312
StringList explode(string $delimiter)

Explode

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

Parameters

string $delimiter Trennzeichen

Return Value

StringList Liste mit den Array-Objekten

See also

StringList

at line 332
string getHtmlEntities()

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

Return Value

string Zeichenkette mit HTML-Entities

at line 347
StringType append(string|StringType $string)

Anhängen

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

Parameters

string|StringType $string anzuhängender String

Return Value

StringType Dieses Objekt

at line 369
int|mixed indexOf(string|StringType $string, string $offset = null)

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.

Parameters

string|StringType $string Suche nach dieser Zeichenkette
string $offset Suche bieginnt ab $offset

Return Value

int|mixed Position an der das Zeichen auftritt, oder false

at line 392
int|mixed lastIndexOf(string|StringType $string, string $offset = null)

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.

Parameters

string|StringType $string Suche nach dieser Zeichenkette
string $offset Suche bieginnt ab $offset

Return Value

int|mixed Position an der das Zeichen auftritt, oder false

at line 425
StringType getSubstring(int $start, int $length = null)

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

Parameters

int $start Start
int $length Länge

Return Value

StringType Neues Stringobjekt mit dem Teilstring

at line 451
StringType replace(string|StringType $pattern, string|StringType $replacement)

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

Parameters

string|StringType $pattern Suche nach dieser Zeichenkette (ohne Delimiter)
string|StringType $replacement Ersetzen mit dieser Zeichenkette

Return Value

StringType Dieses Objekt

at line 475
boolean contains(string|StringType $string)

Prüfen auf Inhalt

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

Parameters

string|StringType $string Zeichenkette

Return Value

boolean Ergebnis

at line 491
boolean match(string|StringType $pattern)

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

Parameters

string|StringType $pattern Regulärer Ausdruck

Return Value

boolean Ergebnis

at line 512
boolean compareTo(string|StringType $string)

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

Parameters

string|StringType $string Vergleichswert

Return Value

boolean Ergebnis

at line 577
static string encode(string $string, string $encoding = \Alvine\i18n\Encoding::UTF_8)

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

Parameters

string $string
string $encoding

Return Value

string