2017 © Pedro Peláez
 

library phpepub

Package to create and stream e-books in the ePub 2.0 and 3.0 formats.

image

grandt/phpepub

Package to create and stream e-books in the ePub 2.0 and 3.0 formats.

  • Wednesday, March 16, 2016
  • by Grandt
  • Repository
  • 26 Watchers
  • 199 Stars
  • 35,157 Installations
  • PHP
  • 2 Dependents
  • 0 Suggesters
  • 55 Forks
  • 19 Open issues
  • 13 Versions
  • 5 % Grown

The README.md

PHP ePub generator

PHPePub allows a php script to generate ePub Electronic books on the fly, and send them to the user as downloads., (*1)

PHPePub support most of the ePub 2.01 specification, and enough of the new ePub3 specification to make valid ePub 3 books as well., (*2)

The projects is also hosted on PHPClasses.org at the addresses: http://www.phpclasses.org/package/6115, (*3)

PHPePub is meant to be easy to use for small projects, and still allow for comples and complete e-books should the need arise., (*4)

The Zip.php class in this project originates from http://www.phpclasses.org/package/6110, (*5)

or on Github: git://github.com/Grandt/PHPZip.git, (*6)

See the examples for example usage. The php files have "some" doumentation in them in the form of Javadoc style function headers., (*7)

Installation

Import

Add this requirement to your composer.json file:, (*8)

    "grandt/phpepub": ">=4.0.3"

Composer

If you already have Composer installed, skip this part., (*9)

Packagist, the main composer repository has a neat and very short guide. Or you can look at the guide at the Composer site., (*10)

The easiest for first time users, is to have the composer installed in the same directory as your composer.json file, though there are better options., (*11)

Run this from the command line:, (*12)

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

This will check your PHP installation, and download the composer.phar, which is the composer binary. This file is not needed on the server though., (*13)

Once composer is installed you can create the composer.json file to import this package., (*14)

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

Followed by telling Composer to install the dependencies., (*15)

php composer.phar install

this will download and place all dependencies defined in your composer.json file in the vendor directory., (*16)

Finally, you include the autoload.php file in the new vendor directory., (*17)

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

TODO:

  • The goal being to encompass the majority of the features in the ePub 2.0 and 3.0 specifications, except the Daisy type files.
  • Add better handling of Reference structures.
  • Improve handling of media types and linked files.
  • A/V content is allowed, but definitely not recommended, and MUST have a fallback chain ending in a valid file. If no such chain is provided, the content should not be added.
  • Documentation, no one reads it, but everyone complains if it is missing.
  • Better examples to fully cover the capabilities of the EPub classes.
  • more TODO's.

The Versions

16/03 2016

dev-master

9999999-dev https://github.com/Grandt/PHPZip

Package to create and stream e-books in the ePub 2.0 and 3.0 formats.

  Sources   Download

LGPL-2.1

The Requires

 

epub e-book

16/03 2016

4.0.7.1

4.0.7.1 https://github.com/Grandt/PHPZip

Package to create and stream e-books in the ePub 2.0 and 3.0 formats.

  Sources   Download

LGPL-2.1

The Requires

 

epub e-book

16/03 2016

4.0.7

4.0.7.0 https://github.com/Grandt/PHPZip

Package to create and stream e-books in the ePub 2.0 and 3.0 formats.

  Sources   Download

LGPL-2.1

The Requires

 

epub e-book

08/03 2016

v4.0.6

4.0.6.0 https://github.com/Grandt/PHPZip

Package to create and stream e-books in the ePub 2.0 and 3.0 formats.

  Sources   Download

LGPL-2.1

The Requires

 

epub e-book

13/10 2015

3.30.x-dev

3.30.9999999.9999999-dev

  Sources   Download

The Requires

 

15/09 2015

4.0.3

4.0.3.0 https://github.com/Grandt/PHPZip

Package to create and stream e-books in the ePub 2.0 and 3.0 formats.

  Sources   Download

LGPL-2.1

The Requires

 

epub e-book

15/09 2015

4.0.2

4.0.2.0 https://github.com/Grandt/PHPZip

Package to create and stream e-books in the ePub 2.0 and 3.0 formats.

  Sources   Download

LGPL-2.1

The Requires

 

epub e-book

02/07 2015

4.0.1

4.0.1.0 https://github.com/Grandt/PHPZip

Package to create and stream e-books in the ePub 2.0 and 3.0 formats.

  Sources   Download

LGPL-2.1

The Requires

 

epub e-book

14/05 2015

4.0.0

4.0.0.0 https://github.com/Grandt/PHPZip

Package to create and stream e-books in the ePub 2.0 and 3.0 formats.

  Sources   Download

LGPL-2.1

The Requires

 

epub e-book

14/05 2015

4.0.0.x-dev

4.0.0.9999999-dev https://github.com/Grandt/PHPZip

Package to create and stream e-books in the ePub 2.0 and 3.0 formats.

  Sources   Download

LGPL-2.1

The Requires

 

epub e-book

18/01 2014

3.21.x-dev

3.21.9999999.9999999-dev

  Sources   Download

The Requires

 

29/12 2013

3.20.x-dev

3.20.9999999.9999999-dev

  Sources   Download

The Requires

 

01/12 2013

3.10.x-dev

3.10.9999999.9999999-dev

  Sources   Download

The Requires