Spouses¶
Описание: Класс для представления супруга/супруги персоны Представляет информацию о супруге или супруге персоны, включая персональные данные, статус отношений, количество детей и причины развода. Используется для хранения и обработки семейной информации персон из API Kinopoisk.dev.
С версии: 1.0.0
Версия: 1.0.0
См. также:
\KinopoiskDev\Enums\PersonSex
: Для определения пола супруга\KinopoiskDev\Models\Person
: Для основной модели персоны
__construct()
¶
Описание: Конструктор для создания объекта супруга Создает новый экземпляр класса Spouses с информацией о супруге персоны. Все свойства являются для обеспечения неизменности данных. Параметр divorced имеет значение по умолчанию false.
Параметры:
$id
(int): Уникальный идентификатор супруга в базе данных$name
(string): Полное имя супруга$divorcedReason
(string): Причина развода (пустая строка если развода не было)$sex
(PersonSex): Пол супруга (мужской или женский)$children
(int): Количество детей в браке$relation
(string): Описание типа отношений или дополнительная информация$divorced
(bool): Статус развода (true - в разводе, false - в браке, по умолчанию false)
См. также:
Spouses::fromArray
: () Для создания объекта из массива данных APISpouses::toArray
: () Для преобразования объекта в массив
fromArray()
¶
Описание: Создает объект Spouses из массива данных API Фабричный метод для создания экземпляра класса Spouses из массива данных, полученных от API Kinopoisk.dev. Безопасно обрабатывает все поля массива и автоматически преобразует строковое значение пола в enum PersonSex с помощью метода tryFrom(). - id: int - уникальный идентификатор супруга - name: string - полное имя супруга - divorced: bool - статус развода - divorcedReason: string - причина развода - sex: string - пол супруга ('male' или 'female') - children: int - количество детей - relation: string - тип отношений
Возвращает: static
Новый экземпляр класса Spouses с данными из массива
См. также:
Spouses::toArray
: () Для обратного преобразования в массивPersonSex::tryFrom
: () Для безопасного преобразования строки в enum
toArray()
¶
Описание: Преобразует объект в массив данных Конвертирует текущий экземпляр класса Spouses в массив, совместимый с форматом API Kinopoisk.dev. Используется для сериализации данных при отправке запросов к API или для экспорта данных в JSON. Enum PersonSex автоматически преобразуется в строковое значение. - id: int - уникальный идентификатор супруга - name: string - полное имя супруга - divorced: bool - статус развода - divorcedReason: string - причина развода - sex: PersonSex - пол супруга (enum объект) - children: int - количество детей - relation: string - тип отношений
Возвращает: array
Массив с данными о супруге, содержащий ключи:
См. также:
Spouses::fromArray
: () Для создания объекта из массиваPersonSex::value
: Для получения строкового значения enum
validate()
¶
Описание: Валидирует данные модели
Возвращает: bool True
если данные валидны