From e94533ab352a237c3bc0902f27b66087c49a8a1e Mon Sep 17 00:00:00 2001 From: Philip Olson Date: Mon, 3 Dec 2012 07:29:14 +0000 Subject: [PATCH] Formalized informal tables, which adds titles git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328620 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/mysqlnd/plugin.xml | 53 ++++++++++++++++-------------------- reference/mysqlnd/stats.xml | 34 ++++++++++------------- 2 files changed, 39 insertions(+), 48 deletions(-) diff --git a/reference/mysqlnd/plugin.xml b/reference/mysqlnd/plugin.xml index 931aa34f5a..feaf3124a0 100644 --- a/reference/mysqlnd/plugin.xml +++ b/reference/mysqlnd/plugin.xml @@ -285,7 +285,8 @@ The following table shows PHP versions and the corresponding mysqlnd version contained within. - + + The bundled mysqlnd version per PHP release @@ -316,7 +317,7 @@ - +
Plugin developers can determine the mysqlnd version through accessing MYSQLND_VERSION, which @@ -325,7 +326,8 @@ MYSQLND_VERSION_ID, which is an integer such as 50007. Developers can calculate the version number as follows: - + + MYSQLND_VERSION_ID calculation table @@ -352,7 +354,7 @@ - +
During development, developers should refer to the mysqlnd version number for compatibility and @@ -375,7 +377,8 @@ know a little of how mysqlnd itself is organized. Mysqlnd consists of the following modules: - + + The mysqlnd organization chart, per module @@ -408,7 +411,7 @@ - +
C Object Oriented Paradigm @@ -561,7 +564,8 @@ MYSQLND_METHOD(my_conn_class, query)(MYSQLND *conn, The following table shows how to calculate the position of the pointer for a specific plugin: - + + Pointer calculations for mysqlnd @@ -582,7 +586,7 @@ MYSQLND_METHOD(my_conn_class, query)(MYSQLND *conn, - +
If you plan to subclass any of the mysqlnd object constructors, which is allowed, you must keep this in mind! @@ -629,10 +633,8 @@ static MY_CONN_PROPERTIES** get_conn_properties(const MYSQLND *conn TSRMLS_DC) { allocator has some useful features, such as the ability to use a debug allocator in a non-debug build. - - When and how to subclass - - + + When and how to subclass @@ -681,7 +683,7 @@ static MY_CONN_PROPERTIES** get_conn_properties(const MYSQLND *conn TSRMLS_DC) { - +
You must not manipulate function tables at any time later than MINIT if it is not allowed according to the above table. @@ -704,10 +706,8 @@ static MY_CONN_PROPERTIES** get_conn_properties(const MYSQLND *conn TSRMLS_DC) { The advantage of the shared function table approach is performance. There is no need to copy a function table for each and every object. - - Constructors - - + + Constructor status @@ -799,7 +799,7 @@ static MY_CONN_PROPERTIES** get_conn_properties(const MYSQLND *conn TSRMLS_DC) { - +
It is strongly recommended that you do not entirely replace a constructor. The constructors perform memory allocations. The memory @@ -815,10 +815,8 @@ static MY_CONN_PROPERTIES** get_conn_properties(const MYSQLND *conn TSRMLS_DC) { function tables of objects with non-shared object tables, such as Resultset, Network, Wire Protocol. - - Destruction - - + + Destruction status @@ -858,7 +856,7 @@ static MY_CONN_PROPERTIES** get_conn_properties(const MYSQLND *conn TSRMLS_DC) { - +
The destructors are the appropriate place to free properties, mysqlnd_plugin_get_plugin_<object>_data(). @@ -1016,11 +1014,8 @@ static MY_CONN_PROPERTIES** get_conn_properties(const MYSQLND *conn TSRMLS_DC) { always call the parent method. The plugins should always cooperate with mysqlnd itself. - - Issues: an example of chaining and - cooperation - - + + Issues: an example of chaining and cooperation @@ -1072,7 +1067,7 @@ static MY_CONN_PROPERTIES** get_conn_properties(const MYSQLND *conn TSRMLS_DC) { - +
In this scenario, a cache (ext/mysqlnd_cache) and a monitor (ext/mysqlnd_monitor) plugin are loaded. diff --git a/reference/mysqlnd/stats.xml b/reference/mysqlnd/stats.xml index 774f241984..f57df44167 100644 --- a/reference/mysqlnd/stats.xml +++ b/reference/mysqlnd/stats.xml @@ -143,10 +143,8 @@ mysqli_get_connection_stats and mysqli_get_cache_stats functions. - - Network - - + + Returned mysqlnd statistics: Network @@ -416,11 +414,12 @@ $res->close(); - +
Result Set - + + Returned mysqlnd statistics: Result Set @@ -891,11 +890,9 @@ $res->close(); - - - Connection - - +
+ + Returned mysqlnd statistics: Connection @@ -1039,11 +1036,9 @@ $link = new mysqli(...); $link->connect(...) - - - COM_* Commands - - +
+ + Returned mysqlnd statistics: COM_* Command @@ -1127,11 +1122,12 @@ $link = new mysqli(...); $link->connect(...) - +
Miscellaneous - + + Returned mysqlnd statistics: Miscellaneous @@ -1236,7 +1232,7 @@ $link = new mysqli(...); $link->connect(...) - +