More than 3 years have passed since last update.

【PHP8.0】StartsWith/EndsWithがPHP本体に実装される

Posted at 2020-05-03

先日PHP8でstr_containsが導入されることが決まったばかりですが、さらにもっと直接的な『〇〇で始まる』『〇〇で終わる』関数までも導入されることになりました。

Add str_starts_with() and str_ends_with() functionsというRFCが投票中です。
2020/05/04時点では賛成50反対4で、ほぼ導入確定です。

PHP RFC: Add str_starts_with() and str_ends_with() functions

Introduction

・str_starts_withは、文字列が指定の文字列で始まるか否かをチェックし、結果をbool値で返します。
・str_ends_withは、文字列が指定の文字列で終わるか否かをチェックし、結果をbool値で返します。

これらの機能は既存の文字列関数、たとえばsubstrやstrpos/strrpos、そしてstrncmpにsubstr_compare、あまつさえstrlenなどを駆使して実装されてきました。
これらユーザランドの実装には、様々な問題点があります。

str_starts_withとstr_ends_withの需要は高く、Symfony、Laravel、Yii、FuelPHP、そしてPhalconと、あらゆるフレームワークによってサポートされています。

文字列の始めと終わりをチェックすることは非常に一般的なタスクであり、簡単に行えるべきです。
多くのフレームワークがこのタスクを実装しているということは、このタスクを実行することが簡単ではないことを意味しています。
JavaScript/Java/Haskell/Matlabといった多くの高水準言語が標準でこの機能を実装している理由でもあります。
文字列の開始と終了をチェックすることは、これだけのためにフレームワークを導入したり、ユーザランドで最適ではない(どころかバグが入るかもしれない)実装を行ったりする必要のあるべき作業ではありません。

Downsides of Common Userland Approaches

この機能のアドホックな実装は、専用関数に比べると直感的ではありません。
PHPのニュービーや、他言語と同時開発する開発者にとっては特にそうです。
また、特に===を含む場合、実装を簡単に間違えます。
さらに多くのユーザランド実装はパフォーマンス上の問題があります。

注意：以下の実装には、E_WARNINGを防ぐために$needle === "" || やstrlen($needle) <= strlen($haystack) && のようなガードを入れましょう。

str_starts_with

substr($haystack, 0, strlen($needle)) === $needle

$haystackの無駄なコピーが発生するため、メモリ効率が良くありません。

strpos($haystack, $needle) === 0

$needleが見つからなかった場合に$haystackを最後まで調べてしまうため、CPU効率が悪くなります。

strncmp($haystack, $needle, strlen($needle)) === 0 // generic
strncmp($subject, "prefix", 6) === 0 // ad hoc

これは効率的ですが、$needleの文字数を別に渡す必要があり冗長です。

str_ends_with

substr($haystack, -strlen($needle)) === $needle

str_starts_with同様、メモリ効率がよくありません。

strpos(strrev($haystack), strrev($needle)) === 0

str_starts_with同様CPU効率が悪いだけでなく、文字列反転処理まで入るので、さらに非効率です。

strrpos($haystack, $needle) === strlen($haystack) - strlen($needle)

冗長であり、CPURL効率が悪くなることがあります。

substr_compare($haystack, $needle, -strlen($needle)) === 0 // generic
substr_compare($subject, "suffix", -6) === 0 // ad hoc

効率的ですが、冗長です。

Proposal

2つの関数、str_starts_with()とstr_ends_with()を導入します。

str_starts_with ( string $haystack , string $needle ) : bool
str_ends_with ( string $haystack , string $needle ) : bool

str_starts_with()は、$haystackが$needleで始まるかどうかを調べます。
strlen($needle) > strlen($haystack)であれば即座にfalseを返し、そうでなければ両文字列を比較し、先頭一致すればtrueを、一致しなければfalseを返します。

str_ends_with()も同じですが、後方一致です。

以下に例を示します。

$str = "beginningMiddleEnd";
if (str_starts_with($str, "beg")) echo "printed\n"; // true
if (str_starts_with($str, "Beg")) echo "not printed\n"; // false
if (str_ends_with($str, "End")) echo "printed\n"; // true
if (str_ends_with($str, "end")) echo "not printed\n"; // false
 
// 空文字
if (str_starts_with("a", "")) echo "printed\n"; // true
if (str_starts_with("", "")) echo "printed\n"; // true
if (str_starts_with("", "a")) echo "not printed\n"; // false
if (str_ends_with("a", "")) echo "printed\n"; // true
if (str_ends_with("", "")) echo "printed\n"; // true
if (str_ends_with("", "a")) echo "not printed\n"; // false