Laravel

Laravel configファイルから値を取得する方法を解説

タクマ

こんにちは!タクマです。

31歳未経験からエンジニア転職に成功し、

2021年3月より都内の受託開発企業にてサーバーサイドエンジニアとして働いており、

PHP/Laravel、Vue.jsを使用し開発をしています。

今回は、Laravelのconfigファイルから値を取得する方法について解説します。

configを使うことによってメンテナンスがしやすくなり、修正の際も修正箇所が少なくて済むなどのメリットがあり、とても便利です。

知らない方はぜひ最後まで読んでください。

configファイルとは

configは、英単語のconfigurationの略になります。

configurationは設定、構成といった意味です。

アプリケーションの設定などを記載するディレクトリと覚えておけば良いかと思います。

使用例その1

前提条件

例えばuserモデルにsexというプロパティがあり、DBには男性が1、女性が2で登録されているとします。

$user->sex    // 男性の場合は1となる

$user->sex    // 女性の場合は2となる

これをそれぞれ1であれば男性、2であれば女性と表示させる場合にconfigを使用します。

configファイルへの定義

configディレクトリ以下にuser.phpファイル(ファイル名は任意の名前で可)を作成し、下記のように記述します。

<?php

return [
    'sex_display' => [
        1 => '男性',
        2 => '女性'
    ]
];

configに定義した値を呼び出す

configファイルに定義した値を呼び出すには下記のように記述します。

@foreach($users as $user)
    <div>
        {{ $user->name }}
    </div>
    <div>
        {{ config('user.sex_display.', $user->sex) }}
    </div>
@endforeach

このように記述することで、$user->sexが1であれば男性、2であれば女性と表示されます。

使用例その2

また様々なファイルで使用するであろう文字列などはconfigに定義しておくと修正の際configファイルを修正するだけで済むのでとても便利です。

例えば、お問い合わせ用のメールアドレスや電話番号などはconfigで管理しておくと良いです。

<?php

return [
    'email_address' => 'example@example.com',
    'telephone_number' => '03-1234-5678'
];
config('inquiry.email_address')    // example@example.com

config('inquiry.telephone_number')    // 03-1234-5678

さいごに

いかがでしたでしょうか?

configの使い方ついて理解できましたでしょうか?

ご質問やご指摘等ある方はコメントしていただければ返信させていただきます。

これからもLaravelエンジニアの方、Laravel学習中の初学者の方に役に立つ記事を更新していきますのでよろしくお願いします!

Twitterでも情報発信をしていますので、よかったらフォローをお願いします(^^)

Webエンジニア
タクマ
埼玉県出身の33歳

新卒で入社した専門商社で8年間営業職として勤務

30歳からプログラミングを始め31歳でWebエンジニアに転職成功

受託開発企業での開発を1年弱経験したのち、現在はスタートアップの自社開発企業で開発に従事している
\ Follow me /

COMMENT

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

CAPTCHA