Programming PHP

Resources
A resource is a generic data container that can hold any sort of data. An internal list
mechanism keeps track of your resources, which are referenced through simple
resource identifiers.
Use resources in your extensions when the extension is providing an interface to
something that needs cleanup. When the resource goes out of scope or your script
ends, your destructor function for that resource is called, and you can free memory,
close network connections, remove temporary files, etc.
Here’s a simple little example where we tie our resource to a trivial struct that contains
only a string and an integer (name and age, in this case):
static int le_test;
typedef struct _test_le_struct {
char *name;
long age;
} test_le_struct;
The struct can contain anything: a file pointer, a database connection handle, etc.
The destructor function for our resource looks like this:
static void _php_free_test(zend_rsrc_list_entry *rsrc TSRMLS_DC) {
test_le_struct *test_struct = (test_le_struct *)rsrc->ptr;
efree(test_struct->name);
efree(test_struct);
}
In your MINIT( ) function, add this line to register your destructor for the le_test
resource:
le_test = zend_register_list_destructors_ex(_php_free_test, NULL, "test",
module_number);
Now, here’s a fictitious my_init( ) function that initializes the data associated with
the resource. It takes a string and an integer (name and age):
PHP_FUNCTION(my_init) {
char *name = NULL;
int name_len, age;
test_le_struct *test_struct;
}
if (zend_parse_parameters(ZEND_NUM_ARGS( ) TSRMLS_CC, "sl", &name,
&name_len, &age) == FAILURE) {
return;
}
test_struct = emalloc(sizeof(test_le_struct));
test_struct->name = estrndup(name, name_len);
test_struct->age = age;
ZEND_REGISTER_RESOURCE(return_value, test_struct, le_test);
This is the Title of the Book, eMatter Edition
Copyright © 2002 O’Reilly & Associates, Inc. All rights reserved.
Resources | 349