php-doc-en/reference/dba/functions/dba-key-split.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.dba-key-split" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dba_key_split</refname>
  <refpurpose>
   Splits a key in string representation into array representation
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>dba_key_split</methodname>
   <methodparam><type>mixed</type><parameter>key</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>dba_key_split</function> splits a key (string representation)
   into an array representation.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       The key in string representation.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array of the form <literal>array(0 =&gt; group, 1 =&gt; 
   value_name)</literal>. This function will return &false; if 
   <parameter>key</parameter> is &null; or &false;.
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>dba_firstkey</function></member>
    <member><function>dba_nextkey</function></member>
    <member><function>dba_fetch</function></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
-->