PHP - Ds Vector::join() Function

---

---

The PHP Ds\Vector::join() function joins all the values together of a vector into a single string. This function does not modify the original vector and returns a new string.

This function accepts an optional parameter as a separator. If the parameter is passed to the function, the joined values will be separated by the given separator. If no separator is specified, the values will be joined without any separator.

Syntax

Following is the syntax of the PHP Ds\Vector::join() function −

public Ds\Vector::join(string $glue = ?): string

Parameters

This function accepts a single parameter named 'glue', which is described below −

• glue − An optional separator that separates the joined values.

Return value

This function returns all values of the vector joined together as a string.

Example 1

If the "glue" (say separator) parameter is omitted, the PHP Ds\Vector::join() function joins all values together without any separator −

<?php 
   $vector = new \Ds\Vector([1, 2, 3, 4, 5]);
   echo "The original vector: \n";   
   print_r($vector);
   echo("The vector elements after join(): ");
   #using join() function   
   print_r($vector->join());
?>

Output

The above program produces the following output −

The original vector:
Ds\Vector Object
(
    [0] => 1
    [1] => 2
    [2] => 3
    [3] => 4
    [4] => 5
)
The vector elements after join(): 12345

Example 2

If we pass the "glue" parameter values as "-", the values will be joined together and separated by a given separator.

Following is another example of the PHP Ds\Vector::join() function. We use this function to join all values together of a vector using the specified separator "-" −

<?php 
   $vector = new \Ds\Vector(["Tutorials", "Point", "Tutorix"]);
   echo "The original vector: \n";   
   print_r($vector);
   $glue = "-";
   echo "The separator is: '".$glue."'";
   echo "\nThe Vector elements after join(): ";
   #using join() function   
   print_r($vector->join($glue)); 
?>

Output

After executing the above program, the following output will be displayed −

The original vector:
Ds\Vector Object
(
    [0] => Tutorials
    [1] => Point
    [2] => Tutorix
)
The separator is: '-'
The Vector elements after join(): Tutorials-Point-Tutorix

Example 3

In the example below, we use the join() function to join all values of vector together with and without separator −

<?php 
   $vector = new \Ds\Vector(['a', 'e', 'i', 'o', 'u']);
   echo "The original vector: \n";   
   print_r($vector);
   $glue = "|";
   echo "\nThe Vector elements without separator: ";
   print_r($vector->join());
   echo "\nThe separator is: '".$glue."'";
   echo "\nThe Vector elements with separator: ";
   print_r($vector->join($glue)); 
?>

Output

Once the above program is executed, it will generate the following output −

The original vector:
Ds\Vector Object
(
    [0] => a
    [1] => e
    [2] => i
    [3] => o
    [4] => u
)

The Vector elements without separator: aeiou
The separator is: '|'
The Vector elements with separator: a|e|i|o|u