php/archived-php-src
1
0
Fork 0
mirror of https://github.com/php/php-src.git synced 2026-03-24 00:02:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document .dtor_obj and .free_obj

Browse Source 
Closes GH-6656.

Co-authored-by: Nikita Popov <nikic@php.net>
This commit is contained in:
Levi Morrison
2021-01-31 22:32:24 -07:00
committed by Nikita Popov
parent 23a7b0f323
commit 32dd853624
1 changed files with 22 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
Zend/zend_object_handlers.h
View File

@@ -110,9 +110,29 @@ typedef zend_array *(*zend_object_get_properties_for_t)(zend_object *object, zen
typedef zend_function *(*zend_object_get_method_t)(zend_object **object, zend_string *method, const zval *key);
typedef zend_function *(*zend_object_get_constructor_t)(zend_object *object);
/* Object maintenance/destruction */
typedef void (*zend_object_dtor_obj_t)(zend_object *object);
/* free_obj should release any resources the object holds, without freeing the
* object structure itself. The object does not need to be in a valid state after
* free_obj finishes running.
*
* free_obj will always be invoked, even if the object leaks or a fatal error
* occurs. However, during shutdown it may be called once the executor is no
* longer active, in which case execution of user code may be skipped.
*/
typedef void (*zend_object_free_obj_t)(zend_object *object);
/* dtor_obj is called before free_obj. The object must remain in a valid state
* after dtor_obj finishes running. Unlike free_obj, it is run prior to
* deactivation of the executor during shutdown, which allows user code to run.
*
* This handler is not guaranteed to be called (e.g. on fatal error), and as
* such should not be used to release resources or deallocate memory. Furthermore,
* releasing resources in this handler can break detection of memory leaks, as
* cycles may be broken early.
*
* dtor_obj should be used *only* to call user destruction hooks, such as __destruct.
*/
typedef void (*zend_object_dtor_obj_t)(zend_object *object);
typedef zend_object* (*zend_object_clone_obj_t)(zend_object *object);
/* Get class name for display in var_dump and other debugging functions.