PHP | Función str_pad()

La función str_pad() es una función integrada en PHP y se usa para rellenar una string a una longitud determinada. Podemos rellenar la string de entrada con cualquier otra string hasta una longitud específica. Si no pasamos la otra string a la función str_pad(), la string de entrada se rellenará con espacios.

Sintaxis:

string str_pad($string, $length, $pad_string, $pad_type)

Parámetros : esta función acepta cuatro parámetros, como se muestra en la sintaxis anterior, de los cuales los dos primeros son obligatorios y los dos restantes son opcionales. Todos estos parámetros se describen a continuación:

• $string: este parámetro es obligatorio. Especifica la string de entrada que se necesita rellenar.
• $longitud: este parámetro también es obligatorio. Especifica la longitud de la nueva string que se generará después de rellenar la string de entrada $string . Si esta longitud es menor o igual a la longitud de la string de entrada, no se realizará ningún relleno.
• $pad_string: este parámetro es opcional y su valor predeterminado es un espacio en blanco ». Especifica la string que se utilizará para el relleno.
• $pad_type: este parámetro también es opcional. Especifica qué lado de la cuerda debe rellenarse, es decir, izquierdo, derecho o ambos. De forma predeterminada, su valor se establece en STR_PAD_RIGHT. Si queremos rellenar el lado izquierdo de la string de entrada, debemos establecer este parámetro en STR_PAD_LEFT y si queremos rellenar ambos lados, este parámetro debe establecerse en STR_PAD_BOTH.

Valor devuelto : este parámetro devuelve una nueva string obtenida después de rellenar la string de entrada $string .

Ejemplos:

Input : $string = "Hello World", $length = 20, 
        $pad_string = "."
Output : Hello World........

Input : $string = "Geeks for geeks", $length = 18,
        $pad_string = ")"
Output : Geeks for geeks)))

Los siguientes programas ilustran la función str_pad() en PHP:

Programa 1 : En este programa, rellenaremos ambos lados de la string de entrada configurando el último parámetro en STR_PAD_BOTH . Si la longitud del relleno no es un número par, el lado derecho recibe el relleno extra.

<?php
   $str = "Geeks for geeks";
   echo str_pad($str, 21, ":-)", STR_PAD_BOTH); 
?>

Producción:

:-)Geeks for geeks:-)

Programa 2 : En este programa, rellenaremos el lado izquierdo de la string de entrada configurando el último parámetro en STR_PAD_LEFT .

<?php
   $str = "Geeks for geeks";
   echo str_pad($str, 25, "Contribute", STR_PAD_LEFT); 
?>

Producción:

ContributeGeeks for geeks

Programa 3 : En este programa, rellenaremos el lado derecho de la string de entrada configurando el último parámetro en STR_PAD_RIGHT .

<?php
   $str = "Geeks for geeks";
   echo str_pad($str, 26, " Contribute", STR_PAD_RIGHT); 
?>

Producción:

Geeks for geeks Contribute

Referencia :
http://php.net/manual/en/function.str-pad.php