Metodi __toString

Meneteli __toString on taikameneteli PHP:ssä, joka määrittelee, kuinka olion tulisi käyttäytyä, kun yritetään muuntaa se merkkijonoksi. Tätä meneteliä kutsutaan automaattisesti, kun oliota käytetään kontekstissa, jossa odotetaan merkkijonoa, esimerkiksi tulostettaessa echo:lla tai ketjuttaessa. Menetelän tulee palauttaa olion merkkijonoesitys.

Syntaksi

public function __toString(): string
{
	// return string representation
}

Esimerkki

Luodaan yksinkertainen luokka menetelällä __toString:

<?php
	class User
	{
		public function __toString(): string
		{
			return 'User object';
		}
	}

	$user = new User();
	echo $user;
?>

Koodin suorituksen tulos:

'User object'

Esimerkki

Monimutkaisempi esimerkki olion ominaisuuksien palauttamisella:

<?php
	class Product
	{
		private $name = 'Laptop';
		private $price = 1000;

		public function __toString(): string
		{
			return $this->name . ' - ' . $this->price;
		}
	}

	$product = new Product();
	echo 'Product: ' . $product;
?>

Koodin suorituksen tulos:

'Product: Laptop - $1000'

Katso myös

meneteli __construct,
joka on olion konstruktori
meneteli __destruct,
joka on olion destruktori