Formalized informal tables, which adds titles

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328620 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2012-12-03 07:29:14 +00:00
parent 55a52d42ae
commit e94533ab35
2 changed files with 39 additions and 48 deletions

View file

@ -285,7 +285,8 @@
The following table shows PHP versions and the corresponding
<literal>mysqlnd</literal> version contained within.
</para>
<informaltable>
<table>
<title>The bundled mysqlnd version per PHP release</title>
<tgroup cols="2">
<thead>
<row>
@ -316,7 +317,7 @@
</row>
</tbody>
</tgroup>
</informaltable>
</table>
<para>
Plugin developers can determine the <literal>mysqlnd</literal>
version through accessing <literal>MYSQLND_VERSION</literal>, which
@ -325,7 +326,8 @@
<literal>MYSQLND_VERSION_ID</literal>, which is an integer such as
50007. Developers can calculate the version number as follows:
</para>
<informaltable>
<table>
<title>MYSQLND_VERSION_ID calculation table</title>
<tgroup cols="2">
<thead>
<row>
@ -352,7 +354,7 @@
</row>
</tbody>
</tgroup>
</informaltable>
</table>
<para>
During development, developers should refer to the
<literal>mysqlnd</literal> version number for compatibility and
@ -375,7 +377,8 @@
know a little of how <literal>mysqlnd</literal> itself is organized.
<literal>Mysqlnd</literal> consists of the following modules:
</para>
<informaltable>
<table>
<title>The mysqlnd organization chart, per module</title>
<tgroup cols="2">
<tbody>
<row>
@ -408,7 +411,7 @@
</row>
</tbody>
</tgroup>
</informaltable>
</table>
<para>
<emphasis role="bold">C Object Oriented Paradigm</emphasis>
</para>
@ -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:
</para>
<informaltable>
<table>
<title>Pointer calculations for mysqlnd</title>
<tgroup cols="2">
<tbody>
<row>
@ -582,7 +586,7 @@ MYSQLND_METHOD(my_conn_class, query)(MYSQLND *conn,
</row>
</tbody>
</tgroup>
</informaltable>
</table>
<para>
If you plan to subclass any of the <literal>mysqlnd</literal> 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.
</para>
<para>
<emphasis role="Bold"> When and how to subclass </emphasis>
</para>
<informaltable>
<table>
<title>When and how to subclass</title>
<tgroup cols="4">
<tbody>
<row>
@ -681,7 +683,7 @@ static MY_CONN_PROPERTIES** get_conn_properties(const MYSQLND *conn TSRMLS_DC) {
</row>
</tbody>
</tgroup>
</informaltable>
</table>
<para>
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.
</para>
<para>
Constructors
</para>
<informaltable>
<table>
<title>Constructor status</title>
<tgroup cols="4">
<tbody>
<row>
@ -799,7 +799,7 @@ static MY_CONN_PROPERTIES** get_conn_properties(const MYSQLND *conn TSRMLS_DC) {
</row>
</tbody>
</tgroup>
</informaltable>
</table>
<para>
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.
</para>
<para>
<emphasis role="bold">Destruction</emphasis>
</para>
<informaltable>
<table>
<title>Destruction status</title>
<tgroup cols="3">
<tbody>
<row>
@ -858,7 +856,7 @@ static MY_CONN_PROPERTIES** get_conn_properties(const MYSQLND *conn TSRMLS_DC) {
</row>
</tbody>
</tgroup>
</informaltable>
</table>
<para>
The destructors are the appropriate place to free properties,
<literal>mysqlnd_plugin_get_plugin_<replaceable>&lt;object&gt;</replaceable>_data()</literal>.
@ -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 <literal>mysqlnd</literal> itself.
</para>
<para>
<emphasis role="bold">Issues: an example of chaining and
cooperation</emphasis>
</para>
<informaltable>
<table>
<title>Issues: an example of chaining and cooperation</title>
<tgroup cols="3">
<tbody>
<row>
@ -1072,7 +1067,7 @@ static MY_CONN_PROPERTIES** get_conn_properties(const MYSQLND *conn TSRMLS_DC) {
</row>
</tbody>
</tgroup>
</informaltable>
</table>
<para>
In this scenario, a cache (<literal>ext/mysqlnd_cache</literal>) and
a monitor (<literal>ext/mysqlnd_monitor</literal>) plugin are loaded.

View file

@ -143,10 +143,8 @@
<function>mysqli_get_connection_stats</function> and
<function>mysqli_get_cache_stats</function> functions.
</para>
<para>
<emphasis role="bold">Network</emphasis>
</para>
<informaltable>
<table>
<title>Returned mysqlnd statistics: Network</title>
<tgroup cols="4">
<colspec colwidth="10*"/>
<colspec colwidth="10*"/>
@ -416,11 +414,12 @@ $res->close();
</row>
</tbody>
</tgroup>
</informaltable>
</table>
<para>
<emphasis role="bold">Result Set</emphasis>
</para>
<informaltable>
<table>
<title>Returned mysqlnd statistics: Result Set</title>
<tgroup cols="4">
<colspec colwidth="10*"/>
<colspec colwidth="10*"/>
@ -891,11 +890,9 @@ $res->close();
</row>
</tbody>
</tgroup>
</informaltable>
<para>
<emphasis role="bold">Connection</emphasis>
</para>
<informaltable>
</table>
<table>
<title>Returned mysqlnd statistics: Connection</title>
<tgroup cols="4">
<colspec colwidth="10*"/>
<colspec colwidth="10*"/>
@ -1039,11 +1036,9 @@ $link = new mysqli(...); $link->connect(...)
</row>
</tbody>
</tgroup>
</informaltable>
<para>
<emphasis role="bold">COM_* Commands</emphasis>
</para>
<informaltable>
</table>
<table>
<title>Returned mysqlnd statistics: COM_* Command</title>
<tgroup cols="4">
<colspec colwidth="10*"/>
<colspec colwidth="10*"/>
@ -1127,11 +1122,12 @@ $link = new mysqli(...); $link->connect(...)
</row>
</tbody>
</tgroup>
</informaltable>
</table>
<para>
<emphasis role="bold">Miscellaneous</emphasis>
</para>
<informaltable>
<table>
<title>Returned mysqlnd statistics: Miscellaneous</title>
<tgroup cols="4">
<colspec colwidth="10*"/>
<colspec colwidth="10*"/>
@ -1236,7 +1232,7 @@ $link = new mysqli(...); $link->connect(...)
</row>
</tbody>
</tgroup>
</informaltable>
</table>
</chapter>
<!-- Keep this comment at the end of the file
Local variables: