PHP: Конструкторы и деструкторы

Конструкторы и деструкторы ¶

Конструктор ¶

__construct(mixed ...$values = ""): void

PHP разрешает разработчикам объявлять для классов методы-конструкторы. Класс с методом-конструктором вызовет этот метод на каждом вновь созданном объекте класса. Поэтому объявление метода-конструктора удобно для инициализации того, что может потребоваться объекту в начале работы.

Замечание: Класс не будет неявно вызывать конструкторы, которые определили в классах-родителях, если дочерний класс определяет свой конструктор. Внутри конструктора дочернего класса требуется вызвать parent::__construct(), чтобы запустить конструктор родительского класса. Дочерний класс унаследует конструктор родительского класса как обычный метод, если в дочернем классе конструктор не определили и родительский конструктор не закрытый.

Пример #1 Конструкторы при наследовании

<?php

class BaseClass
{
   function __construct()
   {
       print "Конструктор класса BaseClass\n";
   }
}

class SubClass extends BaseClass
{
   function __construct()
   {
       parent::__construct();
       print "Конструктор класса SubClass\n";
   }
}

class OtherSubClass extends BaseClass
{
    // Наследует конструктор класса BaseClass
}

// Конструктор класса BaseClass
$obj = new BaseClass();

// Конструктор класса BaseClass
// Конструктор класса SubClass
$obj = new SubClass();

// Конструктор класса BaseClass
$obj = new OtherSubClass();

?>

В отличие от других методов, метод __construct() освобождается от правил совместимости сигнатуры при наследовании.

Конструкторы — обыкновенные методы, которые вызываются при инстанциировании объектов, которые содержат эти конструкторы, или объектов дочерних классов без конструктора. Поэтому в конструкторах определяют произвольное количество аргументов, которые разрешено объявлять обязательными, типизированными, со значением по умолчанию. Аргументы конструктора указываются в круглых скобках после имени класса.

Пример #2 Объявление аргументов в конструкторах

<?php

class Point
{
    protected int $x;
    protected int $y;

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

// Передаём оба параметра
$p1 = new Point(4, 5);

// Передаём только обязательные параметры. Переменная $y содержит значение по умолчанию 0
$p2 = new Point(4);

// Вызываем с именованными параметрами (начиная с PHP 8.0):
$p3 = new Point(y: 5, x: 4);

?>

Скобки после имени класса необязательны, если у класса нет конструктора, или конструктор класса не содержит обязательных параметров.

Конструкторы в старом стиле

До PHP 8.0.0 классы в глобальном пространстве имён будут интерпретировать названный именем класса метод как конструктор старого стиля. Этот синтаксис устарел и будет вызывать ошибку уровня E_DEPRECATED, но всё равно вызовет этот метод как конструктор. PHP вызовет как конструктор метод __construct(), если в классе определили и метод __construct(), и метод с именем класса.

У метода, название которого совпадает с именем класса, нет особого значения в классах внутри пространства имён, а с PHP 8.0.0 — в любых классах.

В новом коде определяют только метод __construct().

Продвижение свойств в конструкторе ¶

С PHP 8.0.0 параметры конструктора можно продвинуть до свойств объекта. Это распространённая практика — присваивать свойствам объекта значения только за счёт переданных в конструктор аргументов. Определение свойств класса в конструкторе значительно сокращает количество шаблонного кода для такого случая. Пример выше можно будет переписать вот так:

Пример #3 Продвижение параметров конструктора до свойств

<?php

class Point
{
    public function __construct(protected int $x, protected int $y = 0) {}
}

?>

PHP интерпретирует аргумент одновременно и как параметр конструктора, и как свойство объекта, и устанавливает значение аргумента свойству, когда параметр конструктора содержит модификатор. Тогда тело конструктора оставляют пустым или добавляют другие инструкции. Конструктор выполнит дополнительные инструкции после присваивания значений аргументов свойствам.

Не каждый аргумент обязан продвигать параметр конструктора до свойства объекта. Допустимо смешивать продвигаемые и непродвигаемые параметры в произвольном порядке, и давать обыкновенным параметрам конструктора имена, которые совпадают с именами свойств класса. Аргументы, которые продвигают параметры до свойств, не влияют на вызывающий конструктор код.

Замечание:
Указать модификатор области видимости — public, protected или private — наиболее вероятный способ применить продвинутую установку свойств, но любой другой модификатор, например readonly, даст такой же эффект.

Замечание:
Нельзя указывать свойствам объекта тип callable. Это связано с неоднозначностью, которую они представляют для движка PHP. Поэтому и для параметров конструктора, которые устанавливают классу свойства, также нельзя указывать тип callable. Любые другие декларации типов допустимы.

Замечание:
PHP применяет ограничения на именование параметров конструктора как к свойствам класса, так и к параметрам функции, поскольку при разборе кода PHP преобразовывает синтаксический сахар продвинутых свойств в декларирование свойств класса с теми же модификаторами видимости и типом данных, которые указали в продвинутом параметре, и присваивает значение аргумента и параметру функции, и свойству класса.

Замечание:
Атрибуты, которые установили для аргумента в продвинутом конструкторе, будут реплицированы как на аргумент, так и на свойство класса. Значение по умолчанию для аргумента в продвинутом конструкторе распространяется только на аргумент, а не свойство.

Ключевое слово new в инициализаторах ¶

В PHP 8.1.0 разрешили присваивать объекты как значения по умолчанию для параметров, как значения статических переменных и глобальных констант, а также как значения аргументов в атрибутах. Объекты также допустимо передавать в функцию define().

Замечание:
При этом динамические или нестроковые имена классов или анонимных классов не разрешены. Использовать распаковку аргументов не разрешено. Неподдерживаемые выражения как аргументы не разрешены.

Пример #4 Пример ключевого слова new при инициализации класса

<?php

// Всё допустимо:
static $x = new Foo;
const C = new Foo;

function test($param = new Foo) {}

#[AnAttribute(new Foo)]
class Test
{
    public function __construct(
        public $prop = new Foo,
    ) {}
}

// Всё запрещено (ошибка времени компиляции):
function test(
    $a = new (CLASS_NAME_CONSTANT)(), // Динамическое имя класса
    $b = new class {}, // Анонимный класс
    $c = new A(...[]), // Распаковка аргументов
    $d = new B($abc), // Неподдерживаемое постоянное выражение
) {}

?>

Статические методы, которые создают объект класса ¶

PHP поддерживает только один конструктор для класса. Однако бывает так, что нужно создавать разные объекты для разных входных данных. Рекомендуемый способ — использовать статические методы как обёртки над конструктором.

Пример #5 Использование статических методов для создания объектов

<?php

class Product
{
    private ?int $id;
    private ?string $name;

    private function __construct(?int $id = null, ?string $name = null)
    {
        $this->id = $id;
        $this->name = $name;
    }

    public static function fromBasicData(int $id, string $name): static
    {
        $new = new static($id, $name);
        return $new;
    }

    public static function fromJson(string $json): static
    {
        $data = json_decode($json, true);
        return new static($data['id'], $data['name']);
    }

    public static function fromXml(string $xml): static
    {
        // Пользовательская логика
        $data = convert_xml_to_array($xml);
        $new = new static();
        $new->id = $data['id'];
        $new->name = $data['name'];
        return $new;
    }
}

$p1 = Product::fromBasicData(5, 'Widget');
$p2 = Product::fromJson($some_json_string);
$p3 = Product::fromXml($some_xml_string);

?>

Конструктор разрешено делать закрытым или защищённым, чтобы исключить вызов конструктора извне. Тогда создать объект класса получится только через статический метод. Доступ к закрытым методам класса есть и у конструктора, и у статического метода, поскольку конструктор, статический и закрытый методы определили в одном и том же классе, даже если один экземпляр объекта вызывает закрытый метод другого. Закрытый конструктор необязателен, и будет ли в закрытом конструкторе смысл, определяет ситуация.

В примере выше три открытых статических метода показывают разные способы, которыми они создают экземпляр объекта.

Метод fromBasicData() принимает конкретные параметры, создаёт экземпляр класса через конструктор и возвращает результат.
Метод fromJson() принимает JSON-строку и выполняет над строкой предварительную обработку, чтобы преобразовать строку в формат, который требует конструктор. Затем метод возвращает новый объект.
Метод fromXml() принимает XML-строку, предварительно обрабатывает её, а затем создаёт пустой объект. При этом PHP вызывает конструктор, но поскольку параметры конструктора необязательны, метод пропускает их. Затем непосредственно перед возвратом результата метод присваивает значения свойствам объекта.

В каждом из трёх случаев ключевое слово static транслируется в имя класса, в котором вызвали код. В примере — в имя класса Product.

Деструкторы ¶

__destruct(): void

Концепция деструктора PHP повторяет концепцию других объектно-ориентированных языков, например C++. PHP вызовет деструктор, как только не останется ссылок на конкретный объект, или в другом порядке в течение завершения работы.

Пример #6 Пример использования деструктора

<?php

class MyDestructableClass
{
   function __construct()
   {
       print "Конструктор\n";
   }

   function __destruct()
   {
       print "Уничтожается " . __CLASS__  . "\n";
   }
}

$obj = new MyDestructableClass();

?>

Как и конструкторы, движок PHP не будет неявно вызывать деструкторы, которые объявили в родительском классе. Необходимо вызвать parent::__destruct() в теле деструктора дочернего класса, чтобы запустить деструктор родительского класса. Аналогично конструкторам, дочерний класс, в котором не определен деструктор, наследует деструктор из родительского класса.

Движок вызовет деструктор, даже если выполнение скрипта остановила функция exit(). Вызов функции exit() в деструкторе предотвратит запуск остальных процедур завершения работы.

Если деструктор создаёт новые ссылки на свой объект, он не будет вызван во второй раз, когда счётчик ссылок снова достигнет нуля или во время последовательности выключения.

Начиная с PHP 8.4.0, когда сбор циклических ссылок происходит во время выполнения файбера, деструкторы объектов, запланированных для сбора, выполняются в отдельном файбере, называемом gc_destructor_fiber. Если файбер приостановлен, будет создан новый для выполнения всех оставшихся деструкторов. Предыдущий gc_destructor_fiber больше не будет упоминаться сборщиком мусора и может быть собран, если на него нет других ссылок. Объекты, деструктор которых приостановлен, не будут собираться до тех пор, пока деструктор не вернётся или пока не будет собран сам файбер.

Замечание:
При завершении работы скрипта PHP отправляет HTTP-заголовки перед обработкой деструкторов. На этапе завершения работы скрипта рабочая директория, как её определяет PHP, иногда не совпадает с рабочей директорией, которую возвращают отдельные SAPI-интерфейсы (например, в Apache).

Замечание:
Попытка выбросить исключение из деструктора, который вызвали во время завершения работы скрипта, вызовет фатальную ошибку.

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей 13 notes

down

164

david dot scourfield at llynfi dot co dot uk ¶

13 years ago

Be aware of potential memory leaks caused by circular references within objects.  The PHP manual states "[t]he destructor method will be called as soon as all references to a particular object are removed" and this is precisely true: if two objects reference each other (or even if one object has a field that points to itself as in $this->foo = $this) then this reference will prevent the destructor being called even when there are no other references to the object at all.  The programmer can no longer access the objects, but they still stay in memory.

Consider the following example:

<?php

header("Content-type: text/plain");

class Foo {
    
    /**
     * An indentifier
     * @var string 
     */
    private $name;
    /**
     * A reference to another Foo object
     * @var Foo
     */
    private $link;

    public function __construct($name) {
        $this->name = $name;
    }

    public function setLink(Foo $link){
        $this->link = $link;
    }

    public function __destruct() {
        echo 'Destroying: ', $this->name, PHP_EOL;
    }
}

// create two Foo objects:
$foo = new Foo('Foo 1');
$bar = new Foo('Foo 2');

// make them point to each other
$foo->setLink($bar);
$bar->setLink($foo);

// destroy the global references to them
$foo = null;
$bar = null;

// we now have no way to access Foo 1 or Foo 2, so they OUGHT to be __destruct()ed
// but they are not, so we get a memory leak as they are still in memory.
//
// Uncomment the next line to see the difference when explicitly calling the GC:
// gc_collect_cycles();
// 
// see also: http://www.php.net/manual/en/features.gc.php
// 

// create two more Foo objects, but DO NOT set their internal Foo references
// so nothing except the vars $foo and $bar point to them:
$foo = new Foo('Foo 3');
$bar = new Foo('Foo 4');

// destroy the global references to them
$foo = null;
$bar = null;

// we now have no way to access Foo 3 or Foo 4 and as there are no more references
// to them anywhere, their __destruct() methods are automatically called here,
// BEFORE the next line is executed:

echo 'End of script', PHP_EOL;

?>

This will output:

Destroying: Foo 3
Destroying: Foo 4
End of script
Destroying: Foo 1
Destroying: Foo 2

But if we uncomment the gc_collect_cycles(); function call in the middle of the script, we get:

Destroying: Foo 2
Destroying: Foo 1
Destroying: Foo 3
Destroying: Foo 4
End of script

As may be desired.

NOTE: calling gc_collect_cycles() does have a speed overhead, so only use it if you feel you need to.

down

Hayley Watson ¶

1 year ago

There are other advantages to using static factory methods to wrap object construction instead of bare constructor calls.

As well as allowing for different methods to use in different scenarios, with more relevant names both for the methods and the parameters and without the constructor having to handle different sets of arguments of different types:

* You can do all your input validation before attempting to construct the object.
* The object itself can bypass that input validation when constructing new instances of its own class, since you can ensure that it knows what it's doing.
* With input validation/preprocessing moved to the factory methods, the constructor itself can often be reduced to "set these properties to these arguments", meaning the constructor promotion syntax becomes more useful.
* Having been hidden away from users, the constructor's signature can be a bit uglier without becoming a pain for them. Heh.
* Static methods can be lifted and passed around as first class closures, to be called in the normal fashion wherever functions can be called, without the special "new" syntax.
* The factory method need not return a new instance of that exact class. It could return a pre-existing instance that would do the same job as the new one would (especially useful in the case of immutable "value type" objects by reducing duplication); or a simpler or more specific subclass to do the job with less overhead than a more generic instance of the original class. Returning a subclass means LSP still holds.

down

domger at freenet dot de ¶

7 years ago

The __destruct magic method must be public. 

public function __destruct()
{
    ;
}

The method will automatically be called externally to the instance.  Declaring __destruct as protected or private will result in a warning and the magic method will not be called. 

Note: In PHP 5.3.10 i saw strange side effects while some Destructors were declared as protected.

down

spleen ¶

16 years ago

It's always the easy things that get you -

Being new to OOP, it took me quite a while to figure out that there are TWO underscores in front of the word __construct.

It is __construct
Not _construct

Extremely obvious once you figure it out, but it can be sooo frustrating until you do.

I spent quite a bit of needless time debugging working code.

I even thought about it a few times, thinking it looked a little long in the examples, but at the time that just seemed silly(always thinking "oh somebody would have made that clear if it weren't just a regular underscore...")

All the manuals I looked at, all the tuturials I read, all the examples I browsed through  - not once did anybody mention this!  

(please don't tell me it's explained somewhere on this page and I just missed it,  you'll only add to my pain.)

I hope this helps somebody else!

down

iwwp at outlook dot com ¶

5 years ago

To better understand the __destrust method:

class A {
    protected $id;

    public function __construct($id)
    {
        $this->id = $id;
        echo "construct {$this->id}\n";
    }

    public function __destruct()
    {
        echo "destruct {$this->id}\n";
    }
}

$a = new A(1);
echo "-------------\n";
$aa = new A(2);
echo "=============\n";

The output content:

construct 1
-------------
construct 2
=============
destruct 2
destruct 1

down

david at synatree dot com ¶

17 years ago

When a script is in the process of die()ing, you can't count on the order in which __destruct() will be called.

For a script I have been working on, I wanted to do transparent low-level encryption of any outgoing data.  To accomplish this, I used a global singleton class configured like this:

class EncryptedComms
{
    private $C;
    private $objs = array();
    private static $_me;
    
    public static function destroyAfter(&$obj)
    {
        self::getInstance()->objs[] =& $obj;
        /*
            Hopefully by forcing a reference to another object to exist 
            inside this class, the referenced object will need to be destroyed
            before garbage collection can occur on this object.  This will force 
            this object's destruct method to be fired AFTER the destructors of
            all the objects referenced here.
        */
    }
    public function __construct($key)
    {
            $this->C = new SimpleCrypt($key);
            ob_start(array($this,'getBuffer'));
    }
    public static function &getInstance($key=NULL)
    {
        if(!self::$_me && $key)
            self::$_me = new EncryptedComms($key);
        else
            return self::$_me;
    }
    
    public function __destruct()
    {
        ob_end_flush();
    }
    
    public function getBuffer($str)
    {
        return $this->C->encrypt($str);
    }

}

In this example, I tried to register other objects to always be destroyed just before this object.  Like this:

class A
{

public function __construct()
{
     EncryptedComms::destroyAfter($this);
}
}

One would think that the references to the objects contained in the singleton would be destroyed first, but this is not the case.  In fact, this won't work even if you reverse the paradigm and store a reference to EncryptedComms in every object you'd like to be destroyed before it.

In short, when a script die()s, there doesn't seem to be any way to predict the order in which the destructors will fire.

down

mmulej at gmail dot com ¶

3 years ago

*<Double post> I can't edit my previous note to elaborate on modifiers. Please excuse me.*

If both parent and child classes have a method with the same name defined, and it is called in parent's constructor, using `parent::__construct()` will call the method in the child.

<?php

class A {
    public function __construct() {
        $this->method();
    }
    public function method() {
        echo 'A' . PHP_EOL;
    }
}
class B extends A {
    public function __construct() {
        parent::__construct();
    }
}
class C extends A {
    public function __construct() {
        parent::__construct();
    }
    public function method() {
        echo 'C' . PHP_EOL;
    }
}
$b = new B; // A
$c = new C; // C

?>

In this example both A::method and C::method are public.

You may change A::method to protected, and C::method to protected or public and it will still work the same.

If however you set A::method as private, it doesn't matter whether C::method is private, protected or public. Both $b and $c will echo 'A'.

down

Per Persson ¶

13 years ago

As of PHP 5.3.10 destructors are not run on shutdown caused by fatal errors.

For example:
<?php
class Logger
{
    protected $rows = array();

    public function __destruct()
    {
        $this->save();
    }

    public function log($row)
    {
        $this->rows[] = $row;
    }

    public function save()
    {
        echo '<ul>';
        foreach ($this->rows as $row)
        {
            echo '<li>', $row, '</li>';
        }
        echo '</ul>';
    }
}

$logger = new Logger;
$logger->log('Before');

$nonset->foo();

$logger->log('After');
?>

Without the $nonset->foo(); line, Before and After will both be printed, but with the line neither will be printed.

One can however register the destructor or another method as a shutdown function:
<?php
class Logger
{
    protected $rows = array();

    public function __construct()
    {
        register_shutdown_function(array($this, '__destruct'));
    }
    
    public function __destruct()
    {
        $this->save();
    }
    
    public function log($row)
    {
        $this->rows[] = $row;
    }
    
    public function save()
    {
        echo '<ul>';
        foreach ($this->rows as $row)
        {
            echo '<li>', $row, '</li>';
        }
        echo '</ul>';
    }
}

$logger = new Logger;
$logger->log('Before');

$nonset->foo();

$logger->log('After');
?>
Now Before will be printed, but not After, so you can see that a shutdown occurred after Before.

down

prieler at abm dot at ¶

17 years ago

i have written a quick example about the order of destructors and shutdown functions in php 5.2.1:

<?php
class destruction {
    var $name;

    function destruction($name) {
        $this->name = $name;
        register_shutdown_function(array(&$this, "shutdown"));
    }

    function shutdown() {
        echo 'shutdown: '.$this->name."\n";
    }

    function __destruct() {
        echo 'destruct: '.$this->name."\n";
    }
}

$a = new destruction('a: global 1');

function test() {
    $b = new destruction('b: func 1');
    $c = new destruction('c: func 2');
}
test();

$d = new destruction('d: global 2');

?>

this will output:
shutdown: a: global 1
shutdown: b: func 1
shutdown: c: func 2
shutdown: d: global 2
destruct: b: func 1
destruct: c: func 2
destruct: d: global 2
destruct: a: global 1

conclusions:
destructors are always called on script end.
destructors are called in order of their "context": first functions, then global objects
objects in function context are deleted in order as they are set (older objects first).
objects in global context are deleted in reverse order (older objects last)

shutdown functions are called before the destructors.
shutdown functions are called in there "register" order. ;)

regards, J

down

bolshun at mail dot ru ¶

17 years ago

Ensuring that instance of some class will be available in destructor of some other class is easy: just keep a reference to that instance in this other class.

down

Yousef Ismaeil cliprz[At]gmail[Dot]com ¶

11 years ago

<?php

/**
 * a funny example Mobile class
 * 
 * @author Yousef Ismaeil Cliprz[At]gmail[Dot]com
 */

class Mobile {

    /**
     * Some device properties
     * 
     * @var string
     * @access public
     */
    public $deviceName,$deviceVersion,$deviceColor;
    
    /**
     * Set some values for Mobile::properties
     * 
     * @param string device name
     * @param string device version
     * @param string device color
     */
    public function __construct ($name,$version,$color) {
        $this->deviceName = $name;
        $this->deviceVersion = $version;
        $this->deviceColor = $color;
        echo "The ".__CLASS__." class is stratup.<br /><br />";
    }
    
    /**
     * Some Output
     * 
     * @access public
     */
    public function printOut () {
        echo 'I have a '.$this->deviceName
            .' version '.$this->deviceVersion
            .' my device color is : '.$this->deviceColor;
    }
    
    /**
     * Umm only for example we will remove Mobile::$deviceName Hum not unset only to check how __destruct working 
     * 
     * @access public
     */
    public function __destruct () {
        $this->deviceName = 'Removed';
        echo '<br /><br />Dumpping Mobile::deviceName to make sure its removed, Olay :';
        var_dump($this->deviceName);
        echo "<br />The ".__CLASS__." class is shutdown.";
    }

}

// Oh ya instance
$mob = new Mobile('iPhone','5','Black');

// print output
$mob->printOut();

?>

The Mobile class is stratup.

I have a iPhone version 5 my device color is : Black

Dumpping Mobile::deviceName to make sure its removed, Olay :
string 'Removed' (length=7)

The Mobile class is shutdown.

down

-1

Jonathon Hibbard ¶

15 years ago

Please be aware of when using __destruct() in which you are unsetting variables...

Consider the following code:
<?php
class my_class {
  public $error_reporting = false;

  function __construct($error_reporting = false) {
    $this->error_reporting = $error_reporting;
  }

  function __destruct() {
    if($this->error_reporting === true) $this->show_report();
    unset($this->error_reporting);
  }
?>

The above will result in an error:
Notice: Undefined property: my_class::$error_reporting in my_class.php on line 10

It appears as though the variable will be unset BEFORE it actually can execute the if statement.  Removing the unset will fix this.  It's not needed anyways as PHP will release everything anyways, but just in case you run across this, you know why ;)

down

-3

Reza Mahjourian ¶

18 years ago

Peter has suggested using static methods to compensate for unavailability of multiple constructors in PHP.  This works fine for most purposes, but if you have a class hierarchy and want to delegate parts of initialization to the parent class, you can no longer use this scheme.  It is because unlike constructors, in a static method you need to do the instantiation yourself.  So if you call the parent static method, you will get an object of parent type which you can't continue to initialize with derived class fields.

Imagine you have an Employee class and a derived HourlyEmployee class and you want to be able to construct these objects out of some XML input too.

<?php
class Employee {
   public function __construct($inName) {
       $this->name = $inName;
   }

   public static function constructFromDom($inDom)
   {
       $name = $inDom->name;
       return new Employee($name);
   }

   private $name;
}

class HourlyEmployee extends Employee {
   public function __construct($inName, $inHourlyRate) {
       parent::__construct($inName);
       $this->hourlyRate = $inHourlyRate;
   }

   public static function constructFromDom($inDom)
   {
       // can't call parent::constructFromDom($inDom)
       // need to do all the work here again
       $name = $inDom->name;  // increased coupling
       $hourlyRate = $inDom->hourlyrate;
       return new EmployeeHourly($name, $hourlyRate);
   }

   private $hourlyRate;
}
?>

The only solution is to merge the two constructors in one by adding an optional $inDom parameter to every constructor.

＋Добавить