svn: /phpdoc/en/trunk/reference/mysqlnd_uh/ functions/mysqlnd-uh-set-connection-proxy.xml quickstart.xml
| From: | Jakub Vrana | Date: | Fri, 13 Jan 2012 02:36:10 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/mysqlnd_uh/ functions/mysqlnd-uh-set-connection-proxy.xml quickstart.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-9445@lists.php.net to get a copy of this message | ||
vrana Fri, 13 Jan 2012 02:36:10 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=322168
Log:
Use <classname>
Changed paths:
U phpdoc/en/trunk/reference/mysqlnd_uh/functions/mysqlnd-uh-set-connection-proxy.xml
U phpdoc/en/trunk/reference/mysqlnd_uh/quickstart.xml
Modified: phpdoc/en/trunk/reference/mysqlnd_uh/functions/mysqlnd-uh-set-connection-proxy.xml
===================================================================
--- phpdoc/en/trunk/reference/mysqlnd_uh/functions/mysqlnd-uh-set-connection-proxy.xml 2012-01-13
02:31:51 UTC (rev 322167)
+++ phpdoc/en/trunk/reference/mysqlnd_uh/functions/mysqlnd-uh-set-connection-proxy.xml 2012-01-13
02:36:10 UTC (rev 322168)
@@ -43,7 +43,7 @@
<term><parameter>connection_proxy</parameter></term>
<listitem>
<para>
- A proxy object of type <literal>MysqlndUhConnection</literal>.
+ A proxy object of type <classname>MysqlndUhConnection</classname>.
</para>
</listitem>
</varlistentry>
Modified: phpdoc/en/trunk/reference/mysqlnd_uh/quickstart.xml
===================================================================
--- phpdoc/en/trunk/reference/mysqlnd_uh/quickstart.xml 2012-01-13 02:31:51 UTC (rev 322167)
+++ phpdoc/en/trunk/reference/mysqlnd_uh/quickstart.xml 2012-01-13 02:36:10 UTC (rev 322168)
@@ -21,11 +21,11 @@
On the C level, the <literal>mysqlnd</literal> library is structured in modules
or classes. The extension hooks almost all methods of the <literal>mysqlnd</literal>
internal <literal>connection</literal> class and exposes them through the
- user space class <literal>MysqlndUhConnection</literal>. Some few methods of
+ user space class <classname>MysqlndUhConnection</classname>. Some few methods of
the mysqlnd internal <literal>statement</literal> class are made available
- to the PHP user with the class <literal>MysqlndUhPreparedStatement</literal>.
- By subclassing the classes <literal>MysqlndUhConnection</literal> and
- <literal>MysqlndUhPreparedStatement</literal> users get access to
+ to the PHP user with the class <classname>MysqlndUhPreparedStatement</classname>.
+ By subclassing the classes <classname>MysqlndUhConnection</classname> and
+ <classname>MysqlndUhPreparedStatement</classname> users get access to
<literal>mysqlnd</literal> internal function calls.
</para>
<note>
@@ -36,8 +36,8 @@
keep in mind that you are accessing C library functions through
PHP which are expected to take certain actions, which you may not be able to
emulate in user space. Therefore, it is strongly recommended to always call
- the parent method implementation when subclassing
<literal>MysqlndUhConnection</literal>
- or <literal>MysqlndUhPreparedStatement</literal>. To prevent the worst
+ the parent method implementation when subclassing
<classname>MysqlndUhConnection</classname>
+ or <classname>MysqlndUhPreparedStatement</classname>. To prevent the worst
case, the extension performs some sanity checks. Please, see also
<link linkend="mysqlnd-uh.configuration">Mysqlnd_uh
&ConfigureOptions;</link>.
</para>
@@ -83,8 +83,8 @@
</note>
</para>
<para>
- Two classes are provided by the extension: <literal>MysqlndUhConnection</literal>
- and <literal>MysqlndUhPreparedStatement</literal>. The first one lets
+ Two classes are provided by the extension:
<classname>MysqlndUhConnection</classname>
+ and <classname>MysqlndUhPreparedStatement</classname>. The first one lets
you access almost all methods of the <literal>mysqlnd</literal>
internal <literal>connection</literal> class. The latter exposes some, selected
methods of the <literal>mysqlnd</literal> internal
<literal>statement</literal> class.
@@ -127,8 +127,8 @@
<para>
The build-in classes behave like a transparent proxy. It is possible for
you to replace the proxy with your own. This is done by subclassing
- <literal>MysqlndUhConnection</literal> or
- <literal>MysqlndUhPreparedStatement</literal> to extend the functionality
+ <classname>MysqlndUhConnection</classname> or
+ <classname>MysqlndUhPreparedStatement</classname> to extend the functionality
of the proxy, followed by registering a new proxy object.
Proxy objects are installed by
<function>mysqlnd_uh_set_connection_proxy</function>
@@ -178,8 +178,8 @@
<section xml:id="mysqlnd-uh.quickstart.proxy-installation">
<title>Installing a proxy</title>
<para>
- The extension provides two built-in classes: <literal>MysqlndUhConnection</literal>
- and <literal>MysqlndUhPreparedStatement</literal>. The classes are used
+ The extension provides two built-in classes:
<classname>MysqlndUhConnection</classname>
+ and <classname>MysqlndUhPreparedStatement</classname>. The classes are used
for hooking <literal>mysqlnd</literal> library calls. Their methods correspond
to <literal>mysqlnd</literal> internal functions. By default they act like
a transparent proxy and do nothing but call their <literal>mysqlnd</literal>
counterparts.
@@ -191,10 +191,10 @@
Copy the patterns shown in the quickstart instead.
</para>
<para>
- Connections proxies are objects of the type <literal>MysqlndUhConnection</literal>.
+ Connections proxies are objects of the type
<classname>MysqlndUhConnection</classname>.
Connection proxy objects are installed by
<function>mysqlnd_uh_set_connection_proxy</function>.
- If you install the built-in class <literal>MysqlndUhConnection</literal>
+ If you install the built-in class <classname>MysqlndUhConnection</classname>
as a proxy, nothing happens. It behaves like a transparent proxy.
</para>
<para>
@@ -243,14 +243,14 @@
</para>
<para>
To monitor <literal>mysqlnd</literal> you have to write your own
- proxy object subclassing <literal>MysqlndUhConnection</literal>.
+ proxy object subclassing <classname>MysqlndUhConnection</classname>.
Please, see the function reference for a the list of methods that
can be subclassed. Alternatively, you can use reflection to inspect
- the built-in <literal>MysqlndUhConnection</literal>.
+ the built-in <classname>MysqlndUhConnection</classname>.
</para>
<para>
Create a new class <literal>proxy</literal>. Derive it from the
- built-in class <literal>MysqlndUhConnection</literal>.
+ built-in class <classname>MysqlndUhConnection</classname>.
Replace the
<function>MysqlndUhConnection::connect</function>.
method. Print out the host parameter value passed to the method.
@@ -300,7 +300,7 @@
</para>
<para>
The use of prepared statement proxies follows the same pattern: create a
- proxy object of the type <literal>MysqlndUhPreparedStatement</literal>
+ proxy object of the type <classname>MysqlndUhPreparedStatement</classname>
and install the proxy using
<function>mysqlnd_uh_set_statement_proxy</function>.
</para>
@@ -403,7 +403,7 @@
All native prepared statements are prepared with the <literal>prepare</literal>
method of <literal>mysqlnd</literal> exported through
<function>MysqlndUhPreparedStatement::prepare</function>. Subclass
- <literal>MysqlndUhPreparedStatement</literal> and overwrite
<literal>prepare</literal>
+ <classname>MysqlndUhPreparedStatement</classname> and overwrite
<literal>prepare</literal>
for native prepared statement monitoring.
</para>
</section>