Laravel Model内でデータを取得し文字列を返したい

Question

前提・実現したいこと

LaravelでModel(App\Profile)内でデータを取得し、指定したように文字列で返したいです。

具体的に言うと、Laravelで指定したカラムsex age is_adultから指定した文字列に返す様なものです。

例として、以下の様な場合は文字列で未婚男性31歳と返したいと思います。

カラム名	データ
is_marriage	0
sex	0
age	31

質問点

• 下記の場合は、関数名の命名規則として何かあるのか調べたところミューテタというものの存在を知ったのですが、ドキュメントや他の記事を見る限り今回実装したいものとは異なる点があると思ったので、今回の関数名は特に指定をしなかったのですが、これで問題ないのでしょうか？

• App\Profile.php内で自らのクラスであるProfileを呼び出してしまっているのですが、何かもっと良い方法はないでしょうか？

• 根本的な修正が必要なのでしょうか？

該当のソースコード

// App\Profile
public static function getUserStatus($id) {
    $profiles = Profile::find($id)->select('is_marriage', 'sex', 'age');
    $s[1] = $profiles['is_marriage'] == true ? '未婚' : '既婚';
    $s[2] = $profiles['sex'] === 0 ? '男性' : '女性';
    return $s[1].$s[2].$profiles['age'].'歳';

試したこと

上記コードを試してみました。

補足情報（FW/ツールのバージョンなど）

Laravel framework 6.x

Answer 1

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

/**
 * Class Profile
 * @package App
 *
 * @property string is_marriage
 * @property string sex
 * @property string age
 */
class Profile extends Model
{
    /**
     * @return string
     */
    public function getUserStatusAttribute(): string
    {
        return $this->is_marriage . $this->sex . $this->age;
    }

    /**
     * @param mixed $value
     * @return string
     */
    public function getIsMarriageAttribute($value): string
    {
        return ($value) ? '既婚' : '未婚';
    }

    /**
     * @param mixed $value
     * @return string
     */
    public function getSexAttribute($value): string
    {
        return ($value === 0) ? '男性' : '女性';
    }

    /**
     * @param mixed $value
     * @return string
     */
    public function getAgeAttribute($value): string
    {
        return sprintf('%d歳', $value);
    }
}

// web.php
Route::get('profiles/{profile}', 'ProfileController@show')->name('profiles.show');

// ExampleController 

public function show(Profile $profile)
{
     return view('profiles.show', compact('profile'));
}

// profiles/show.blade.php

{{ $profile->user_status }}

Comments

[退会済みユーザー]

いくつか質問があるのですが、getXXXXXAttributeのXには必ずしもカラム名が入るとは限らないと認識でよろしいのでしょうか？
また取得する際は、viewで {{ \App\Profile::getUserStatusAttribute() }}と取得していたのですが、なぜ、{{ $profile->user_status }} で取得できるのでしょうか？

具体的にはマニュアルに以下のように記載されていたのですが理解することができませんでした。
> アクセサを定義するには、アクセスしたいカラム名が「studlyケース（Upper Camel Case）」でFooの場合、getFooAttributeメソッドをモデルに作成します。以下の例では、first_name属性のアクセサを定義しています。first_name属性の値にアクセスが起きると、Eloquentは自動的にこのアクセサを呼び出します。

[phper.k]

質問に回答する前に確認のため、あなたに質問があるのですが、よろしいですか？

[退会済みユーザー]

私に質問ですか(?)どうぞ。

[phper.k]

あなたへの質問内容は、追加の質問をする前に、リファレンスを読んだのか？
ですが、のちに、編集されてますね。

よんでもよくわからなかったとのことですが、確かに、文章だけではわからないかもしれませんが、その下の部分に、「コードの例」があり、それを見ればわかりませんかね？

[退会済みユーザー]

ありがとうございます。どこが疑問だったか整理し、こちらにコメントしようと思います。

[退会済みユーザー]

整理できました。
まず、getIsMarriageAttributeやgetSexAttributeなどはカラム名に従って命名していることは分かったのですが、getUserStatusAttributeというメソッドはそれに対応したカラムはないのですが、それでも問題ないという認識であっているでしょうか？

[phper.k]

https://readouble.com/laravel/7.x/ja/eloquent-mutators.html
こちらの、「ユーザーのフルネーム取得」の例示されたコード参照してください。

[退会済みユーザー]

そちらも以下で取得ができるということですね！ありがとうございます。

$user = App\User::find(1);

$fullName = $user->full_name;