php-doc-en/reference/mysqlnd_qc/functions/mysqlnd-qc-set-user-handlers.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.mysqlnd_qc_set_user_handlers" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mysqlnd_qc_set_user_handlers</refname>
  <refpurpose>Sets the callback functions for a user-defined procedural storage handler</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type>
   <methodname>mysqlnd_qc_set_user_handlers</methodname>
   <methodparam>
    <type>string</type>
    <parameter>get_hash</parameter>
   </methodparam>
   <methodparam>
    <type>string</type>
    <parameter>find_query_in_cache</parameter>
   </methodparam>
   <methodparam>
    <type>string</type>
    <parameter>return_to_cache</parameter>
   </methodparam>
   <methodparam>
    <type>string</type>
    <parameter>add_query_to_cache_if_not_exists</parameter>
   </methodparam>
   <methodparam>
    <type>string</type>
    <parameter>query_is_select</parameter>
   </methodparam>
   <methodparam>
    <type>string</type>
    <parameter>update_query_run_time_stats</parameter>
   </methodparam>
   <methodparam>
    <type>string</type>
    <parameter>get_stats</parameter>
   </methodparam>
   <methodparam>
    <type>string</type>
    <parameter>clear_cache</parameter>
   </methodparam>
  </methodsynopsis>
  <para>
   Sets the callback functions for a user-defined procedural storage handler.
  </para>



 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term>
     <parameter>get_hash</parameter>
    </term>
    <listitem>
     <para>
      Name of the user function implementing the storage handler
      <literal>get_hash</literal> functionality.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>find_query_in_cache</parameter>
    </term>
    <listitem>
     <para>
      Name of the user function implementing the storage handler
      <literal>find_in_cache</literal> functionality.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>return_to_cache</parameter>
    </term>
    <listitem>
     <para>
      Name of the user function implementing the storage handler
      <literal>return_to_cache</literal> functionality.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>add_query_to_cache_if_not_exists</parameter>
    </term>
    <listitem>
     <para>
      Name of the user function implementing the storage handler
      <literal>add_query_to_cache_if_not_exists</literal> functionality.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>query_is_select</parameter>
    </term>
    <listitem>
     <para>
      Name of the user function implementing the storage handler
      <literal>query_is_select</literal> functionality.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>update_query_run_time_stats</parameter>
    </term>
    <listitem>
     <para>
      Name of the user function implementing the storage handler
      <literal>update_query_run_time_stats</literal> functionality.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>get_stats</parameter>
    </term>
    <listitem>
     <para>
      Name of the user function implementing the storage handler
      <literal>get_stats</literal> functionality.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>clear_cache</parameter>
    </term>
    <listitem>
     <para>
      Name of the user function implementing the storage handler
      <literal>clear_cache</literal> functionality.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns TRUE on success or FALSE on FAILURE.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member>
     <link linkend="mysqlnd-qc.set_user_handlers">Procedural user-defined storage handler example</link>
    </member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->