phpのソース中に意図不明点

Question

laravel5 の勉強がてらソースを見ていて、何をしたいのかよくわからないところが
ありました。

vendor/laravel/framework/src/Illuminate/Support/Str.php

98     /**
99      * Cap a string with a single instance of a given value.
100      *
101      * @param  string  $value
102      * @param  string  $cap
103      * @return string
104      */
105     public static function finish($value, $cap)
106     {
107         $quoted = preg_quote($cap, '/');
108
109         return preg_replace('/(?:'.$quoted.')+$/u', '', $value).$cap;
110     }

preg_quote($cap, '/') は、'/' および正規表現の特殊文字をすべてエスケープする。

http://php.net/manual/ja/function.preg-quote.php

正規表現の中の '?:' は、「値のキャプチャを行わない」
＝パターンを見つけてもマッチさせない（無視する）ということ？
http://php.net/manual/ja/regexp.reference.subpatterns.php

/u は「UTF-8 として処理する」
http://php.net/manual/ja/reference.pcre.pattern.modifiers.php
ということのようです。

この finish() メソッドを使っている箇所を vendor/ 配下で grep してみましたが、
このラッパーであるヘルパー関数 str_finish() 以外は、残念ながら見つけられませんでした。

$ php artisan tinker
Psy Shell v0.7.2 (PHP 7.0.11 — cli) by Justin Hileman
>>> use Illuminate\Support\Traits\Macroable;
=> null
>>> $s = new Str;
=> Illuminate\Support\Str {#675}
>>> $s->finish("abc123[123][123]\[123\]/123/xyz", "[123]");
=> "abc123[123][123]\[123\]/123/xyz[123]"
>>> $s->finish("abc123[123][123]\[123\]/123/xyz", "/123/");
=> "abc123[123][123]\[123\]/123/xyz/123/"

preg_replace() の replacement が '' なので、セキュリティがらみ（？）で
何らかのパターンを排除（削除）しようとしているのではないかとも思うのですが、
どういうケースでこれが役立つのか、おわかりの方がおられましたら教えてください。

Answer 1

公式サイトに出ている例から推測される用途として、「パスの最後をスラッシュ終わりに統一する」という用法が考えられます。

/path/to/foo/barと/path/to/foo/bar/のどちらが来ても正しく処理できるようにこのような変換を入れることは、Laravelに限らずちょくちょくあります。

Comments

[hotta]

ユースケースとしては理解できました。
ノーマライズの一種ということですね。

いったんこちらをベストアンサーとさせていただきますが、
正規表現の意図（実際のコードの意味）についても、
引き続きコメントをお待ちしております。

[maisumakun]

preg_quoteを入れないと、（この例でのスラッシュもそうですが）正規表現のメタ文字と認識されて、正常に動作しなくなります。

[hotta]

preg_quote() の公式マニュアルに載っている例から preg_quote() を
外して実行したら、エラー（Compilation failed）になることを確認しました。
ありがとうございました。