indy2kro/php-epub

A PHP library for processing EPUB files.

1.0.0 2025-02-08 09:23 UTC

Requires

• php: >=8.2
• ext-xml: *
• ext-zip: *

Requires (Dev)

• ext-curl: *
• ext-dom: *
• ext-gd: *
• ext-json: *
• ext-mbstring: *
• dompdf/dompdf: ^3.1
• nunomaduro/phpinsights: ^2
• phpstan/phpstan: ^2
• phpstan/phpstan-phpunit: ^2
• phpunit/phpunit: ^11
• rector/rector: ^2
• squizlabs/php_codesniffer: >=3.7
• tecnickcom/tcpdf: ^6.8

Suggests

• dompdf/dompdf: Required for PDF generation using Dompdf.
• tecnickcom/tcpdf: Required for PDF generation using TCPDF.

GPL-2.0

• library
• epub

README

PHP EPUB Processor

A PHP library for processing EPUB files, including parsing, metadata manipulation, and format conversion. This library provides tools to handle EPUB files efficiently, offering features like validation, content management, and conversion to other formats using various adapters.

• Documentation

Features

• EPUB Loading and Saving: Easily load and save EPUB files.
• Metadata Management: Read and update metadata such as title, authors, and language.
• Content Management: Add, update, and delete content files within an EPUB.
• Validation: Validate the structure and content of EPUB files.
• Conversion: Convert EPUB files to PDF and other formats using adapters for TCPDF, Dompdf, and Calibre.

Installation

To install the library, use Composer:

composer require indy2kro/php-epub

Ensure that you have the necessary PHP extensions and optional libraries installed for full functionality:

• Required: ext-xml, ext-zip
• Optional: dompdf/dompdf, tecnickcom/tcpdf for PDF conversion, Calibre for mobi conversion

Usage

Loading an EPUB File:

use PhpEpub\EpubFile;

$epubFile = new EpubFile('/path/to/your.epub');
$epubFile->load();

Converting to PDF

Using TCPDF:

use PhpEpub\Converters\TCPDFAdapter;

$adapter = new TCPDFAdapter();
$adapter->convert('/path/to/extracted/epub', '/path/to/output.pdf');

Managing Metadata

use PhpEpub\Metadata;
use PhpEpub\EpubFile;

$epubFilePath = '/path/to/your.epub';

$epubFile = new EpubFile($epubFilePath);
$epubFile->load();

$metadata = $epubFile->getMetadata();
$title = $metadata->getTitle();
$metadata->setTitle('New Title');
$metadata->save();

$epubFile->save();

Code Quality

To maintain high standards of code quality, this project uses several tools:

• PHP CodeSniffer (PHPCS): Ensures your code adheres to a set of coding standards. Check the code with:

vendor/bin/phpcs

• PHPStan: A static analysis tool for finding bugs in your code. Run it using:

vendor/bin/phpstan

• Rector: A tool for automated code refactoring. Use it to apply coding standards and upgrade code:

vendor/bin/rector

Testing

To run the tests, use PHPUnit:

vendor/bin/phpunit