【PHP】文字列を指定した回数分くりかえすstr_repeat関数を解説します

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、11年目エンジニアです。

この記事では、 PHPで文字列を指定した回数分くりかえすstr_repeat関数について

str_repeat関数とは
str_repeat関数を使うときの注意点
str_repeat関数を使ったサンプルプログラム

と、丁寧に解説していきます。

前提条件：実行環境について
str_repeat関数とは
str_repeat関数を使うときの注意点
str_repeat関数を解説するプログラムの概要
PHPサンプルプログラム
実行結果
まとめ：str_repeat関数を使ってみよう！

前提条件：実行環境について

実行環境は以下の通りです。

OS	Windows10
PHPのバージョン	8.0.3
XAMPPのバージョン	8.0.3

PHPを動かすためにXAMPPを使っています。
XAMPPのインストールは、下の記事をご参考ください。

【XAMPP】インストールするやり方を解説します

str_repeat関数とは

str_repeat関数とは、引数に指定した文字列を指定した回数分くりかえした文字列を返す関数です。

使い方サンプルは以下です。

$result = str_repeat('ab', 2);

1	$result = str_repeat('ab', 2);

上記のサンプルだとresultには「abab」が返されます。

str_repeat関数を使うときの注意点

str_repeat関数を使うときの注意点として、第二引数の繰り返す回数は0以上を指定する必要があります。
たとえば

$result = str_repeat('ab', -3);

1	$result = str_repeat('ab', -3);

のように、0未満を指定していると
PHPでstr_repeat関数のエラーメッセージ

Fatal error: Uncaught ValueError: str_repeat(): Argument #2 ($times) must be greater than or equal to 0 in C:\xampp\htdocs\str_repeat_sample.php:10 Stack trace: #0

1	Fatal error: Uncaught ValueError: str_repeat(): Argument #2 ($times) must be greater than or equal to 0 in C:\xampp\htdocs\str_repeat_sample.php:10 Stack trace: #0

とエラーとなります。
ちなみに、0を指定した場合は空文字が返されます。

では、次の章で実際に使ってみます。

str_repeat関数を解説するプログラムの概要

str_repeat関数を解説するプログラムでは

第二引数に0を指定
第二引数に整数を指定
第二引数に小数を指定

の3パターンでstr_repeat関数を実行し、結果を表示させます。

phpプログラムは

C:\xampp\htdocs

配下に、【str_repeat_sample.php】というファイル名で格納しています。

PHPサンプルプログラム

<?php
	print('■パターンその1：第二引数に0を指定<br >');
	$pattern1 = str_repeat('abc', 0);
	print($pattern1.'<br ><br >');

	print('■パターンその2：第二引数に整数を指定<br >');
	$pattern2 = str_repeat('abc', 3);
	print($pattern2.'<br ><br >');

	print('■パターンその3：第二引数に小数を指定<br >');
	$pattern3 = str_repeat('abc', 6.8);
	print($pattern3.'<br ><br >');
?>

<?php

print('■パターンその1：第二引数に0を指定 ');

$pattern1 = str_repeat('abc', 0);

print($pattern1.' ');

print('■パターンその2：第二引数に整数を指定 ');

$pattern2 = str_repeat('abc', 3);

print($pattern2.' ');

print('■パターンその3：第二引数に小数を指定 ');

$pattern3 = str_repeat('abc', 6.8);

print($pattern3.' ');

実行結果

XAMPPを起動して、【http://localhost/str_repeat_sample.php】のURLにアクセスします。

XAMPPでPHPの動かし方については、こちらの記事をご参考ください。

XAMPPでPHPの動かし方を解説します

PHPのstr_repeat関数の実行確認

指定した数分、文字列がくりかえされていることが確認できました。
また、小数を指定した場合、小数点以下は切り捨てられていることが確認できました。

まとめ：str_repeat関数を使ってみよう！

以上がstr_repeat関数についての解説でした！

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ