PHP | función array_pad()

array_pad() es una función integrada en PHP y se usa para agregar un valor fijo a una array. Esta función inserta un elemento especificado un número de veces en una array, ya sea al frente o al reverso.

Sintaxis:

array array_pad($input_array, $input_size, $values)

Parámetros: Esta función acepta tres parámetros, todos ellos de obligatorio suministro.

1. $input_array (obligatorio): Hace referencia a la array en la que se realizará la operación o en la que se deben agregar los elementos.
2. $total_size (obligatorio): se refiere al tamaño total de la nueva array que se devolverá.
   • Si el valor es positivo, los elementos se agregan al final de la array.
   • Si el valor es negativo, los elementos se agregan al principio de la array.
3. $valores (obligatorio): Hace referencia al valor con el que se realizará el relleno. El relleno tiene lugar solo cuando $total_size es mayor que el tamaño de input_array.

Valor devuelto: la función devuelve una copia de la array rellenada al tamaño de $total_size. Si el valor absoluto de $total_size es menor o igual que la longitud de la array, no se produce ningún relleno. Es posible agregar, como máximo, 1048576 elementos a la vez.

Ejemplos:

Input : array = ("one", "two", "three", "four", "five")
        $total_size  = 7 , $value = "six"
Output : 
Array
(
    [0] => one
    [1] => two
    [2] => three
    [3] => four
    [4] => five
    [5] => six
    [6] => six
)

Input : array = ("one", "two", "three", "four", "five")
        $total_size  = -7 , $value = "six"
Output : 
Array
(
    [0] => six
    [1] => six
    [2] => one
    [3] => two
    [4] => three
    [5] => four
    [6] => five
)

Los siguientes programas explican el funcionamiento de la función array_pad():

1. Elementos de relleno al final de la array cuando $total_size es positivo:

   <?php // PHP function to illustrate the use of array_pad() function Padding($array, $string) {     $result = array_pad($array, 7, $string);     return($result); }    $array = array("one", "two", "three", "four", "five"); $string = "six"; print_r(Padding($array, $string)); ?>

   Producción:

   Array
   (
       [0] => one
       [1] => two
       [2] => three
       [3] => four
       [4] => five
       [5] => six
       [6] => six
   )
   

2. Elementos de relleno al comienzo de la array cuando $total_size es negativo:

   <?php // PHP function to illustrate the use of array_pad() function Padding($array, $string) {     $result = array_pad($array, -7, $string);     return($result); }    $array = array("one", "two", "three", "four", "five"); $string = "six"; print_r(Padding($array, $string)); ?>

   Producción:

   Array
   (
       [0] => six
       [1] => six
       [2] => one
       [3] => two
       [4] => three
       [5] => four
       [6] => five
   )