[Laravel]Eloquentで不要なカラムを出力しない！$hiddenと$visibleプロパティの使い方を解説

$hiddenと$visibleプロパティとは何か？

LaravelのEloquent ORMでは、モデルをJSONや配列に変換する際に、不要なカラムを出力しないようにしたり、特定のカラムのみを出力するように設定することができます。この機能を実現するために、$hiddenプロパティと$visibleプロパティが用意されています。

$hiddenプロパティ

• 役割: モデルを配列やJSONに変換する際に、非表示にする属性を指定します。
• 使用方法: モデルクラス内に$hiddenプロパティを定義し、非表示にしたい属性名を配列で指定します。

class User extends Model
{
    protected $hidden = ['password', 'remember_token'];
}

上記の例では、Userモデルのpasswordとremember_token属性が非表示になります。

$visibleプロパティ

• 役割: モデルを配列やJSONに変換する際に、表示する属性を指定します。
• 使用方法: モデルクラス内に$visibleプロパティを定義し、表示したい属性名を配列で指定します。

class User extends Model
{
    protected $visible = ['name', 'email'];
}

上記の例では、Userモデルのnameとemail属性のみが表示されます。

$hiddenと$visibleの使い分け

• $hidden: 非表示にする属性を指定する場合に利用します。
• $visible: 表示する属性を指定する場合に利用します。
• 両方指定した場合:$visibleのプロパティが優先されます。

JSONへの変換時や配列への変換時の挙動

toJson()メソッドやtoArray()メソッドでモデルをJSONや配列に変換する際に、$hiddenと$visibleプロパティの設定が反映されます。

$user = User::first();
$userArray = $user->toArray(); // $hiddenと$visibleの設定に従った配列が返される
$userJson = $user->toJson();   // $hiddenと$visibleの設定に従ったJSON文字列が返される

$hiddenと$visibleのメリット

• セキュリティの向上: パスワードやトークンなど、機密性の高い情報を外部に漏らさないようにすることができます。
• パフォーマンスの向上: 不要なデータを転送する必要がないため、APIレスポンスのサイズを削減し、パフォーマンスを向上させることができます。
• データの整形: フロントエンドで必要なデータのみを返すことで、表示を簡潔にすることができます。

$hiddenと$visibleプロパティは、LaravelのEloquentでモデルの表示/非表示を制御する上で非常に便利な機能です。適切に活用することで、より安全かつ効率的なアプリケーション開発が可能になります。

$hiddenと$visibleプロパティの活用シーン

$hiddenと$visibleプロパティは、様々な場面で活用できます。以下に代表的な活用シーンをいくつか紹介します。

API開発におけるセキュリティ向上

APIを通じて外部にデータを公開する場合、パスワードやトークンなどの機密情報をそのまま返すことはセキュリティ上のリスクとなります。$hiddenプロパティを利用して、これらの情報を非表示にすることで、情報漏洩を防ぐことができます。

フロントエンドへの不要なデータ送信の抑制

フロントエンドで必要のない情報を大量に送信すると、通信負荷が増加し、パフォーマンスが低下する可能性があります。$visibleプロパティを利用して、フロントエンドで必要な情報のみを返すことで、通信量を削減し、ユーザーエクスペリエンスを向上させることができます。

データの整形

データベースから取得したデータをそのままフロントエンドに渡すのではなく、$hiddenと$visibleプロパティを組み合わせることで、フロントエンドで扱いやすいようにデータを整形することができます。例えば、日付形式を変更したり、不要な関連データを除外したりすることができます。

class Product extends Model
{
    protected $hidden = ['created_at', 'updated_at'];
    protected $appends = ['formatted_price'];
}

$visibleプロパティの活用例：特定の条件下で異なるカラムを表示

アクセスコントロールなど、特定の条件下で表示するカラムを切り替える場合に、$visibleプロパティが有効です。

class User extends Model
{
    public function getVisibleAttribute()
    {
        if (auth()->user()->isAdmin()) {
            return ['name', 'email', 'role'];
        } else {
            return ['name', 'email'];
        }
    }
}

$hiddenと$visibleプロパティの注意点と応用

$hiddenと$visibleプロパティは非常に便利な機能ですが、使い方によっては思わぬ結果になることがあります。また、これらのプロパティを組み合わせることで、より高度なデータ操作を実現することも可能です。

$hiddenと$visibleプロパティのオーバーライド

$hiddenと$visibleプロパティは、モデルクラスレベルで定義されていますが、個々のモデルインスタンスに対して、一時的に表示/非表示を切り替えることができます。

$user = User::first();
$user->makeVisible('password')->toArray(); // パスワードを表示

$hiddenと$visibleプロパティの応用的な使い方

• アクセス権限に基づいた表示/非表示: ユーザーのロールに応じて、表示するカラムを変更することができます。
• 条件分岐による表示/非表示: 特定の条件下で、特定のカラムのみを表示することができます。
• アクセサやミューテータとの連携: アクセサやミューテータで計算された値を、$visibleプロパティで表示することができます。

$hiddenと$visibleプロパティと他の機能との組み合わせ

• Appends: モデルに存在しない属性を追加して、$visibleプロパティで表示することができます。
• Relations: リレーション先のモデルの$hiddenと$visibleプロパティも継承されます。

注意点

• $hiddenと$visibleは、モデルを配列やJSONに変換する際の挙動に影響します。
• データベースからの取得データには影響しません。
• $hiddenと$visibleを同時に定義した場合、$visibleのプロパティが優先されます。
• 複雑なロジックを実装する場合は、可読性を考慮してコードを記述する必要があります。

まとめ

LaravelのEloquent ORMでは、モデルをJSONや配列に変換する際に、$hiddenと$visibleプロパティを利用することで、不要なカラムを出力しないようにしたり、特定のカラムのみを出力するように設定することができます。

• $hiddenプロパティ: モデルを配列やJSONに変換する際に、非表示にする属性を指定します。
• $visibleプロパティ: モデルを配列やJSONに変換する際に、表示する属性を指定します。

これらのプロパティを適切に活用することで、以下のようなメリットが得られます。

• セキュリティの向上: パスワードやトークンなどの機密情報を外部に漏らさないようにすることができます。
• パフォーマンスの向上: 不要なデータを転送する必要がないため、APIレスポンスのサイズを削減し、パフォーマンスを向上させることができます。
• データの整形: フロントエンドで必要な情報のみを返すことで、表示を簡潔にすることができます。

具体的な活用シーン

• API開発におけるセキュリティ向上
• フロントエンドへの不要なデータ送信の抑制
• データの整形
• アクセス権限に基づいた表示/非表示
• 条件分岐による表示/非表示

注意点と応用

• $hiddenと$visibleは、モデルを配列やJSONに変換する際の挙動に影響します。
• $hiddenと$visibleを同時に定義した場合、$visibleのプロパティが優先されます。
• アクセサやミューテータとの連携も可能です。

Follow me!