PHP Manual
Prev | Chapter 45. PDO Driver How-To | Next

# Fleshing out your skeleton

## Major Structures and Attributes

The major structures, pdo_dbh_t and pdo_stmt_t are defined and explained in Appendix A and B respectively. Database and Statement attributes are defined in Appendix C. Error handling is explained in Appendix D.

## pdo_SKEL.c: PHP extension glue

### function entries

    static function_entry pdo_SKEL_functions[] = {
      { NULL, NULL, NULL }
    };

This structure is used to register functions into the global php function namespace. PDO drivers should try to avoid doing this, so it is recommended that you leave this structure initialized to NULL, as shown in the synopsis above.

### Module entry

    /* {{{ pdo_SKEL_module_entry */
    #if ZEND_EXTENSION_API_NO >= 220050617
    static zend_module_dep pdo_SKEL_deps[] = {
        ZEND_MOD_REQUIRED("pdo")
        {NULL, NULL, NULL}
    };
    #endif
    /* }}} */

    zend_module_entry pdo_SKEL_module_entry = {
    #if ZEND_EXTENSION_API_NO >= 220050617
        STANDARD_MODULE_HEADER_EX, NULL,
        pdo_SKEL_deps,
    #else
        STANDARD_MODULE_HEADER,
    #endif
        "pdo_SKEL",
        pdo_SKEL_functions,
        PHP_MINIT(pdo_SKEL),
        PHP_MSHUTDOWN(pdo_SKEL),
        NULL,
        NULL,
        PHP_MINFO(pdo_SKEL),
        PHP_PDO_<DB>_MODULE_VERSION,
        STANDARD_MODULE_PROPERTIES
    };
    /* }}} */

    #ifdef COMPILE_DL_PDO_<DB>
    ZEND_GET_MODULE(pdo_db)
    #endif

A structure of type zend_module_entry called pdo_SKEL_module_entry must be declared and should include reference to the pdo_SKEL_functions table defined previously.

### Standard PHP Module Extension Functions

#### PHP_MINIT_FUNCTION

    /* {{{ PHP_MINIT_FUNCTION */
    PHP_MINIT_FUNCTION(pdo_SKEL)
    {
        return php_pdo_register_driver(&pdo_SKEL_driver);
    }
    /* }}} */

This standard PHP extension function should be used to register your driver with the PDO layer. This is done by calling the php_pdo_register_driver() function passing a pointer to a structure of type pdo_driver_t typically named pdo_SKEL_driver. A pdo_driver_t contains a header that is generated using the PDO_DRIVER_HEADER(SKEL) macro and pdo_SKEL_handle_factory() function pointer. The actual function is described during the discussion of the `SKEL_dbh.c` unit.

#### PHP_MSHUTDOWN_FUNCTION

    /* {{{ PHP_MSHUTDOWN_FUNCTION */
    PHP_MSHUTDOWN_FUNCTION(pdo_SKEL)
    {
        php_pdo_unregister_driver(&pdo_SKEL_driver);
        return SUCCESS;
    }
    /* }}} */

This standard PHP extension function is used to unregister your driver from the PDO layer. This is done by calling the php_pdo_unregister_driver() function, passing the same pdo_SKEL_driver structure that was passed in the init function above.

#### PHP_MINFO_FUNCTION

This is again a standard PHP extension function. Its purpose is to display information regarding the module when the phpinfo() is called from a script. The convention is to display the version of the module and also what version of the db you are dependent on, along with any other configuration style information that might be relevant.

## SKEL_driver.c: Driver implementation

This unit implements all of the database handling methods that support the PDO database handle object. It also contains the error fetching routines. All of these functions will typically need to access the global variable pool. Therefore, it is necessary to use the Zend macro TSRMLS_DC macro at the end of each of these statements. Consult the Zend programmer documentation for more information on this macro.

### pdo_SKEL_error

    static int pdo_SKEL_error(pdo_dbh_t *dbh,
      pdo_stmt_t *stmt, const char *file, int line TSRMLS_DC)

The purpose of this function is to be used as a generic error handling function within the driver. It is called by the driver when an error occurs within the driver. If an error occurs that is not related to SQLSTATE, the driver should set either dbh->error_code or stmt->error_code to an SQLSTATE that most closely matches the error or the generic SQLSTATE error "HY000". The file pdo_sqlstate.c in the PDO source contains a table of commonly used SQLSTATE codes that the PDO code explicitly recognizes. This setting of the error code should be done prior to calling this function.; This function should set the global pdo_err variable to the error found in either the dbh or the stmt (if the variable stmt is not NULL).

dbh

  Pointer to the database handle initialized by the handle factory

stmt

  Pointer to the current statement or NULL. If NULL, the error is derived by error code found in the dbh.

file

  The source file where the error occurred or NULL if not available.

line

  The line number within the source file if available.

If the dbh member methods is NULL (which implies that the error is being raised from within the PDO constructor), this function should call the zend_throw_exception_ex() function otherwise it should return the error code. This function is usually called using a helper macro that customizes the calling sequence for either database handling errors or statement handling errors.

Example 45-1. Example macros for invoking pdo_SKEL_error
    #define pdo_SKEL_drv_error(what) \
        pdo_SKEL_error(dbh, NULL, what, __FILE__, __LINE__ TSRMLS_CC)
    #define pdo_SKEL_drv_error(what) \
        pdo_SKEL_error(dbh, NULL, what, __FILE__, __LINE__ TSRMLS_CC)

For more info on error handling, see the Section called Error handling.

> Note: Despite being documented here, the PDO driver interface does not specify that his function be present; it is merely a convenient way to handle errors, and it just happens to be equally convenient for the majority of database client library APIs to structure your driver implementation in this way.

### pdo_SKEL_fetch_error_func

    static int pdo_SKEL_fetch_error_func(pdo_dbh_t *dbh, pdo_stmt_t *stmt,
        zval *info TSRMLS_DC)

The purpose of this function is to obtain additional information about the last error that was triggered. This includes the driver specific error code and a human readable string. It may also include additional information if appropriate. This function is called as a result of the PHP script calling the PDO::errorInfo() method.

dbh

  Pointer to the database handle initialized by the handle factory

stmt

  Pointer to the most current statement or NULL. If NULL, the error translated is derived by error code found in the dbh.

info

  A hash table containing error codes and messages.

The error_func should return two pieces of information as successive array elements. The first item is expected to be a numeric error code, the second item is a descriptive string. The best way to set this item is by using add_next_index. Note that the type of the first argument need not be long; use whichever type most closely matches the error code returned by the underlying database API.

    /* now add the error information. */
    /* These need to be added in a specific order */
    add_next_index_long(info, error_code);   /* driver specific error code */
    add_next_index_string(info, message, 0); /* readable error message */

This function should return 1 if information is available, 0 if the driver does not have additional info.

### SKEL_handle_closer

    static int SKEL_handle_closer(pdo_dbh_t *dbh TSRMLS_DC)

This function will be called by PDO to close an open database.

dbh

  Pointer to the database handle initialized by the handle factory

This should do whatever database specific activity that needs to be accomplished to close the open database. PDO ignores the return value from this function.

### SKEL_handle_preparer

    static int SKEL_handle_preparer(pdo_dbh_t *dbh, const char *sql,
    long sql_len, pdo_stmt_t *stmt, zval *driver_options TSRMLS_DC)

This function will be called by PDO in response to PDO::query() and PDO::prepare() calls from the PHP script. The purpose of the function is to prepare raw SQL for execution, storing whatever state is appropriate into the stmt that is passed in.

dbh

  Pointer to the database handle initialized by the handle factory

sql

  Pointer to a character string containing the SQL statement to be prepared.

sql_len

  The length of the SQL statement.

Stmt

  Pointer to the returned statement or NULL if an error occurs.

driver_options

  Any driver specific/defined options.

This function is essentially the constructor for a stmt object. This function is responsible for processing statement options, and setting driver-specific option fields in the pdo_stmt_t structure.

PDO does not process any statement options on the driver's behalf before calling the preparer function. It is your responsibility to process them before you return, raising an error for any unknown options that are passed.

One very important responsibility of this function is the processing of SQL statement parameters. At the time of this call, PDO does not if your driver supports binding parameters into prepared statements, nor does it know if it supports named or positional parameter naming conventions.

Your driver is responsible for setting stmt->supports_placeholders as appropriate for the underlying database. This may involved some run-time determination on the part of your driver, if this setting depends on the version of the database server to which it is connected. If your driver doesn't directly support both named and positional parameter conventions, you should use the pdo_parse_params() API to have PDO rewrite the query to take advantage of the support provided by your database.

Example 45-2. Using pdo_parse_params
    int ret;
        char *nsql = NULL;
        int nsql_len = 0;

        /* before we prepare, we need to peek at the query; if it uses named parameters,
         * we want PDO to rewrite them for us */
        stmt->supports_placeholders = PDO_PLACEHOLDER_POSITIONAL;
        ret = pdo_parse_params(stmt, (char*)sql, sql_len, &nsql, &nsql_len TSRMLS_CC);

        if (ret == 1) {
            /* query was re-written */
            sql = nsql;
        } else if (ret == -1) {
            /* couldn't grok it */
            strcpy(dbh->error_code, stmt->error_code);
            return 0;
        }

        /* now proceed to prepare the query in "sql" */

Possible values for supports_placeholders are: `PDO_PLACEHOLDER_NAMED`, `PDO_PLACEHOLDER_POSITIONAL` and `PDO_PLACEHOLDER_NONE`. If the driver doesn't support prepare statements at all, then this function should simply allocate any state that it might need, and then return:

Example 45-3. implementing preparer for drivers that don't support native prepared statements
    static int SKEL_handle_preparer(pdo_dbh_t *dbh, const char *sql,
        long sql_len, pdo_stmt_t *stmt, zval *driver_options TSRMLS_DC)
    {
        pdo_SKEL_db_handle *H = (pdo_SKEL_db_handle *)dbh->driver_data;
        pdo_SKEL_stmt *S = ecalloc(1, sizeof(pdo_SKEL_stmt));

        S->H = H;
        stmt->driver_data = S;
        stmt->methods = &SKEL_stmt_methods;
        stmt->supports_placeholders = PDO_PLACEHOLDER_NONE;

        return 1;
    }

This function returns 1 on success or 0 on failure.

### SKEL_handle_doer

    static long SKEL_handle_doer(pdo_dbh_t *dbh, const char *sql, long sql_len TSRMLS_DC)

This function will be called by PDO to execute a raw SQL statement. No pdo_stmt_t is created.

dbh

  Pointer to the database handle initialized by the handle factory

sql

  Pointer to a character string containing the SQL statement to be prepared.

sql_len

  The length of the SQL statement.

This function returns 1 on success or 0 on failure.

### SKEL_handle_quoter

    static int SKEL_handle_quoter(pdo_dbh_t *dbh, const char *unquoted,
      int unquoted_len, char **quoted, int quoted_len, enum pdo_param_type param_type TSRMLS_DC)

This function will be called by PDO to turn an unquoted string into a quoted string for use in a query.

dbh

  Pointer to the database handle initialized by the handle factory

unquoted

  Pointer to a character string containing the string to be quoted.

unquoted_len

  The length of the string to be quoted.

quoted

  Pointer to the address where a pointer to the newly quoted string will be returned.

quoted_len

  The length of the new string.

param_type

  A driver specific hint for driver that have alternate quoting styles

This function is called in response to a call to PDO::quote() or when the driver has set supports_placeholder to `PDO_PLACEHOLDER_NONE`. The purpose is to quote a parameter when building SQL statements.

If your driver does not support native prepared statements, implementation of this function is required.

This function returns 1 if the quoting process reformatted the string, and 0 if it was not necessary to change the string. The original string will be used unchanged with a 0 return.

### SKEL_handle_begin

    static int SKEL_handle_begin(pdo_dbh_t *dbh TSRMLS_DC)

This function will be called by PDO to begin a database transaction.

dbh

  Pointer to the database handle initialized by the handle factory

This should do whatever database specific activity that needs to be accomplished to begin a transaction. This function returns 1 for success or 0 if an error occurred.

### SKEL_handle_commit

    static int SKEL_handle_commit(pdo_dbh_t *dbh TSRMLS_DC)

This function will be called by PDO to end a database transaction.

dbh

  Pointer to the database handle initialized by the handle factory

This should do whatever database specific activity that needs to be accomplished to commit a transaction. This function returns 1 for success or 0 if an error occurred.

### SKEL_handle_rollback

    static int SKEL_handle_rollback( pdo_dbh_t *dbh TSRMLS_DC)

This function will be called by PDO to rollback a database transaction.

dbh

  Pointer to the database handle initialized by the handle factory

This should do whatever database specific activity that needs to be accomplished to rollback a transaction. This function returns 1 for success or 0 if an error occurred.

### SKEL_handle_get_attribute

    static int SKEL_handle_get_attribute(pdo_dbh_t *dbh, long attr, zval *return_value TSRMLS_DC)

This function will be called by PDO to retrieve a database attribute.

dbh

  Pointer to the database handle initialized by the handle factory

attr

  long value of one of the PDO_ATTR_xxxx types. See Table 45-1 for valid attributes.

return_value

  The returned value for the attribute.

It is up to the driver to decide which attributes will be supported for a particular implementation. It is not necessary for a driver to supply this function. PDO driver handles the PDO_ATTR_PERSISTENT, PDO_ATTR_CASE, PDO_ATTR_ORACLE_NULLS, and PDO_ATTR_ERRMODE attributes directly.

This function returns 1 on success or 0 on failure.

### SKEL_handle_set_attribute

    static int SKEL_handle_set_attribute(pdo_dbh_t *dbh, long attr, zval *val TSRMLS_DC)

This function will be called by PDO to set a database attribute, usually in response to a script calling PDO::setAttribute().

dbh

  Pointer to the database handle initialized by the handle factory

attr

  long value of one of the PDO_ATTR_xxxx types. See Table 45-1 for valid attributes.

val

  The new value for the attribute.

It is up to the driver to decide which attributes will be supported for a particular implementation. It is not necessary for a driver to provide this function if it does not need to support additional attributes. The PDO driver handles the PDO_ATTR_CASE, PDO_ATTR_ORACLE_NULLS, and PDO_ATTR_ERRMODE attributes directly.

This function returns 1 on success or 0 on failure.

### SKEL_handle_last_id

    static char * SKEL_handle_last_id(pdo_dbh_t *dbh, const char *name, unsigned int len TSRMLS_DC)

This function will be called by PDO to retrieve the ID of the last inserted row.

dbh

  Pointer to the database handle initialized by the handle factory

name

  string representing a table or sequence name.

len

  the length of the name parameter.

This function returns a character string containing the id of the last inserted row on success or NULL on failure. This is an optional function.

### SKEL_check_liveness

    static int SKEL_check_liveness(pdo_dbh_t *dbh TSRMLS_DC)

This function will be called by PDO to test whether or not a persistent connection to a database is alive and ready for use.

dbh

  Pointer to the database handle initialized by the handle factory

This function returns 1 if the database connection is alive and ready for use, otherwise it should return 0 to indicate failure or lack of support.

> Note: This is an optional function.

### SKEL_get_driver_methods

    static function_entry *SKEL_get_driver_methods(pdo_dbh_t *dbh, int kind TSRMLS_DC)

This function will be called by PDO in response to a call to any method that is not a part of either the PDO or PDOStatement classes. It's purpose is to allow the driver to provide additional driver specific methods to those classes.

dbh

  Pointer to the database handle initialized by the handle factory

kind

  One of the following:

  PDO_DBH_DRIVER_METHOD_KIND_DBH

    Set when the method call was attempted on an instance of the PDO class. The driver should return a pointer a function_entry table for any methods it wants to add to that class, or NULL if there are none.

  PDO_DBH_DRIVER_METHOD_KIND_STMT

    Set when the method call was attempted on an instance of the PDOStatement class. The driver should return a pointer to a function_entry table for any methods it wants to add to that class, or NULL if there are none.

This function returns a pointer to the function_entry table requested, or NULL there are no driver specific methods.

### SKEL_handle_factory

    static int SKEL_handle_factory(pdo_dbh_t *dbh, zval *driver_options TSRMLS_DC)

This function will be called by PDO to create a database handle. For most databases this involves establishing a connection to the database. In some cases, a persistent connection may be requested, in other cases connection pooling may be requested. All of these are database/driver dependent.

dbh

  Pointer to the database handle initialized by the handle factory

driver_options

  An array of driver options, keyed by integer option number. See Table 45-1 for a list of possible attributes.

This function should fill in the passed database handle structure with its driver specific information on success and return 1, otherwise it should return 0 to indicate failure.

PDO processes the AUTOCOMMIT and PERSISTENT driver options before calling the handle_factory. It is the handle factory's responsibility to process other options.

### Driver method table

A static structure of type pdo_dbh_methods named SKEL_methods must be declared and initialized to the function pointers for each defined function. If a function is not supported or not implemented the value for that function pointer should be set to NULL.

### pdo_SKEL_driver

A structure of type pdo_driver_t named pdo_SKEL_driver should be declared. The PDO_DRIVER_HEADER(SKEL) macro should be used to declare the header and the function pointer to the handle factory function should set.

## SKEL_statement.c: Statement implementation

This unit implements all of the database statement handling methods that support the PDO statement object.

### SKEL_stmt_dtor

    static int SKEL_stmt_dtor(pdo_stmt_t *stmt TSRMLS_DC)

This function will be called by PDO to destroy a previously constructed statement object.

stmt

  Pointer to the statement structure initialized by SKEL_handle_preparer.

This should do whatever is necessary to free up any driver specific storage allocated for the statement. The return value from this function is ignored.

### SKEL_stmt_execute

    static int SKEL_stmt_execute(pdo_stmt_t *stmt TSRMLS_DC)

This function will be called by PDO to execute the prepared SQL statement in the passed statement object.

stmt

  Pointer to the statement structure initialized by SKEL_handle_preparer.

This function returns 1 for success or 0 in the event of failure.

### SKEL_stmt_fetch

    static int SKEL_stmt_fetch(pdo_stmt_t *stmt, enum pdo_fetch_orientation ori,
       long offset TSRMLS_DC)

This function will be called by PDO to fetch a row from a previously executed statement object.

stmt

  Pointer to the statement structure initialized by SKEL_handle_preparer.

ori

  One of PDO_FETCH_ORI_xxx which will determine which row will be fetched.

offset

  If ori is set to PDO_FETCH_ORI_ABS or PDO_FETCH_ORI_REL, offset represents the row desired or the row relative to the current position, respectively. Otherwise, this value is ignored.

The results of this fetch are driver dependent and the data is usually stored in the driver_data member of pdo_stmt_t object. The ori and offset parameters are only meaningful if the statement represents a scrollable cursor. This function returns 1 for success or 0 in the event of failure.

### SKEL_stmt_param_hook

    static int SKEL_stmt_param_hook(pdo_stmt_t *stmt,
      struct pdo_bound_param_data *param, enum pdo_param_event event_type TSRMLS_DC)

This function will be called by PDO for handling of both bound parameters and bound columns.

stmt

  Pointer to the statement structure initialized by SKEL_handle_preparer.

param

  The structure describing either a statement parameter or a bound column.

event_type

  The type of event to occur for this parameter, one of the following:

  PDO_PARAM_EVT_ALLOC

    Called when PDO allocates the binding. Occurs as part of PDOStatement::bindParam(), PDOStatement::bindValue() or as part of an implicit bind when calling PDOStatement::execute(). This is your opportunity to take some action at this point; drivers that implement native prepared statements will typically want to query the parameter information, reconcile the type with that requested by the script, allocate an appropriately sized buffer and then bind the parameter to that buffer. You should not rely on the type or value of the zval at param->parameter at this point in time.

  PDO_PARAM_EVT_FREE

    Called once per parameter as part of cleanup. You should release any resources associated with that parameter now.

  PDO_PARAM_EXEC_PRE

    Called once for each parameter immediately before calling SKEL_stmt_execute; take this opportunity to make any final adjustments ready for execution. In particular, you should note that variables bound via PDOStatement::bindParam() are only legal to touch now, and not any sooner.

  PDO_PARAM_EXEC_POST

    Called once for each parameter immediately after calling SKEL_stmt_execute; take this opportunity to make any post-execution actions that might be required by your driver.

  PDO_PARAM_FETCH_PRE

    Called once for each parameter immediately prior to calling SKEL_stmt_fetch.

  PDO_PARAM_FETCH_POST

    Called once for each parameter immediately after calling SKEL_stmt_fetch.

This hook will be called for each bound parameter and bound column in the statement. For ALLOC and FREE events, a single call will be made for each parameter or column. The param structure contains a driver_data field that the driver can use to store implementation specific information about each of the parameters.

For all other events, PDO may call you multiple times as the script issues PDOStatement::execute() and PDOStatement::fetch() calls.

If this is a bound parameter, the is_param flag in the param structure, otherwise, the param structure refers to a bound column.

This function returns 1 for success or 0 in the event of failure.

### SKEL_stmt_describe_col

    static int SKEL_stmt_describe_col(pdo_stmt_t *stmt, int colno TSRMLS_DC)

This function will be called by PDO to query information about a particular column.

stmt

  Pointer to the statement structure initialized by SKEL_handle_preparer.

colno

  The column number to be queried.

The driver should populate the pdo_stmt_t member columns(colno) with the appropriate information. This function returns 1 for success or 0 in the event of failure.

### SKEL_stmt_get_col_data

    static int SKEL_stmt_get_col_data(pdo_stmt_t *stmt, int colno,
      char **ptr, unsigned long *len, int *caller_frees TSRMLS_DC)

This function will be called by PDO to retrieve data from the specified column.

stmt

  Pointer to the statement structure initialized by SKEL_handle_preparer.

colno

  The column number to be queried.

ptr

  Pointer to the retrieved data.

len

  The length of the data pointed to by ptr.

caller_frees

  If set, ptr should point to emalloc'd memory and the main PDO driver will free it as soon as it is done with it. Otherwise, it will be the responsibility of the driver to free any allocated memory as a result of this call.

The driver should return the resultant data and length of that data in the ptr and len variables respectively. It should be noted that the main PDO driver expects the driver to manage the lifetime of the data. This function returns 1 for success or 0 in the event of failure.

### SKEL_stmt_set_attr

    static int SKEL_stmt_set_attr(pdo_stmt_t *stmt, long attr, zval *val TSRMLS_DC)

This function will be called by PDO to allow the setting of driver specific attributes for a statement object.

stmt

  Pointer to the statement structure initialized by SKEL_handle_preparer.

attr

  long value of one of the PDO_ATTR_xxxx types. See Table 45-1 for valid attributes.

val

  The new value for the attribute.

This function is driver dependent and allows the driver the capability to set database specific attributes for a statement. This function returns 1 for success or 0 in the event of failure. This is an optional function. If the driver does not support additional settable attributes, it can be NULLed in the method table. The PDO driver does not handle any settable attributes on the database driver's behalf.

### SKEL_stmt_get_attr

    static int SKEL_stmt_get_attr(pdo_stmt_t *stmt, long attr, zval
       *return_value TSRMLS_DC)

This function will be called by PDO to allow the retrieval of driver specific attributes for a statement object.

stmt

  Pointer to the statement structure initialized by SKEL_handle_preparer.

attr

  long value of one of the PDO_ATTR_xxxx types. See Table 45-1 for valid attributes.

return_value

  The returned value for the attribute.

This function is driver dependent and allows the driver the capability to retrieve a previously set database specific attribute for a statement. This function returns 1 for success or 0 in the event of failure. This is an optional function. If the driver does not support additional gettable attributes, it can be NULLed in the method table. The PDO driver does not handle any settable attributes on the database driver's behalf.

### SKEL_stmt_get_col_meta

    static int SKEL_stmt_get_col_meta(pdo_stmt_t *stmt, int colno,
       zval *return_value TSRMLS_DC)

Warning
This function is not well defined and is subject to change.

This function will be called by PDO to retrieve meta-data from the specified column.

stmt

  Pointer to the statement structure initialized by SKEL_handle_preparer.

colno

  The column number for which data is to be retrieved.

return_value

  Holds the returned meta data.

The driver author should consult the documentation for this function that can be found in the php_pdo_driver.h header as this will be the most current. This function returns 1 for success or 0 in the event of failure. The database driver does not need to provide this function.

### Statement handling method table

A static structure of type pdo_stmt_methods named SKEL_stmt_methods should be declared and initialized to the function pointers for each defined function. If a function is not supported or not implemented the value for that function pointer should be set to NULL.

Prev | Home | Next
Preparation and Housekeeping | Up | Building