用于创建和流式传输 ePub 2.0 和 3.0 格式电子书的包。

4.1.2 2020-04-29 16:18 UTC

README

PHPePub 允许 PHP 脚本动态生成 ePub 电子书,并将其作为下载发送给用户。

PHPePub 支持大多数 ePub 2.01 规范,以及足够的 ePub3 规范,以便生成有效的 ePub 3 书籍。

该项目还托管在 PHPClasses.org,地址为: http://www.phpclasses.org/package/6115

PHPePub 设计得易于使用,适用于小型项目,同时在需要时也允许创建复杂和完整的电子书。

此项目中的 Zip.php 类来源于 http://www.phpclasses.org/package/6110

或 Github:git://github.com/Grandt/PHPZip.git

请查看示例以了解用法。PHP 文件中包含“一些”文档,以 Javadoc 风格的函数头部形式存在。

安装

导入

将此要求添加到您的 composer.json 文件中

    "grandt/phpepub": ">=4.0.3"

Composer

如果您已经安装了 Composer,请跳过此部分。

Packagist,主要 Composer 存储库有一个简洁且非常短的指南。或者您可以在 Composer 网站 上查看指南。

对于初学者来说,最简单的方法是将 composer 安装在与您的 composer.json 文件相同的目录中,尽管还有更好的选择。

从命令行运行以下内容

php -r "readfile('https://getcomposer.org.cn/installer');" | php

这将检查您的 PHP 安装,并下载 composer.phar,这是 composer 二进制文件。尽管如此,此文件在服务器上并不需要。

一旦安装了 composer,您就可以创建 composer.json 文件以导入此包。

{
    "require": {
        "grandt/phpepub": ">=4.0.3",
        "php": ">=5.3.0"
    }
}

然后告诉 Composer 安装依赖项。

php composer.phar install

这将下载并将您在 composer.json 文件中定义的所有依赖项放置在 vendor 目录中。

最后,您需要在新的 vendor 目录中包含 autoload.php 文件。

<?php
    require 'vendor/autoload.php';
    .
    .
    .

TODO

  • 目标是在不包含 Daisy 类型文件的情况下,包含 ePub 2.0 和 3.0 规范的大多数功能。
  • 添加更好的 Reference 结构处理。
  • 改进媒体类型和链接文件的处理。
  • A/V 内容是允许的,但绝对不推荐,并且必须有一个以有效文件结束的回退链。如果没有提供此类链,则不应添加内容。
  • 文档,没有人阅读它,但每个人都抱怨它缺失。
  • 提供更好的示例,以全面覆盖 EPub 类的功能。
  • 更多的 TODO。