Documentation

Ebook

in package

• Lwt

Table of Contents

Properties

$archive  : BaseArchive|null

$audio  : Audio|null

$authorMain  : BookAuthor|null

$authors  : array<string|int, BookAuthor>

$basename  : string

$copyright  : string|null

$countsParsed  : bool

$cover  : EbookCover|null

$createdAt  : DateTime|null

$description  : string|null

$execTime  : float|null

$extension  : string

$extras  : array<string, mixed>

$filename  : string

$format  : EbookFormatEnum|null

$hasParser  : bool

$identifiers  : array<string|int, BookIdentifier>

$isArchive  : bool

$isAudio  : bool

$isBadFile  : bool

$isMobi  : bool

$language  : string|null

$metaTitle  : MetaTitle|null

$pagesCount  : int|null

$parser  : EbookParser|null

$path  : string

$publishDate  : DateTime|null

$publisher  : string|null

$series  : string|null

$size  : int

$tags  : array<string|int, string>

$title  : string|null

$volume  : int|float|null

$wordsCount  : int|null

Methods

__toString()  : string

create()  : ArchiveZipCreate

Create an ebook file.

getArchive()  : BaseArchive|null

Archive reader, from `kiwilan/php-archive`.

getAudio()  : Audio|null

Audio reader, from `kiwilan/php-audio`.

getAuthorMain()  : BookAuthor|null

First author of the book (useful if you need to display only one author).

getAuthors()  : array<string|int, BookAuthor>

All authors of the book.

getBasename()  : string

Basename of the ebook, e.g. `The Clan of the Cave Bear.epub`.

getCopyright()  : string|null

Copyright of the book.

getCover()  : EbookCover|null

Cover of the ebook.

getCreatedAt()  : DateTime|null

Creation date of the ebook.

getDescription()  : string|null

Raw description of the book.

getDescriptionAdvanced()  : BookDescription

Advanced description with multi-options for the book.

getExecTime()  : float|null

Execution time for parsing the ebook.

getExtension()  : string

Extension of the ebook, e.g. `epub`.

getExtra()  : mixed

Get key from `extras` safely.

getExtras()  : array<string, mixed>

Extras of the ebook.

getFilename()  : string

Filename of the ebook, e.g. `The Clan of the Cave Bear`.

getFormat()  : EbookFormatEnum|null

Format of the ebook.

getIdentifiers()  : array<string|int, BookIdentifier>

Identifiers of the book.

getLanguage()  : string|null

Language of the book.

getMetadata()  : EbookParser|null

Parser of the ebook.

getMetaTitle()  : MetaTitle|null

Title metadata of the book with slug, sort title, series slug, etc.

getPagesCount()  : int|null

Page count of the ebook.

getParser()  : EbookParser|null

Parser of the ebook.

getPath()  : string

Physical path to the ebook.

getPublishDate()  : DateTime|null

Publish date of the book.

getPublisher()  : string|null

Publisher of the book.

getSeries()  : string|null

Series of the book.

getSize()  : int

Size of the ebook, in bytes.

getSizeHumanReadable()  : string

Size of the ebook in human readable format, e.g. `1.23 MB`.

getTags()  : array<string|int, string>

Tags of the book.

getTitle()  : string|null

Title of the book.

getVolume()  : int|float|null

Volume of the book.

getWordsCount()  : int|null

Word count of the ebook.

hasCover()  : bool

Whether the ebook has a cover.

hasMetadata()  : bool

Whether the ebook has parser.

hasParser()  : bool

Whether the ebook has parser.

hasSeries()  : bool

Whether the ebook has series.

isArchive()  : bool

Whether the ebook is an archive.

isAudio()  : bool

Whether the ebook is an audio.

isBadFile()  : bool

Whether the ebook is a bad file.

isMobi()  : bool

Whether the ebook is a mobi.

isValid()  : bool

Check if an ebook file is valid.

read()  : self|null

Read an ebook file.

setAuthor()  : self

setAuthorMain()  : self

setAuthors()  : self

setCopyright()  : self

setDescription()  : self

setExtra()  : self

setExtras()  : self

setHasParser()  : self

setIdentifier()  : self

setIdentifiers()  : self

setLanguage()  : self

setMetaTitle()  : self

setPagesCount()  : self

setPublishDate()  : self

setPublisher()  : self

setSeries()  : self

setTag()  : self

setTags()  : self

setTitle()  : self

setVolume()  : self

setWordsCount()  : self

toArray()  : array<string|int, mixed>

toJson()  : string

toXml()  : string|null

wordsByPage()  : int

__construct()  : mixed

audiobook()  : EbookModule

cba()  : EbookModule

clean()  : self

convertCounts()  : self

convertEbook()  : self

djvu()  : EbookModule

epub()  : EbookModule

fb2()  : EbookModule

generateFileMetadata()  : void

Generate file metadata.

mobi()  : EbookModule

parseFile()  : Ebook

Parse an ebook file.

pdf()  : EbookModule