淺析laravel中將模型轉為陣列的三種方法

在 Laravel 中，我們可以透過 toArray() 方法將模型轉換為陣列。這個方法非常方便，因為我們經常需要將模型的資料傳回給客戶端或在模板中使用。

不過，在實際的開發中，我們可能會遇到一些特殊的情況需要自訂陣列的輸出格式。以下就來介紹 Laravel 中如何將模型轉換為數組，並且如何自訂數組的輸出格式。

使用 toArray() 方法

toArray() 方法是 Laravel 中將模型轉換為陣列的最常用的方法。這個方法會將模型物件的屬性以及關聯關係轉換為數組，非常方便地用於輸出給客戶端。

下面是一個使用toArray() 方法將模型轉換成陣列的範例：

$user = User::find(1);
$array = $user->toArray();

在這個範例中，我們透過User::find( 1) 取得了一個使用者對象，然後使用toArray() 方法將其轉換為一個陣列。

轉換後的陣列通常長這樣：

[
    'id' => 1,
    'name' => '张三',
    'email' => 'zhangsan@example.com',
    'created_at' => '2021-01-01 00:00:00',
    'updated_at' => '2021-01-01 00:00:00',
    'articles' => [
        [
            'id' => 1,
            'title' => '文章标题',
            'content' => '文章内容',
            'created_at' => '2021-01-01 00:00:00',
            'updated_at' => '2021-01-01 00:00:00',
        ],
        ...
    ],
]

可以看到，轉換後的陣列包含了模型主要的屬性以及關聯的關係。如果我們不需要關聯的關係，需要在模型中定義$hidden 屬性：

class User extends Model
{
    protected $hidden = ['articles'];
}

自訂toArray() 方法

如果我們需要自訂模型物件的轉換方法，可以在模型中實作toArray() 方法。這個方法會覆蓋預設的轉換方法，從而實現自訂的輸出效果。

下面是一個將模型物件的屬性打亂順序並且只輸出部分屬性的自訂toArray() 方法的範例：

class User extends Model
{
    protected $hidden = ['articles'];

    public function toArray()
    {
        $array = parent::toArray();
        $keys = array_keys($array);
        shuffle($keys);
        $newArray = [];

        foreach ($keys as $key) {
            if (in_array($key, ['id', 'name', 'email', 'created_at'])) {
                $newArray[$key] = $array[$key];
            }
        }

        return $newArray;
    }
}

在這個範例中，我們先呼叫父類別的toArray() 方法，以取得預設的轉換結果。然後，我們使用 shuffle() 方法將陣列中的鍵打亂順序，最後只輸出了部分屬性。

這個自訂toArray() 方法的輸出結果可能長這樣：

[
    'name' => '张三',
    'email' => 'zhangsan@example.com',
    'id' => 1,
    'created_at' => '2021-01-01 00:00:00',
]

使用$casts 屬性

在某些情況下，我們需要將模型的某些屬性以特定的形式輸出，例如將日期格式化為指定的格式，或將JSON 字串轉換為陣列。

在 Laravel 中，可以使用 $casts 屬性來實現這個目的。 $casts 屬性是一個數組，其中的鍵是模型的屬性名，值是要轉換的格式。

下面是一個使用$casts 屬性將模型的日期屬性輸出為Unix 時間戳記的範例：

class MyModel extends Model
{
    protected $casts = [
        'created_at' => 'timestamp',
        'updated_at' => 'timestamp',
    ];
}

在這個範例中，我們將created_at 和updated_at 兩個屬性的類型設定為'timestamp'，這樣在將模型轉換為陣列時，這兩個屬性的值就會轉換成Unix 時間戳記。

總結

在本文中，我們介紹了 Laravel 中如何將模型轉換為數組，以及如何自訂數組的輸出格式。除了 toArray() 方法之外，還可以使用自訂的 toArray() 方法和 $casts 屬性實作更靈活的陣列轉換。熟練這些方法，可以讓我們在開發中更方便地處理模型的轉換。

以上是淺析laravel中將模型轉為陣列的三種方法的詳細內容。更多資訊請關注PHP中文網其他相關文章！