الدالة str_pad() في PHP
(PHP 4 >= 4.0.1, PHP 5, PHP 7)
تحشو الدالة str_pad() سلسلة نصية بطولٍ معين باستعمال سلسلة نصية أخرى.
الوصف
string str_pad ( string $input , int $pad_length [, string $pad_string = " " [, int $pad_type = STR_PAD_RIGHT ]] )
تحشو الدالة str_pad() قيمة المعامل input وتضيفها على اليسار أو اليمين أو على كلي الجانبين حتى تصل إلى الطول المحدد. إذا لم تُوَفَّر قيمة الوسيط الاختياري pad_string، فستحشى السلسلة النصية input بمسافات، وإلا فإنها ستحشى بأحرف من pad_string حتى نهايتها.
المعاملات
input
السلسلة النصية المدخلة.
pad_length
إذا كانت قيمة المعامل pad_length سالبةً أو أقل من أو تساوي طول سلسلة الإدخال، فلن يحدث أي حشو، وستعاد قيمة المعامل input.
pad_string
السلسلة النصية التي ستُستعمَل لحشو السلسلة input.
لاحظ أنَّه قد تُقتَطع قيمة المعامل pad_string إذا كان العدد المطلوب من أحرف الحشو لا يمكن تقسيمه بالتساوي على طول المعامل pad_string.
pad_type
يمكن للوسيط الاختياري pad_type أن يكون STR_PAD_RIGHT أو STR_PAD_LEFT أو STR_PAD_BOTH. إذا لم تحدد قيمة الوسيط pad_type فسيفترض أن تكون STR_PAD_RIGHT.
القيم المعادة
تعيد الدالة str_pad() سلسلةً نصيةً بعد حشوها.
أمثلة
المثال 1: مثال على الدالة str_pad()
<?php
$input = "Alien";
echo str_pad($input, 10); // ينتج "Alien "
echo str_pad($input, 10, "-=", STR_PAD_LEFT); // ينتج "-=-=-Alien"
echo str_pad($input, 10, "_", STR_PAD_BOTH); // ينتج "__Alien___"
echo str_pad($input, 6, "___"); // ينتج "Alien_"
echo str_pad($input, 3, "*"); // ينتج "Alien"
?>