Documentation

StringType extends Any
in package

Alvine

Types

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

Constants

APIVERSION = 1: Version der API-Version der Klasse.
IDENTIFICATION = 'Alvine': Identifizierung der Alvine API
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

$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$lineFeedMap : array
$properties : array
$string : string: Speicherung des String Inhalts
$outputEncoding : string: Legt das von __toString verwendete Encoding fest
$verified : bool: Dieser Wert spezifiziert ob der String ein echter UTF-8 String ist. ist dieser Wert false, so kann ein Codirungsfehler vorliegen.

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: Neue Zeichenkette anlegen und die Erweiterung festlegen. Beim ersten Erstellen eines Strings wird die interne Kodierung der Multbyte Erweiterung auf UTF-8 umgestellt.
__get() : int|mixed|string: Wert abfragen
__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: Wert setzen
__toString() : int|mixed|string: Gespeicherten Text als Zeichenkette zurückgeben, wenn nichts definiert wurde ist der Text UTF-8
__unserialize() : void
__unset() : mixed: Zurücksetzen von Werten
append() : $this: Anhängen
bytes() : int: Anzahl der Bytes
compareTo() : bool: Überprüfung ob der Vergleichswert identisch zu diesem Objekt ist. Es wird der Inhalt von $this->string geprüft.
contains() : bool: Prüfen auf Inhalt
encode() : string: 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
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.
explode() : StringList: Explode
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!
getHtmlEntities() : string: Wandelt Sonderzeichen in HTML-Entities um und gibt diese zurück
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.
getLines() : StringList: 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.
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.
getSubstring() : StringType: Substring
hasAssociatedProperties() : boolean: Check if the object has associative properties
hasVolatileProperties() : boolean: Prüfen ob das Objekt volatile Eigenschaften besitzt
indexOf() : false|int: Index
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).
isEmpty() : bool: Prüfen ob Leer
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.
lastIndexOf() : false|int: Index
length() : false|int: Länge
match() : bool: Prüft ob der reguläre Ausdruck im String enthalten ist.
propertyExists() : boolean: Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
replace() : $this: Ersetzen
setEncoding() : $this: Encoding setzen
toLowerCase() : $this: 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() : $this: In Großbuchstaben umwandeln
trim() : $this: Zuschneiden
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions
checkEncoding() : $this: Prüft für dieses Objekt das Encoding und wandelt wenn nicht UTF-8 den Inhalt nach UTF-8 um.
isUTF8Compatible() : bool: Prüft ob der Wert des Strings kompatibel mit URF-8 ist und ob keine problematischen Zeichen vorkommen. Gibt true bei erfolgreicher und false bei fehlerhaften Prüfung zurück.

APIVERSION

Version der API-Version der Klasse.


    public
        mixed
    APIVERSION
    = 1

IDENTIFICATION

Identifizierung der Alvine API


    public
        mixed
    IDENTIFICATION
    = 'Alvine'

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

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

$lineFeedMap


    protected
    static    array
    $lineFeedMap
     = null

Initialisierte Liste mit allen definierten Zeilenumbrüche.

$properties


    protected
        array
    $properties
     = []

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

$string

Speicherung des String Inhalts


    protected
        string
    $string
     = ''

$outputEncoding

Legt das von __toString verwendete Encoding fest


    private
        string
    $outputEncoding
     = \Alvine\i18n\Encoding::UTF_8

$verified

Dieser Wert spezifiziert ob der String ein echter UTF-8 String ist. ist dieser Wert false, so kann ein Codirungsfehler vorliegen.


    private
        bool
    $verified
     = true

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

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


    public
                    __construct([string|object $value = null ]) : mixed

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

Parameters

$value : string|object = null: Initialisierung der Zeichenkette

__get()

Wert abfragen


    public
                    __get(string $name) : int|mixed|string

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

Parameters

$name : string: Name der Eigenschaft

Return values

int|mixed|string

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

Wert setzen


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

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

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

__toString()

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


    public
                    __toString() : int|mixed|string

Return values

int|mixed|string

__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

append()

Anhängen


    public
                    append(string|StringType $string) : $this

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

Parameters

$string : string|StringType: anzuhängender String

Return values

$this

bytes()

Anzahl der Bytes


    public
                    bytes() : int

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

Return values

int —

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

compareTo()

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


    public
                    compareTo(string|StringType $string) : bool

Parameters

$string : string|StringType: Vergleichswert

Return values

bool

contains()

Prüfen auf Inhalt


    public
                    contains(string|StringType $string) : bool

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

Parameters

$string : string|StringType: Zeichenkette

Return values

bool

encode()

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


    public
            static        encode(string $string[, string $encoding = Alvinei18nEncoding::UTF_8 ]) : string

Parameters

$string : string
$encoding : string = Alvinei18nEncoding::UTF_8

Return values

string

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.

explode()

Explode


    public
                    explode(string $delimiter) : StringList

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

Parameters

$delimiter : string

Return values

StringList

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

getHtmlEntities()

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


    public
                    getHtmlEntities() : string

Return values

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.


    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

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.


    public
                    getLines() : StringList

Return values

StringList

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

getSubstring()

Substring


    public
                    getSubstring(int $start[, int $length = null ]) : StringType

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

$start : int: Start
$length : int = null: Länge

Return values

StringType

hasAssociatedProperties()

Check if the object has associative properties


    public
                    hasAssociatedProperties() : boolean

Return values

boolean

hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt


    public
                    hasVolatileProperties() : boolean

Return values

boolean

indexOf()

Index


    public
                    indexOf(string|StringType $string[, string $offset = null ]) : false|int

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 : string|StringType: Suche nach dieser Zeichenkette
$offset : string = null: Suche bieginnt ab $offset

Return values

false|int

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

isEmpty()

Prüfen ob Leer


    public
                    isEmpty() : bool

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 values

bool

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

lastIndexOf()

Index


    public
                    lastIndexOf(string|StringType $string[, string $offset = null ]) : false|int

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 : string|StringType: Suche nach dieser Zeichenkette
$offset : string = null: Suche beginnt ab $offset

Return values

false|int

length()

Länge


    public
                    length() : false|int

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 values

false|int

match()

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


    public
                    match(string|StringType $pattern) : bool

Parameters

$pattern : string|StringType: Regulärer Ausdruck

Return values

bool

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

replace()

Ersetzen


    public
                    replace(string|StringType $pattern, string|StringType $replacement) : $this

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

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

Return values

$this

setEncoding()

Encoding setzen


    public
                    setEncoding(string $encoding) : $this

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

$encoding : string

Return values

$this

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.


    public
                    toLowerCase() : $this

Return values

$this

toUpperCase()

In Großbuchstaben umwandeln


    public
                    toUpperCase() : $this

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 values

$this

trim()

Zuschneiden


    public
                    trim([string|null $maskChar = null ]) : $this

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

Parameters

$maskChar : string|null = null

Return values

$this

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>

checkEncoding()

Prüft für dieses Objekt das Encoding und wandelt wenn nicht UTF-8 den Inhalt nach UTF-8 um.


    private
                    checkEncoding() : $this

Return values

$this

isUTF8Compatible()

Prüft ob der Wert des Strings kompatibel mit URF-8 ist und ob keine problematischen Zeichen vorkommen. Gibt true bei erfolgreicher und false bei fehlerhaften Prüfung zurück.


    private
                    isUTF8Compatible() : bool

Return values

bool

StringType extends Any in package Alvine Types

Tags

Table of Contents

Constants

Properties

Methods

Constants

APIVERSION

IDENTIFICATION

SERIALVERSION

VERSION

Properties

$hasAssociatedProperties

$hash

$hasVolatileProperties

$lineFeedMap

$properties

$string

$outputEncoding

$verified

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

Tags

__get()

Parameters

Tags

Return values

__isset()

Parameters

Return values

__serialize()

Tags

Return values

__set()

Parameters

Tags

__toString()

Tags

Return values

__unserialize()

Parameters

Tags

__unset()

Parameters

append()

Parameters

Tags

Return values

bytes()

Tags

Return values

compareTo()

Parameters

Return values

contains()

Parameters

Return values

encode()

Parameters

Tags

Return values

equals()

Parameters

Return values

explode()

Parameters

Tags

Return values

getClass()

Tags

Return values

getClone()

Parameters

Tags

StringType extends Any
in package

Alvine

Types