Documentation

OpfItem
in package

Transform `.opf` file to an object.

Table of Contents

Properties

$contentFiles  : array<string|int, string>
$coverPath  : string|null
$dcContributors  : array<string|int, BookContributor>
$dcCreators  : array<string|int, BookAuthor>
$dcDate  : DateTime|null
$dcDescription  : string|null
$dcIdentifiers  : array<string|int, BookIdentifier>
$dcLanguage  : string|null
$dcPublisher  : string|null
$dcRights  : array<string|int, mixed>
$dcSubject  : array<string|int, string>
$dcTitle  : string|null
$epubVersion  : int|null
$filename  : string|null
$guide  : array<string|int, mixed>
$manifest  : array<string|int, mixed>
$meta  : array<string|int, BookMeta>
$metadata  : array<string|int, mixed>
$spine  : array<string|int, mixed>
$xml  : XmlReader

Methods

__toString()  : string
getContentFiles()  : array<string|int, string>
getCoverPath()  : string|null
getDcContributors()  : array<string|int, BookContributor>
getDcCreators()  : array<string|int, BookAuthor>
getDcDate()  : DateTime|null
getDcDescription()  : string|null
getDcIdentifiers()  : array<string|int, BookIdentifier>
getDcLanguage()  : string|null
getDcPublisher()  : string|null
getDcRights()  : array<string|int, string>
getDcSubject()  : array<string|int, string>
getDcTitle()  : string|null
getEpubVersion()  : int|null
getGuide()  : array<string|int, mixed>
getManifest()  : array<string|int, mixed>
getMeta()  : array<string|int, BookMeta>
getMetadata()  : array<string|int, mixed>
getMetaItem()  : BookMeta|null
getMetaItems()  : array<string|int, BookMeta>
getSpine()  : array<string|int, mixed>
make()  : self
toArray()  : array<string|int, mixed>
toJson()  : string
__construct()  : mixed
findContent()  : array<string|int, string>
findCover()  : string|null
multipleItems()  : array<string|int, mixed>
parseMetadata()  : self
parseMetadataNode()  : string|null
parseNode()  : string|null
setDcContributors()  : array<string|int, BookContributor>
setDcCreators()  : array<string|int, BookAuthor>
setDcDate()  : DateTime|null
setDcIdentifiers()  : array<string|int, BookIdentifier>
setDcRights()  : array<string|int, string>
setDcSubjects()  : array<string|int, mixed>
setMeta()  : array<string|int, BookMeta>

Properties

$contentFiles

protected array<string|int, string> $contentFiles = []

$coverPath

protected string|null $coverPath = null

$dcDate

protected DateTime|null $dcDate = null

$dcDescription

protected string|null $dcDescription = null

$dcLanguage

protected string|null $dcLanguage = null

$dcPublisher

protected string|null $dcPublisher = null

$dcRights

protected array<string|int, mixed> $dcRights = []

$dcSubject

protected array<string|int, string> $dcSubject = []

$dcTitle

protected string|null $dcTitle = null

$epubVersion

protected int|null $epubVersion = null

$filename

protected string|null $filename = null

$guide

protected array<string|int, mixed> $guide = []

$manifest

protected array<string|int, mixed> $manifest = []

$metadata

protected array<string|int, mixed> $metadata = []

$spine

protected array<string|int, mixed> $spine = []

Methods

__toString()

public __toString() : string
Return values
string

getContentFiles()

public getContentFiles() : array<string|int, string>
Return values
array<string|int, string>

getCoverPath()

public getCoverPath() : string|null
Return values
string|null

getDcDate()

public getDcDate() : DateTime|null
Return values
DateTime|null

getDcDescription()

public getDcDescription() : string|null
Return values
string|null

getDcLanguage()

public getDcLanguage() : string|null
Return values
string|null

getDcPublisher()

public getDcPublisher() : string|null
Return values
string|null

getDcRights()

public getDcRights() : array<string|int, string>
Return values
array<string|int, string>

getDcSubject()

public getDcSubject() : array<string|int, string>
Return values
array<string|int, string>

getDcTitle()

public getDcTitle() : string|null
Return values
string|null

getEpubVersion()

public getEpubVersion() : int|null
Return values
int|null

getGuide()

public getGuide() : array<string|int, mixed>
Return values
array<string|int, mixed>

getManifest()

public getManifest() : array<string|int, mixed>
Return values
array<string|int, mixed>

getMeta()

public getMeta() : array<string|int, BookMeta>

Use getMetaItems instead.

Return values
array<string|int, BookMeta>

getMetadata()

public getMetadata() : array<string|int, mixed>
Return values
array<string|int, mixed>

getMetaItem()

public getMetaItem(string $key) : BookMeta|null
Parameters
$key : string
Return values
BookMeta|null

getSpine()

public getSpine() : array<string|int, mixed>
Return values
array<string|int, mixed>

make()

public static make(string $content[, string|null $filename = null ]) : self
Parameters
$content : string
$filename : string|null = null
Return values
self

toArray()

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

toJson()

public toJson() : string
Return values
string

findContent()

private findContent() : array<string|int, string>
Return values
array<string|int, string>

findCover()

private findCover() : string|null
Return values
string|null

multipleItems()

private multipleItems(mixed $items) : array<string|int, mixed>
Parameters
$items : mixed
Return values
array<string|int, mixed>

parseMetadata()

private parseMetadata() : self
Return values
self

parseMetadataNode()

private parseMetadataNode(string $key) : string|null
Parameters
$key : string
Return values
string|null

parseNode()

private parseNode(mixed $core) : string|null
Parameters
$core : mixed
Return values
string|null

setDcDate()

private setDcDate() : DateTime|null
Return values
DateTime|null

setDcRights()

private setDcRights() : array<string|int, string>
Return values
array<string|int, string>

setDcSubjects()

private setDcSubjects() : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results