<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Joins all values together as a string</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ds-vector.isempty.html">Ds\Vector::isEmpty</a></div> <div class="next" style="text-align: right; float: right;"><a href="ds-vector.jsonserialize.html">Ds\Vector::jsonSerialize</a></div> <div class="up"><a href="class.ds-vector.html">Vector</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="ds-vector.join" class="refentry"> <div class="refnamediv"> <h1 class="refname">Ds\Vector::join</h1> <p class="verinfo">(PECL ds >= 1.0.0)</p><p class="refpurpose"><span class="refname">Ds\Vector::join</span> — <span class="dc-title">Joins all values together as a string</span></p> </div> <div class="refsect1 description" id="refsect1-ds-vector.join-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>Ds\Vector::join</strong></span> ([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$glue</code></span> ] )</div> <p class="para rdfs-comment"> Joins all values together as a string using an optional separator between each value. </p> </div> <div class="refsect1 parameters" id="refsect1-ds-vector.join-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">glue</code></dt> <dd> <p class="para"> An optional string to separate each value. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-ds-vector.join-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> All values of the vector joined together as a string. </p> </div> <div class="refsect1 examples" id="refsect1-ds-vector.join-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-5184"> <p><strong>Example #1 <span class="function"><strong>Ds\Vector::join()</strong></span> example using a separator string</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$vector </span><span style="color: #007700">= new \</span><span style="color: #0000BB">Ds</span><span style="color: #007700">\</span><span style="color: #0000BB">Vector</span><span style="color: #007700">([</span><span style="color: #DD0000">"a"</span><span style="color: #007700">, </span><span style="color: #DD0000">"b"</span><span style="color: #007700">, </span><span style="color: #DD0000">"c"</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">]);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$vector</span><span style="color: #007700">-></span><span style="color: #0000BB">join</span><span style="color: #007700">(</span><span style="color: #DD0000">"|"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> string(11) "a|b|c|1|2|3" </pre></div> </div> </div> <div class="example" id="example-5185"> <p><strong>Example #2 <span class="function"><strong>Ds\Vector::join()</strong></span> example without a separator string</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$vector </span><span style="color: #007700">= new \</span><span style="color: #0000BB">Ds</span><span style="color: #007700">\</span><span style="color: #0000BB">Vector</span><span style="color: #007700">([</span><span style="color: #DD0000">"a"</span><span style="color: #007700">, </span><span style="color: #DD0000">"b"</span><span style="color: #007700">, </span><span style="color: #DD0000">"c"</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">]);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$vector</span><span style="color: #007700">-></span><span style="color: #0000BB">join</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> string(11) "abc123" </pre></div> </div> </div> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ds-vector.isempty.html">Ds\Vector::isEmpty</a></div> <div class="next" style="text-align: right; float: right;"><a href="ds-vector.jsonserialize.html">Ds\Vector::jsonSerialize</a></div> <div class="up"><a href="class.ds-vector.html">Vector</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>