phpday 2022

Das Stringable-Interface

(PHP 8)

Einführung

Das Interface Stringable kennzeichnet, dass eine Klasse eine __toString()-Methode enthält. Anders als die meisten anderen Interfaces, ist das Interface Stringable implizit bei allen Klassen präsent, welche die magische Methode __toString() enthalten. Das Interface kann und sollte jedoch explizit deklariert werden.

Der primäre Anwendungsfall ist es, Funktionen eine Typenüberprüfung gegen den Vereinigungstypen string|Stringable zu ermöglichen. Damit können diese entweder eine Zeichenkette oder ein Objekt akzeptieren, welches in eine Zeichenkette umgewandelt werden kann.

Interface-Übersicht

interface Stringable {
/* Methoden */
public __toString(): string
}

Stringable-Beispiele

Beispiel #1 Grundlegende Verwendung von Stringable

<?php
class IPv4Address implements Stringable {
    private 
string $oct1;
    private 
string $oct2;
    private 
string $oct3;
    private 
string $oct4;

    public function 
__construct(string $oct1string $oct2string $oct3string $oct4) {
        
$this->oct1 $oct1;
        
$this->oct2 $oct2;
        
$this->oct3 $oct3;
        
$this->oct4 $oct4;
    }

    public function 
__toString(): string {
        return 
"$this->oct1.$this->oct2.$this->oct3.$this->oct4";
    }
}

function 
showStuff(string|Stringable $value) {
    
// Hier wird ein Stringable durch den Aufruf von __toString
    // in einen String umgewandelt
    
print $value;
}

$ip = new IPv4Address('123''234''42''9');

showStuff($ip);
?>

Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:

123.234.42.9

Inhaltsverzeichnis

add a note add a note

User Contributed Notes 1 note

up
0
Gormack
2 months ago
Since it's introduced in PHP 8, IPv4Address class Example #1 could be shortened to:
<?php
class IPv4Address implements Stringable {
    public function
__construct(private string $oct1, private string $oct2, private string $oct3, private string $oct4) {
    }

    public function
__toString(): string {
        return
"$this->oct1.$this->oct2.$this->oct3.$this->oct4";
    }
}
?>
To Top