tocCSSClass)) {
- $tocData .= " class=\"" . $this->tocCSSClass . "\"";
+ $tocData .= ' class="' . $this->tocCSSClass . '"';
}
+
$tocData .= ">\n";
foreach ($this->referencesOrder as $item => $descriptive) {
@@ -2220,24 +2280,19 @@ private function finalizeTOC()
$level = $navPoint->getLevel() - 2;
$tocData .= "\t"
/* . str_repeat(" ", $level) . */
- . "" . $chapterName . "
\n";
+ . '' . $chapterName . "\n";
}
- } else {
- if ($this->tocAddReferences === true) {
- if (array_key_exists($item, $this->ncx->referencesList)) {
- $tocData .= "\tncx->referencesList[$item] . "\">" . $descriptive . "
\n";
- } else {
- if ($item === "toc") {
- $tocData .= "\t" . $this->tocTitle . "
\n";
- } else {
- if ($item === "cover" && $this->isCoverImageSet) {
- $tocData .= "\t" . $descriptive . "
\n";
- }
- }
- }
+ } elseif ($this->tocAddReferences) {
+ if (array_key_exists($item, $this->ncx->referencesList)) {
+ $tocData .= "\tncx->referencesList[$item] . '">' . $descriptive . "
\n";
+ } elseif ($item === "toc") {
+ $tocData .= "\t" . $this->tocTitle . "
\n";
+ } elseif ($item === "cover" && $this->isCoverImageSet) {
+ $tocData .= "\t" . $descriptive . "
\n";
}
}
}
+
$tocData .= "\n\n\n";
$this->addReferencePage($this->tocTitle, $this->tocFileName, $tocData, Reference::TABLE_OF_CONTENTS);
@@ -2248,14 +2303,13 @@ private function finalizeTOC()
/**
* @param string $fileName
* @param string $tocData
- *
- * @return bool
*/
- public function addEPub3TOC($fileName, $tocData)
+ public function addEPub3TOC($fileName, $tocData): bool
{
if ($this->isEPubVersion2() || $this->isFinalized || array_key_exists($fileName, $this->fileList)) {
return false;
}
+
if (!$this->isInitialized) {
$this->initialize();
}
@@ -2274,10 +2328,8 @@ public function addEPub3TOC($fileName, $tocData)
/**
* @param string $cssFileName
* @param string $title
- *
- * @return string
*/
- public function buildEPub3TOC($cssFileName = null, $title = "Table of Contents")
+ public function buildEPub3TOC($cssFileName = null, $title = "Table of Contents"): string
{
$this->ncx->referencesOrder = $this->referencesOrder;
$this->ncx->setDocTitle(StringHelper::decodeHtmlEntities($this->title));
@@ -2324,13 +2376,13 @@ public function getBookSize()
*
* @return string|bool The sent file name if successful, FALSE if it failed.
*/
- public function sendBook($fileName)
+ public function sendBook(string $fileName): string|bool
{
if (!$this->isFinalized) {
$this->finalize();
}
- if (!BinStringStatic::endsWith($fileName, ".epub")) {
+ if (!str_ends_with($fileName, ".epub")) {
$fileName .= ".epub";
}
@@ -2348,7 +2400,7 @@ public function sendBook($fileName)
*
* @return array file list
*/
- public function getFileList()
+ public function getFileList(): array
{
return $this->fileList;
}
@@ -2358,10 +2410,8 @@ public function getFileList()
* Default is 250000 bytes, and minimum is 10240 bytes.
*
* @param int $size segment size in bytes
- *
- * @return void
*/
- public function setSplitSize($size)
+ public function setSplitSize($size): void
{
$this->splitDefaultSize = (int)$size;
if ($size < 10240) {
@@ -2379,10 +2429,7 @@ public function getSplitSize()
return $this->splitDefaultSize;
}
- /**
- * @return string
- */
- public function getLog()
+ public function getLog(): string
{
return $this->log->getLog();
}
@@ -2396,16 +2443,18 @@ public function getLog()
* @param int|string $width integer for the width, or a string referencing an entry in the $viewportMap.
* @param int $height
*/
- public function setViewport($width = null, $height = null)
+ public function setViewport($width = null, $height = null): void
{
if ($width == null) {
unset($this->viewport);
}
+
if (is_string($width) && in_array($width, $this->viewportMap)) {
$vp = $this->viewportMap[$width];
$width = $vp['width'];
$height = $vp['height'];
}
+
$this->viewport = ['width' => $width, 'height' => $height];
}
@@ -2414,9 +2463,21 @@ public function setViewport($width = null, $height = null)
*
* @return string the meta data line, or an empty string if no viewport is defined.
*/
- public function getViewportMetaLine()
+ public function getViewportMetaLine(): string
{
- if (empty($this->viewport)) {
+ if (is_null($this->viewport)) {
+ return "";
+ }
+
+ if ($this->viewport === []) {
+ return "";
+ }
+
+ if (!array_key_exists("width", $this->viewport)) {
+ return "";
+ }
+
+ if (!array_key_exists("height", $this->viewport)) {
return "";
}
@@ -2431,7 +2492,7 @@ public function getViewportMetaLine()
*
* @param bool $dangermode
*/
- public function setDangermode($dangermode)
+ public function setDangermode($dangermode): void
{
$this->dangermode = $dangermode === true;
}
@@ -2441,7 +2502,7 @@ public function setDangermode($dangermode)
*
* @return null|Opf the Opf structure class.
*/
- public function DANGER_getOpf()
+ public function DANGER_getOpf(): ?\PHPePub\Core\Structure\Opf
{
return $this->dangermode ? $this->opf : null;
}
@@ -2451,7 +2512,7 @@ public function DANGER_getOpf()
*
* @return null|Ncx The Ncx Navigation class
*/
- public function DANGER_getNcx()
+ public function DANGER_getNcx(): ?\PHPePub\Core\Structure\Ncx
{
return $this->dangermode ? $this->ncx : null;
}
@@ -2465,7 +2526,7 @@ public function DANGER_getNcx()
*
* @return null|Zip The actual zip file.
*/
- public function DANGER_getZip()
+ public function DANGER_getZip(): ?\PHPZip\Zip\File\Zip
{
return $this->dangermode ? $this->zip : null;
}
diff --git a/src/PHPePub/Core/EPubChapterSplitter.php b/src/PHPePub/Core/EPubChapterSplitter.php
index 6d6164b..23f1065 100644
--- a/src/PHPePub/Core/EPubChapterSplitter.php
+++ b/src/PHPePub/Core/EPubChapterSplitter.php
@@ -18,8 +18,10 @@
*/
class EPubChapterSplitter
{
- private $splitDefaultSize = 250000;
- private $bookVersion = EPub::BOOK_VERSION_EPUB2;
+ private int $splitDefaultSize = 250000;
+
+ private string $bookVersion = EPub::BOOK_VERSION_EPUB2;
+
private $htmlFormat = EPub::FORMAT_XHTML;
/**
@@ -38,7 +40,7 @@ public function __construct($htmlFormat = EPub::FORMAT_XHTML)
*
* @param string $bookVersion
*/
- public function setVersion($bookVersion)
+ public function setVersion($bookVersion): void
{
$this->bookVersion = is_string($bookVersion) ? trim($bookVersion) : EPub::BOOK_VERSION_EPUB2;
}
@@ -48,7 +50,7 @@ public function setVersion($bookVersion)
*
* @param string $htmlFormat
*/
- public function setHtmlFormat($htmlFormat)
+ public function setHtmlFormat($htmlFormat): void
{
$this->htmlFormat = in_array($htmlFormat, [EPub::FORMAT_XHTML, EPub::FORMAT_HTML5])
? $htmlFormat
@@ -60,10 +62,8 @@ public function setHtmlFormat($htmlFormat)
* Default is 250000 bytes, and minimum is 10240 bytes.
*
* @param int $size segment size in bytes
- *
- * @return void
*/
- public function setSplitSize($size)
+ public function setSplitSize($size): void
{
$this->splitDefaultSize = (int)$size;
if ($size < 10240) {
@@ -76,7 +76,7 @@ public function setSplitSize($size)
*
* @return int $size
*/
- public function getSplitSize()
+ public function getSplitSize(): int
{
return $this->splitDefaultSize;
}
@@ -93,7 +93,7 @@ public function getSplitSize()
*
* @return array with 1 or more parts
*/
- public function splitChapter($chapter, $splitOnSearchString = false, $searchString = '/^Chapter\\ /i')
+ public function splitChapter($chapter, $splitOnSearchString = false, $searchString = '/^Chapter\\ /i'): array
{
$chapterData = [];
$isSearchRegexp = $splitOnSearchString && (preg_match('#^(\D|\S|\W).+\1[imsxeADSUXJu]*$#m', $searchString) == 1);
@@ -126,6 +126,7 @@ public function splitChapter($chapter, $splitOnSearchString = false, $searchStri
if (!str_contains(trim($newXML), "\n" . $newXML;
}
+
$headerLength = strlen($newXML);
$files = [];
@@ -158,7 +159,7 @@ public function splitChapter($chapter, $splitOnSearchString = false, $searchStri
if ($nodeLen > $partSize && $node->hasChildNodes()) {
$domPath[] = $node;
$domClonedPath[] = $node->cloneNode(false);
- $domDepth++;
+ ++$domDepth;
$node = $node->firstChild;
}
@@ -185,15 +186,17 @@ public function splitChapter($chapter, $splitOnSearchString = false, $searchStri
$curParent = $newParent;
}
}
+
$curSize = strlen($xmlDoc->saveXML($curFile));
}
+
$curParent->appendChild($node->cloneNode(true));
$curSize += $nodeLen;
}
$node = $node2;
while ($node == null && $domDepth > 0) {
- $domDepth--;
+ --$domDepth;
$node = end($domPath)->nextSibling;
array_pop($domPath);
array_pop($domClonedPath);
@@ -201,14 +204,14 @@ public function splitChapter($chapter, $splitOnSearchString = false, $searchStri
}
} while ($node != null);
- $curFile = null;
-
$xml = new DOMDocument('1.0', $xmlDoc->xmlEncoding);
$xml->lookupPrefix("http://www.w3.org/1999/xhtml");
+
$xml->preserveWhiteSpace = false;
$xml->formatOutput = true;
+ $counter = count($files);
- for ($idx = 0; $idx < count($files); $idx++) {
+ for ($idx = 0; $idx < $counter; ++$idx) {
$xml2Doc = new DOMDocument('1.0', $xmlDoc->xmlEncoding);
$xml2Doc->lookupPrefix("http://www.w3.org/1999/xhtml");
$xml2Doc->loadXML($newXML);
diff --git a/src/PHPePub/Core/Logger.php b/src/PHPePub/Core/Logger.php
index 57d660d..4989c69 100644
--- a/src/PHPePub/Core/Logger.php
+++ b/src/PHPePub/Core/Logger.php
@@ -11,11 +11,15 @@
*/
class Logger
{
- private $log = "";
- private $tStart;
+ private string $log = "";
+
+ private array|float|null $tStart = null;
+
private $tLast;
- private $name = null;
- private $isDebugging = false;
+
+ private ?string $name = null;
+
+ private bool $isDebugging = false;
/**
* Class constructor.
@@ -25,15 +29,11 @@ class Logger
*/
public function __construct($name = null, private $isLogging = false)
{
- if ($name === null) {
- $this->name = "";
- } else {
- $this->name = $name . " : ";
- }
+ $this->name = $name === null ? "" : $name . " : ";
$this->start();
}
- public function start()
+ public function start(): void
{
/* Prepare Logging. Just in case it's used. later */
if ($this->isLogging) {
@@ -44,7 +44,7 @@ public function start()
}
}
- public function logLine($line)
+ public function logLine(string $line): void
{
if ($this->isLogging) {
$tTemp = gettimeofday();
@@ -73,7 +73,7 @@ public function __destruct()
unset($this->log);
}
- public function dumpInstalledModules()
+ public function dumpInstalledModules(): void
{
if ($this->isLogging) {
$isCurlInstalled = extension_loaded('curl') && function_exists('curl_version');
@@ -90,17 +90,15 @@ public function dumpInstalledModules()
}
}
- public function getLog()
+ public function getLog(): string
{
return $this->log;
}
/**
* @param $isCurlInstalled
- *
- * @return string
*/
- public function boolYN($isCurlInstalled)
+ public function boolYN($isCurlInstalled): string
{
return ($isCurlInstalled ? "Yes" : "No");
}
diff --git a/src/PHPePub/Core/StaticData.php b/src/PHPePub/Core/StaticData.php
index 49b793e..c1d4844 100644
--- a/src/PHPePub/Core/StaticData.php
+++ b/src/PHPePub/Core/StaticData.php
@@ -12,7 +12,7 @@
class StaticData
{
public static $htmlEntities = [
- """ => "\x22",
+ """ => '"',
// " ((double) quotation mark)
"&" => "\x26",
// & (ampersand)
@@ -526,7 +526,7 @@ class StaticData
public static $opsContentTypes = ["application/xhtml+xml", "application/x-dtbook+xml", "application/xml", "application/x-dtbncx+xml", "text/x-oeb1-document"];
- public static $forbiddenCharacters = ["?", "[", "]", "/", "\\", "=", "<", ">", ":", ";", ",", "'", "\"", "&", "$", "#", "*", "(", ")", "|", "~", "`", "!", "{", "}", "%"];
+ public static $forbiddenCharacters = ["?", "[", "]", "/", "\\", "=", "<", ">", ":", ";", ",", "'", '"', "&", "$", "#", "*", "(", ")", "|", "~", "`", "!", "{", "}", "%"];
public static $namespaces = ["xsi" => "http://www.w3.org/2001/XMLSchema-instance", "opf" => "http://www.idpf.org/2007/opf", "dcterms" => "http://purl.org/dc/terms/", "dc" => "http://purl.org/dc/elements/1.1/"];
}
diff --git a/src/PHPePub/Core/Structure/NCX/NavMap.php b/src/PHPePub/Core/Structure/NCX/NavMap.php
index eecbe2d..43dd294 100644
--- a/src/PHPePub/Core/Structure/NCX/NavMap.php
+++ b/src/PHPePub/Core/Structure/NCX/NavMap.php
@@ -13,9 +13,11 @@ class NavMap extends AbstractNavEntry
{
final public const _VERSION = 3.30;
- private $navPoints = [];
- private $navLevels = 0;
- private $writingDirection = null;
+ private array $navPoints = [];
+
+ private int $navLevels = 0;
+
+ private ?string $writingDirection = null;
/**
* Class constructor.
@@ -37,7 +39,7 @@ public function __destruct()
unset($this->navPoints, $this->navLevels, $this->writingDirection);
}
- public function getWritingDirection()
+ public function getWritingDirection(): ?string
{
return $this->writingDirection;
}
@@ -47,7 +49,7 @@ public function getWritingDirection()
*
* @param string $writingDirection
*/
- public function setWritingDirection($writingDirection)
+ public function setWritingDirection($writingDirection): void
{
$this->writingDirection = isset($writingDirection) && is_string($writingDirection) ? trim($writingDirection) : null;
}
@@ -59,13 +61,14 @@ public function setWritingDirection($writingDirection)
*
* @return NavMap
*/
- public function addNavPoint($navPoint)
+ public function addNavPoint($navPoint): \PHPePub\Core\Structure\NCX\NavPoint|static
{
if ($navPoint != null && is_object($navPoint) && $navPoint instanceof NavPoint) {
$navPoint->setParent($this);
if ($navPoint->getWritingDirection() == null) {
$navPoint->setWritingDirection($this->writingDirection);
}
+
$this->navPoints[] = $navPoint;
return $navPoint;
@@ -80,12 +83,12 @@ public function addNavPoint($navPoint)
*
* @return number
*/
- public function getNavLevels()
+ public function getNavLevels(): int|float
{
return $this->navLevels + 1;
}
- public function getLevel()
+ public function getLevel(): int
{
return 1;
}
@@ -93,7 +96,7 @@ public function getLevel()
/**
* @return AbstractNavEntry this
*/
- public function getParent()
+ public function getParent(): static
{
return $this;
}
@@ -102,14 +105,14 @@ public function getParent()
* Finalize the navMap, the final max depth for the "dtb:depth" meta attribute can be retrieved with getNavLevels after finalization
*
*/
- public function finalize()
+ public function finalize(): string
{
$playOrder = 0;
$this->navLevels = 0;
$nav = "\t\n";
- if (count($this->navPoints) > 0) {
- $this->navLevels++;
+ if ($this->navPoints !== []) {
+ ++$this->navLevels;
foreach ($this->navPoints as $navPoint) {
/** @var $navPoint NavPoint */
$retLevel = $navPoint->finalize($nav, $playOrder, 0);
@@ -126,7 +129,7 @@ public function finalize()
* Finalize the navMap, the final max depth for the "dtb:depth" meta attribute can be retrieved with getNavLevels after finalization
*
*/
- public function finalizeEPub3()
+ public function finalizeEPub3(): string
{
$playOrder = 0;
$level = 0;
@@ -134,8 +137,8 @@ public function finalizeEPub3()
$nav = "\t\t