git 0ab96f0b7c55966f5402b99e37268a0e9dacd03e
- Введение
- Сериализация моделей и коллекций
- Скрытие атрибутов из JSON
- Добавление значений в JSON
- Сериализация Даты
При создании API-интерфейсов с использованием Laravel вам часто нужно преобразовывать свои модели и отношения в массивы или JSON. Eloquent включает удобные методы для выполнения этих преобразований, а также для управления тем, какие атрибуты включаются в сериализованное представление ваших моделей.
{tip} Чтобы получить еще более надежный способ обработки JSON-сериализации модели Eloquent и коллекции, ознакомьтесь с документацией на Ресурсы API Eloquent.
Чтобы преобразовать модель и ее загруженные отношения в массив, вы должны использовать метод toArray. Этот метод является рекурсивным, поэтому все атрибуты и все отношения (включая отношения отношений) будут преобразованы в массивы:
use App\Models\User;
$user = User::with('roles')->first();
return $user->toArray();
Метод attributesToArray используется для преобразования атрибутов модели в массив, но не его отношений:
$user = User::first();
return $user->attributesToArray();
Вы также можете преобразовать целые коллекции моделей в массивы, вызвав метод toArray экземпляра коллекции:
$users = User::all();
return $users->toArray();
Чтобы преобразовать модель в JSON, вы должны использовать метод toJson. Как и toArray, метод toJson является рекурсивным, поэтому все атрибуты и отношения будут преобразованы в JSON. Вы также можете указать любые параметры кодировки JSON, которые поддерживаются PHP:
use App\Models\User;
$user = User::find(1);
return $user->toJson();
return $user->toJson(JSON_PRETTY_PRINT);
В качестве альтернативы вы можете преобразовать модель или коллекцию в строку, которая автоматически вызовет метод toJson модели или коллекции:
return (string) User::find(1);
Поскольку модели и коллекции преобразуются в JSON при преобразовании в строку, вы можете возвращать объекты Eloquent непосредственно из маршрутов или контроллеров вашего приложения. Laravel автоматически сериализует ваши модели и коллекции Eloquent в JSON, когда они возвращаются из маршрутов или контроллеров:
Route::get('users', function () {
return User::all();
});
Когда модель Eloquent преобразуется в JSON, ее загруженные отношения автоматически включаются в качестве атрибутов в объект JSON. Кроме того, хотя методы-отношения Eloquent определены с использованием имен методов в «верблюжьей нотации», атрибут JSON отношения будет в «змеиной нотации».
По желанию можно исключить атрибуты, такие как пароли, содержащиеся в массиве модели или представлении JSON. Для этого добавьте в модель свойство $hidden. Атрибуты, перечисленные в массиве свойств $hidden, не будут включены в сериализованное представление модели:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* Атрибуты, которые должны быть скрыты из массивов.
*
* @var array
*/
protected $hidden = ['password'];
}
{tip} Чтобы скрыть отношения, добавьте имя метода-отношения к свойству
$hiddenмодели Eloquent.
В качестве альтернативы вы можете использовать свойство visible для определения «разрешенного списка» атрибутов, которые должны быть включены в массив модели и представление JSON. Все атрибуты, отсутствующие в массиве $visible, будут скрыты при преобразовании модели в массив или JSON:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* Атрибуты, которые должны быть видны в массивах.
*
* @var array
*/
protected $visible = ['first_name', 'last_name'];
}
По желанию можно сделать некоторые обычно скрытые атрибуты видимыми на конкретном экземпляре модели, для этого используйте метод makeVisible. Метод makeVisible возвращает экземпляр модели:
return $user->makeVisible('attribute')->toArray();
Аналогично, если вы хотите скрыть некоторые атрибуты, которые обычно видны, вы можете использовать метод makeHidden:
return $user->makeHidden('attribute')->toArray();
Иногда при преобразовании моделей в массивы или JSON вы можете добавить атрибуты, которым нет соответствующего столбца в вашей базе данных. Для этого сначала определите аксессоры для значения:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* Определить, является ли пользователь администратором.
*
* @return bool
*/
public function getIsAdminAttribute()
{
return $this->attributes['admin'] === 'yes';
}
}
После создания аксессора добавьте имя атрибута к свойству appends модели. Обратите внимание, что на имена атрибутов обычно ссылаются в «змеиной нотации», даже если аксессор определяется с помощью «верблюжьей нотации»:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* Аксессоры, добавляемые к массиву модели.
*
* @var array
*/
protected $appends = ['is_admin'];
}
После того как атрибут был добавлен в список appends, он будет включен как в массив модели, так и в представления JSON. Атрибуты в массиве appends также будут учитывать настройки visible и hidden, заданные в модели.
Во время выполнения скрипта вы можете указать экземпляру модели добавить дополнительные атрибуты с помощью метода append. Или вы можете использовать метод setAppends, чтобы переопределить весь массив добавленных свойств для конкретного экземпляра модели:
return $user->append('is_admin')->toArray();
return $user->setAppends(['is_admin'])->toArray();
Вы можете настроить формат сериализации по умолчанию для всех дат вашей модели, переопределив метод serializeDate вашей модели. Этот метод не влияет на форматирование дат для их сохранения в базе данных:
/**
* Подготовить дату для сериализации массива / JSON.
*
* @param \DateTimeInterface $date
* @return string
*/
protected function serializeDate(DateTimeInterface $date)
{
return $date->format('Y-m-d');
}
Вы можете настроить формат сериализации отдельных атрибутов даты, указав формат даты при объявлении типизации модели:
protected $casts = [
'birthday' => 'date:Y-m-d',
'joined_at' => 'datetime:Y-m-d H:00',
];