Магический метод __toString() — PHP: Введение в ООП

Некоторые методы в классах имеют специальное предназначение и часто называются "магическими". Их легко отличить от других методов наличием двух подчёркиваний в начале имени метода. К таким методам относится и конструктор. Другим полезным и часто используемым методом является __toString. Его "магичность" заключается в том, что он вызывается автоматически, в тех ситуациях, когда объект используется как строка. К таким ситуациям относится интерполяция или конкатенация. Результат вызова этого метода используется как строковое представление объекта.

<?php

class Point
{
    public $x;
    public $y;

    public function __construct($x, $y)
    {
        $this->x = $x;
        $this->y = $y;
    }

    public function getX()
    {
        return $this->x;
    }

    public function getY()
    {
        return $this->y;
    }

    public function __toString()
    {
        return "({$this->x}, {$this->y})";
    }
}

$point = new Point(1, 10);

// Автоматически вызывается __toString
echo $point; // => (1, 10)

// И тут
$message = 'hello, ' . $point;

// И тут
$message2 = "hi, {$point}";

Но этот же метод не вызовется, если передать объект в print_r(). Эта функция всегда пытается отобразить внутреннее представление того, что ей передали.

__toString() должен вернуть строку, иначе произойдёт ошибка. Ошибка возникнет и в том случае, когда у объекта нет метода __toString().

<?php

echo $o;
// PHP Catchable fatal error:  Object of class stdClass could not be converted to string

Дополнительные материалы

1. Официальная документация

---

Остались вопросы? Задайте их в разделе «Обсуждение»

Вам ответят команда поддержки Хекслета или другие студенты