Метод padStart

Метод padStart класса UnicodeString дополняет текущую строку заданными символами в начале до указанной длины. Первым параметром передаётся целевая длина строки. Вторым параметром передаётся строка-заполнитель, по умолчанию это пробел. Если исходная строка уже достигла нужной длины, метод возвращает её без изменений.

Синтаксис

public function padStart(int $length, string $padStr = ' '): static

Пример

Давайте дополним строку 'abcde' до длины 10 символами '*':

<?php
	use SymfonyComponentStringUnicodeString;

	$str = new UnicodeString('abcde');
	$res = $str->padStart(10, '*');

	echo $res;
?>

Результат выполнения кода:

"*****abcde"

Пример

Если второй параметр не указан, строка дополняется пробелами:

<?php
	use SymfonyComponentStringUnicodeString;

	$str = new UnicodeString('hello');
	$res = $str->padStart(8);

	echo $res;
?>

Результат выполнения кода:

" hello"

Пример

Если исходная строка длиннее указанной длины, она возвращается без изменений:

<?php
	use SymfonyComponentStringUnicodeString;

	$str = new UnicodeString('article');
	$res = $str->padStart(3, '*');

	echo $res;
?>

Результат выполнения кода:

"article"

Пример

Метод корректно работает с многобайтовыми символами, например с кириллицей:

<?php
	use SymfonyComponentStringUnicodeString;

	$str = new UnicodeString('abcde');
	$res = $str->padStart(9, 'тест');

	echo $res;
?>

Результат выполнения кода:

"тестabcde"

Смотрите также

класс UnicodeString,
который представляет Unicode-строку
метод padEnd,
который дополняет строку в конце
метод repeat,
который повторяет строку заданное число раз
метод length,
который возвращает длину строки