Documentation

MobiParser
in package

Inspired by https://stackoverflow.com/a/15199117/11008206

Table of Contents

Properties

$errors  : array<string|int, mixed>|null
$exthHeader  : ExthHeader|null
$exthRecords  : array<string|int, mixed>
$images  : MobiImages|null
$isValid  : bool
$mobiHeader  : MobiHeader|null
$palmDOCHeader  : PalmDOCHeader|null
$palmRecords  : array<string|int, mixed>
$stream  : Stream

Methods

get()  : array<string|int, mixed>|string|null
getErrors()  : array<string|int, string>|null
getExthHeader()  : ExthHeader|null
getExthRecords()  : array<string|int, ExthRecord>
getImages()  : MobiImages|null
getMobiHeader()  : MobiHeader|null
getPalmDOCHeader()  : PalmDOCHeader|null
getPalmRecords()  : array<string|int, PalmRecord>
getStream()  : Stream
isValid()  : bool
make()  : self|null
__construct()  : mixed
getRecord()  : array<string|int, ExthRecord>|null
getRecordData()  : array<string|int, string>|null
parse()  : self

Properties

$errors

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

$exthRecords

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

$palmRecords

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

Methods

get()

public get(int $record[, bool $asArray = false ]) : array<string|int, mixed>|string|null
Parameters
$record : int
$asArray : bool = false
Return values
array<string|int, mixed>|string|null

getErrors()

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

isValid()

public isValid() : bool
Return values
bool

make()

public static make(string $path) : self|null
Parameters
$path : string
Return values
self|null

__construct()

protected __construct(Stream $stream[, array<string|int, string> $errors = [] ][, array<string|int, PalmRecord$palmRecords = [] ][, array<string|int, ExthRecord$exthRecords = [] ][, PalmDOCHeader|null $palmDOCHeader = null ][, MobiHeader|null $mobiHeader = null ][, ExthHeader|null $exthHeader = null ][, MobiImages|null $images = null ][, bool $isValid = false ]) : mixed
Parameters
$stream : Stream
$errors : array<string|int, string> = []
$palmRecords : array<string|int, PalmRecord> = []
$exthRecords : array<string|int, ExthRecord> = []
$palmDOCHeader : PalmDOCHeader|null = null
$mobiHeader : MobiHeader|null = null
$exthHeader : ExthHeader|null = null
$images : MobiImages|null = null
$isValid : bool = false

getRecord()

private getRecord(int $type) : array<string|int, ExthRecord>|null
Parameters
$type : int
Return values
array<string|int, ExthRecord>|null

getRecordData()

private getRecordData(int $type) : array<string|int, string>|null
Parameters
$type : int
Return values
array<string|int, string>|null

parse()

private parse() : self
Return values
self

        
On this page

Search results