README

EPub生成器是一个强大的PHP库，用于创建EPub书籍。它提供了一套全面的特性和直观的API，轻松生成EPub文件。无论您是作家、出版社还是开发者，这个库都将简化创建EPub书籍的过程，并帮助您向读者提供高质量的内容。

特性

• 从头创建EPub书籍
• 设置书籍元数据，如标题、作者和语言
• 添加章节，自定义标题、内容和顺序
• 删除、更新和重新排列章节
• 将EPub书籍导出为标准EPub文件
• 解析EPub文件并检索书籍信息

需求

• PHP 7.4或更高版本
• XMLWriter扩展
• Zip扩展

安装

您可以通过composer安装此包

composer require tregor/epub

用法

创建新的EPub书籍

要创建新的EPub书籍，您需要实例化EPubBook类并提供书籍的标题

use tregor\epub\EPubBook;

$book = new EPubBook('My First Book');

解析现有的EPub书籍

您还可以解析现有的EPub书籍并检索其信息。为此，请使用open方法

$book = EPubBook::open('existing_book.epub');

设置书籍元数据

您可以使用setAuthor和setLanguage方法设置书籍的作者和语言

$book->setAuthor('John Doe');
$book->setLanguage('en');

添加章节

您可以使用addChapter方法向书籍添加章节。每个章节都需要标题、内容和顺序

$book->addChapter('Chapter 1', 'This is the first chapter.', 1);
$book->addChapter('Chapter 2', 'This is the second chapter.', 2);

重新排列章节

您可以通过指定现有章节的顺序、新章节的标题和内容以及新顺序，在现有章节之后添加新章节

$book->addChapterAfter(1, 'Chapter 2', 'This is the new Chapter 2.', 2);

删除章节

要删除书籍中的章节，请指定其顺序

$book->removeChapter(2);

更新章节

您可以通过指定顺序和提供新内容来更新章节的内容

$book->setChapterContent(1, 'This is the updated content of Chapter 1.');

导出EPub书籍

一旦添加了所有章节，您就可以使用export方法将EPub书籍导出为文件

$book->export('my_first_book.epub');

可用方法

以下是EPubBook类提供的可用方法

• __construct($title)：使用指定的标题创建新的EPubBook对象。
• addChapter($title, $content, $order)：向书籍添加新章节，指定标题、内容和顺序。
• removeChapter($order)：从书籍中删除指定顺序的章节。
• addChapterAfter($order, $title, $content, $newOrder)：在指定顺序的现有章节之后添加新章节，指定顺序、标题、内容和新的顺序。
• getChapterContent($order)：检索指定顺序的章节内容。
• setChapterContent($order, $content)：更新指定顺序的章节内容。
• export($filename)：将书籍导出为指定文件名的EPub文件。
• getTitle()：检索书籍的标题。
• setTitle($title)：设置书籍的标题。
• getAuthor()：检索书籍的作者。
• setAuthor($author)：设置书籍的作者。
• getLanguage()：检索书籍的语言。
• setLanguage($language)：设置书籍的语言。

待办事项

以下是我们在未来版本中计划实现的功能列表

• 支持添加目录
• 支持添加封面图片
• 支持添加其他元数据
• 改进错误处理和异常处理

许可

EPub生成器是专有软件。有关更多信息，请参阅许可文件。

贡献

欢迎贡献力量！如果您有任何想法、建议或错误报告，请打开一个问题或提交一个拉取请求。

致谢

EPub生成库由tregor开发和维护。

关键词

EPub, EPub生成器, PHP, 库, EPub书籍, EPub格式, EPub文件, EPub创建, EPub解析器, EPub编写器, EPub库, EPub PHP库, EPub生成器 PHP, EPub生成器库, EPub生成器 PHP库, EPub生成器示例, EPub生成器使用方法, EPub生成器文档, EPub生成器教程, EPub生成器指南, EPub生成器特性, EPub生成器需求, EPub生成器安装, EPub生成器API, EPub生成器方法, EPub生成器待办事项, EPub生成器许可, EPub生成器贡献者, EPub生成器致谢