Método __toString

O método __toString é um método mágico em PHP que define como um objeto deve se comportar quando há uma tentativa de convertê-lo em string. Este método é chamado automaticamente quando o objeto é usado em um contexto onde uma string é esperada, por exemplo, ao ser exibido com echo ou durante concatenação. O método deve retornar a representação em string do objeto.

Sintaxe

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

Exemplo

Vamos criar uma classe simples com o método __toString:

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

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

Resultado da execução do código:

'User object'

Exemplo

Um exemplo mais complexo retornando propriedades do objeto:

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

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

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

Resultado da execução do código:

'Product: Laptop - $1000'

Veja também

método __construct,
que é o construtor do objeto
método __destruct,
que é o destruidor do objeto