PHP - Ds Vector::insert() Function

---

---

The PHP Ds\Vector::insert() function is used to insert the values at a specified index in a vector. The index is the element's position in a vector, where the index 0 represents the first element, 1 represents the second element, and so on.

Using this function you can insert multiple values at once, and the function throws an "OutOfRangeException" if the specified index value is not valid.

Syntax

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

public Ds\Vector::insert(int $index, mixed ...$values): void

Parameters

Following are the parameters of this function −

• index − The index at which the value is inserted.
• values − A single or multiple values need to be inserted..

Return value

This function does not return any value.

Example 1

The following is the basic example of the PHP Ds\Vector::insert() function −

<?php 
   $vector = new \Ds\Vector([1, 2, 4, 5]);
   echo "The vector elements are: \n";   
   print_r($vector);
   $index = 2;
   $value = 3;
   echo "The index and given value is: ".$index.", ".$value;  
   echo "\nThe vector after inserting new element: \n";
   #using insert() function
   $vector->insert($index, $value);
   print_r($vector);   
?>

Output

The above program produces the following output −

The vector elements are:
Ds\Vector Object
(
    [0] => 1
    [1] => 2
    [2] => 4
    [3] => 5
)
The index and given value is: 2, 3
The vector after inserting new element:
Ds\Vector Object
(
    [0] => 1
    [1] => 2
    [2] => 3
    [3] => 4
    [4] => 5
)

Example 2

Following is another example of the PHP Ds\Vector::insert() function. We use this function to insert specified element "India" at the given index 0 in this vector (["Tutorials", "Point", "Turorix"]) −

<?php 
   $vector = new \Ds\Vector(["Tutorials", "Point", "Turorix"]);
   echo "The original vector elements are: \n";
   print_r($vector);
   $index = 0;
   $value = "India";
   echo "The index and given value is: ".$index.", ".$value;
   echo "\nThe updated vector is: \n";
   #using insert() function
   $vector->insert($index, $value); 
   print_r($vector);
?>

Output

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

The original vector elements are:
Ds\Vector Object
(
    [0] => Tutorials	
    [1] => Point
    [2] => Turorix
)
The index and given value is: 0, India
The updated vector is:
Ds\Vector Object
(
    [0] => India
    [1] => India
    [2] => Tutorials
    [3] => Point
    [4] => Turorix
)

Example 3

Inserting multiple values at a specified index in a vector at once.

In the example below, we use the insert() function to insert the specified values 'd', 'e', and 'f' at the specified index 0 at once in a vector −

<?php 
   $vector = new \Ds\Vector(['a', 'b', 'c']);
   echo "The original vector elements are: \n";
   print_r($vector);
   $index = 0;
   $v1 = 'd';
   $v2 = 'e';
   $v3 = 'f';
   echo "The index is: ".$index;
   echo "\nThe given values are: ".$v1.", ".$v2.", ".$v3;
   echo "\nThe updated vector is: \n";
   #using insert() function
   $vector->insert($index, $v1, $v2, $v3); 
   print_r($vector);
?>

Output

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

The original vector elements are:
Ds\Vector Object
(
    [0] => a
    [1] => b
    [2] => c
)
The index is: 0
The given values are: d, e, f
The updated vector is:
Ds\Vector Object
(
    [0] => d
    [1] => e
    [2] => f
    [3] => a
    [4] => b
    [5] => c
)

Example 4

If the specified index is invalid, this function will throw an "OutOfRangeException" exception −

<?php 
   $vector = new \Ds\Vector([10, 20, 30]);
   echo "The original vector elements are: \n";
   print_r($vector);
   $index = 10;
   $value = 40;
   echo "The index is: ".$index;
   echo "\nThe given value is: ".$value;
   echo "\nThe updated vector is: \n";
   #using insert() function
   $vector->insert($index, $value); 
   print_r($vector);
?>

Output

The above program throws the following exception −

The original vector elements are:
Ds\Vector Object
(
    [0] => 10
    [1] => 20
    [2] => 30
)
The index is: 10
The given value is: 40
The updated vector is:
PHP Fatal error:  Uncaught OutOfRangeException: 
Index out of range: 10, expected 0 <= x <= 3 in C:\Apache24\htdocs\index.php:11
Stack trace:
#0 C:\Apache24\htdocs\index.php(11): Ds\Vector->insert(10, 40)
#1 {main}
  thrown in C:\Apache24\htdocs\index.php on line 11