grandt/phpepub

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

4.0.7.1 2016-03-16 15:48 UTC

README

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

PHPePub 支持ePub 2.01的大部分规范,以及足够的ePub 3规范,可以生成有效的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

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