<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.implode">
 <refnamediv>
  <refname>implode</refname>
  <refpurpose>Join array elements with a string</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>implode</methodname>
   <methodparam><type>string</type><parameter>glue</parameter></methodparam>
   <methodparam><type>array</type><parameter>pieces</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <type>string</type><methodname>implode</methodname>
   <methodparam><type>array</type><parameter>pieces</parameter></methodparam>
  </methodsynopsis>
  <para>
   Join array elements with a <parameter>glue</parameter> string.
  </para>
  <note>
   <para>
    <function>implode</function> can, for historical reasons, accept
    its parameters in either order. For consistency with
    <function>explode</function>, however, it may be less confusing
    to use the documented order of arguments.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>glue</parameter></term>
     <listitem>
      <para>
       Defaults to an empty string. This is not the preferred usage of
       <function>implode</function> as <parameter>glue</parameter> would be
       the second parameter and thus, the bad prototype would be used.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pieces</parameter></term>
     <listitem>
      <para>
       The array of strings to implode.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a string containing a string representation of all the array
   elements in the same order, with the glue string between each element.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>4.3.0</entry>
       <entry>
        The <parameter>glue</parameter> parameter became optional.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>implode</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

$array = array('lastname', 'email', 'phone');
$comma_separated = implode(",", $array);

echo $comma_separated; // lastname,email,phone

// Empty string when using an empty array:
var_dump(implode('hello', array())); // string(0) ""

?>
]]>
    </programlisting>
   </example>   
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.bin-safe;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>explode</function></member>
    <member><function>preg_split</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
-->