【FuelPHP】指定した文字列で始まっているかどうかを判定するStr::starts_withメソッドを解説します

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

この記事では、 FuelPHPで指定した文字列で始まっているかどうかを判定するStr::starts_withメソッドについて

Str::starts_withメソッドとは
Str::starts_withメソッドを使ったサンプルプログラム

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

前提条件：実行環境について
Str::starts_withメソッドとは
Str::starts_withメソッドを解説するプログラムの概要
1. コントローラークラスのサンプルプログラム
2. ビューのサンプルプログラム
実行結果
まとめ：Str::starts_withメソッドを使ってみよう！

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

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

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

この記事ではFuelPHPのプロジェクトは

C:\xampp

に配下に【fuelphp】という名前で配置しています。
FuelPHPのプロジェクトの場所

Windows10の環境でFuelPHPをインストールするやり方は以下の記事をご参考ください。

FuelPHPをWindowsのXAMPP環境にインストールする方法を解説します

Str::starts_withメソッドとは

Str::starts_withメソッドとは、第一引数の文字列が第二引数の文字列で始まっているかを判定してboolを返すメソッドです。
始まっていればtrue、異なればfalseを返します。

Str::starts_withメソッドを使うとき

use Fuel\Core\Str;

1	use Fuel\Core\Str;

の宣言が必要です。

Str::starts_withメソッドの使い方は以下になります。

$result = Str::starts_with('sample', 'SA', true);

1	$result = Str::starts_with('sample', 'SA', true);

指定した引数は以下の意味をします。

第一引数（必須）	チェック対象の文字列
第二引数（必須）	始まっているか確認する文字列
第三引数（任意）	大文字小文字を無視するかどうか true：無視する false：無視しないデフォルトはfalse

第一引数（必須）

チェック対象の文字列

第二引数（必須）

始まっているか確認する文字列

第三引数（任意）

大文字小文字を無視するかどうか

true：無視する
false：無視しない

デフォルトはfalse

先ほどの

$result = Str::starts_with('sample', 'SA', true);

1	$result = Str::starts_with('sample', 'SA', true);

は第三引数にtrueを指定しているので、変数resultにはtrueが返されます。

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

Str::starts_withメソッドを解説するプログラムの概要

Str::starts_withメソッドを解説するプログラムでは

大文字小文字を無視しない場合（第三引数はデフォルト）
大文字小文字を無視する場合（第三引数はtrueを指定）

の2パターンの値をStr::starts_withメソッドを使って判定し、結果を表示させます。

コントローラーは

プロジェクト\fuel\app\classes\controller

配下にあり、ファイル名を【sample.php】とします。

コントローラから値を受け取り表示するビューは

プロジェクト\fuel\app\views\sample

配下にあり、ファイル名を【show.php】とします。

コントローラーからビューに値を渡すやり方は、こちらの記事をご参考ください。

【FuelPHP】コントローラーからビューに値を渡すやり方を解説します

コントローラークラスのサンプルプログラム

<?php

use Fuel\Core\Str;
use Fuel\Core\View;

class Controller_Sample extends Controller
{
	public function action_show()
	{
		$apple = 'apple';
		$start_str = 'APP';
		$apple_result_no_designation = Str::starts_with($apple, $start_str) ? '〇' : '×';
		$apple_result_designation = Str::starts_with($apple, $start_str, true) ? '〇' : '×';

		$result = array(
			'apple' => $apple,
			'start_str' => $start_str,
			'apple_result_no_designation' => $apple_result_no_designation,
			'apple_result_designation' => $apple_result_designation,
		);

		return View::forge('sample/show', $result);
	}
}

<?php

use Fuel\Core\Str;

use Fuel\Core\View;

class Controller_Sample extends Controller

{

public function action_show()

{

$apple = 'apple';

$start_str = 'APP';

$apple_result_no_designation = Str::starts_with($apple, $start_str) ? '〇' : '×';

$apple_result_designation = Str::starts_with($apple, $start_str, true) ? '〇' : '×';

$result = array(

'apple' => $apple,

'start_str' => $start_str,

'apple_result_no_designation' => $apple_result_no_designation,

'apple_result_designation' => $apple_result_designation,

);

return View::forge('sample/show', $result);

}

ビューのサンプルプログラム

<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8">
        <title>表示サンプル</title>
    </head>
    <body>
        <h1>Str::starts_withメソッドサンプル</h1>
        <p>
            チェック対象の文字列 => <?php echo $apple?>
        </p>
        <p>
            始まっているか確認する文字列 => <?php echo $start_str?>
        </p>
        <h2>大文字小文字を無視しない場合（第三引数はデフォルト）</h2>
        <p>
            確認する文字列から始まっているか => <?php echo $apple_result_no_designation?>
        </p>
        <h2>大文字小文字を無視する場合（第三引数はtrueを指定）</h2>
        <p>
            確認する文字列から始まっているか => <?php echo $apple_result_designation?>
        </p>
    </body>
</html>

<!DOCTYPE html>

<html>

<head>

<title>表示サンプル</title>

</head>

<body>

<h1>Str::starts_withメソッドサンプル</h1>

<p>

チェック対象の文字列 => <?php echo $apple?>

</p>

<p>

始まっているか確認する文字列 => <?php echo $start_str?>

</p>

<h2>大文字小文字を無視しない場合（第三引数はデフォルト）</h2>

<p>

確認する文字列から始まっているか => <?php echo $apple_result_no_designation?>

</p>

<h2>大文字小文字を無視する場合（第三引数はtrueを指定）</h2>

<p>

確認する文字列から始まっているか => <?php echo $apple_result_designation?>

</p>

</body>

</html>

実行結果

XAMPPを起動して、【http://localhost/fuelphp/sample/show】のURLにアクセスします。
FuelPHPのURLの構造と、XAMPPでPHPの動かし方についてはこちらの記事をご参考ください。

FuelPHPのURLの構造について
【FuelPHP】URLの構造について解説します

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

FuelPHPのStr::starts_withメソッドを解説

第三引数を指定の有無で異なる判定結果になっていることが確認できました。

まとめ：Str::starts_withメソッドを使ってみよう！

以上がStr::starts_withメソッドについての解説でした！

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