Review

Review

Модель представляющая собой сущность Рецензии на площадке

Содержание

Константы	Свойства	Методы
-	id	usersEstimate
	text	isAuthor
	text_plain	isForBookOfUser
	user_id
	user
	book_id
	book
	rating
	estimate
	created_at
	created_at_plain
	updated_at
	deleted_at

Свойства

id

Описание: Уникальный идентификатор рецензии
Возвращаемое значение: Int

text

Описание: Текст рецензии с переводами строки заменёнными на html сущности (<br>)
Возвращаемое значение: string | null

text_plain

Описание: Текст рецензии в таком виде, в каком оно хранится в базе данных
Возвращаемое значение: _string | null

user_id

Описание: Уникальный идентификатор автора рецензии (User)
Возвращаемое значение: Int

user

Описание: Автор (User) рецензии
Возвращаемое значение: \App\User

book_id

Описание: Уникальный идентификатор рецензируемой книги (Book)
Возвращаемое значение: Int

book

Описание: Книга (Book) к которой оставлена рецензия
Возвращаемое значение: \App\Book

rating

Описание: Оценка книге
Возвращаемое значение: Int

estimate

Описание: Совокупная оценка рецензии
Возвращаемое значение: Int

created_at

Описание: Таймштамп даты создания сущности, возвращается в соответствии с часовым поясом пользователя (для неавторизованных по умолчанию UTC)
Возвращаемое значение: \Carbon\Carbon | null

created_at_plain

Описание: Таймштамп даты создания сущности в соответствии с UTC
Возвращаемое значение: \Carbon\Carbon | null

updated_at

Описание: Таймштамп даты последнего обновления сущности
Возвращаемое значение: \Carbon\Carbon | null

deleted_at

Описание: Таймштамп даты мягкого удаления сущности
Возвращаемое значение: \Carbon\Carbon | null

Методы

usersEstimate($user)

Описание: Возвращает оценку пользователя, если таковая имеется
Аргументы:

1. $user
   Описание: Пользователь, чью оценку необходимо найти
   Тип: \App\User

Возвращаемое значение: App\ReviewEstimate | null

isAuthor($user)

Описание: Проверить, является ли указанный пользователь автором рецензии
Аргументы:

1. $user
   Описание: Пользователь, чьё авторство необходимо проверить
   Тип: \App\User

Возвращаемое значение: bool

isForBookOfUser($user)

Описание: Проверить, оставлена ли текущая рецензия к одной из книг пользователя
Аргументы:

1. $user
   Описание: Пользователь, чьи книги необходимо проверить
   Тип: \App\User

Возвращаемое значение: bool