Book

Book

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

Содержание

Константы	Свойства	Методы
STATUS_OPEN	id	hasReview
STATUS_CLOSE	title	isClose
COVER_PATH	description
	description_plain
	cover
	cover_path
	cover_url
	url
	status
	author_id
	author
	mongodb_book_id
	page_count
	rating
	users
	reviews
	created_at
	updated_at
	deleted_at

Константы

STATUS_OPEN

Описание: Статус книги соответствующий чистовику
значение: 'open_by_author'

STATUS_CLOSE

Описание: Статус книги соответствующий черновику
значение: 'close_by_author'

COVER_PATH

Описание: Корневой каталог для обложек книг в рамках файловой системы Amazon S3
значение: 'book_covers'

Свойства

id

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

title

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

description

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

description_plain

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

cover

Описание: Имя обложки книги
Возвращаемое значение: string | null

cover_path

Описание: Путь до обложки книги в рамках файловой системы Amazon S3
Возвращаемое значение: string | null

cover_url

Описание: Ссылка на обложку книги, либо обложка по умолчанию
Возвращаемое значение: string

url

Описание: Ссылка на книгу в рамках alterbooks
Возвращаемое значение: string

status

Описание: Текущий статус книги. Соответствует одной из констант (STATUS_OPEN, STATUS_CLOSE)
Возвращаемое значение: string

author_id

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

author

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

mongodb_book_id

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

page_count

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

rating

Описание: Рейтинг книги, высчитываемый как медианное значение совокупности оценок в рецензиях (Review)
Возвращаемое значение: Float

users

Описание: Коллекция пользователей (User) добавивших книгу к себе в библиотеку
Возвращаемое значение: \Illuminate\Database\Eloquent\Collection | \App\User[]

reviews

Описание: Список рецензий (Review) оставленных к этой книге
Возвращаемое значение: \Illuminate\Database\Eloquent\Collection | \App\Review[]

created_at

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

updated_at

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

deleted_at

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

Методы

hasReview($user)

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

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

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

isClose()

Описание: Проверяет, закрыта ли профиль книги для просмотра
Возвращаемое значение: bool