【Laravel】文字列をスネークケースに変換できるStr::snakeメソッドについて解説します

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

この記事では、 Laravelで文字列をスネークケースに変換できるStr::snakeメソッドについて

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

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

キャメルケースなど、ほかの変換するメソッドについてはこちらの記事をご参考ください。

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

実行環境はWindowsで、Laravelのバージョンは【8.10.0】です。

この記事では

C:\Laravel\LaravelSample

配下にLaravelのプロジェクトを作成しています。

Laravelのインストールのやり方については、以下の記事をご参考ください。

スネークケースとは

そもそものスネークケースについて軽く解説します。
スネークケースとは、

  • get_data
  • test_flg

のように単語と単語を「_(アンダースコア)」でつなげる表記方法です。
スネークケースではすべての文字を小文字で使います。

Str::snakeメソッドとは

では本題に入ります。
Str::snakeメソッドとは、引数に指定された文字列をスネークケースに変換して返すメソッドです。
Str::snakeメソッドを使うためには

を宣言する必要があります。
使い方サンプルは下記になります。

上記の例だと変数resultには「hoge_hoge」という値が返されます。

では、次の章で実際に使って解説します。

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

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

  • コントローラー
  • Bladeビュー
  • routes\web.php

3つを使います。

コントローラーは名前を【SampleController】とし、

LaravelSample\app\Http\Controllers\SampleController.php

に位置しています。
関数内でいくつかの文字列に対してスネークケースへ変換し、それらをまとめてBladeビューに渡します。
コントローラーからBladeビューに値を渡す方法については、こちらの記事をご参考ください。

Bladeビューは名前を【printsample.blade.php】とし、viewsディレクトリ直下に格納します。
コントローラーから渡された配列を表示します。

routes\web.phpには、【http://〇〇.〇〇.〇〇:8000/showvalue】でアクセスした場合、SampleControllerの関数を呼ぶように設定します。

SampleController.phpのサンプルプログラム

コントローラーで使っている

  • array関数
  • compact関数

については、こちらの記事をご参考ください。

printsample.blade.phpのサンプルプログラム

web.phpのサンプルプログラム

実行して確認

スネークケースに変換できているかを実行して確認します。
Laravelでサーバーを立ち上げるコマンドは

です。
サーバーを立ち上げるコマンドの詳細な説明は、こちらの記事をご参考ください。

  • http://〇〇〇.〇〇〇.〇〇〇.〇〇〇:8000/showvalue
    ※コマンドプロンプトに記載されているURL
  • http://localhost:8000/showvalue

どちらかのURLにアクセスすれば、文字列がスネークケースに変換できていることを確認できます!

まとめ:Laravelで文字列をスネークケースに変換するときはStr::snakeメソッドを使ってみよう

以上がLaravelのStr::snakeメソッドの解説でした!

あなたのご参考になったのなら、とても嬉しいです(*´▽`*)
ではでは~(・ω・)ノシ

コメント

タイトルとURLをコピーしました