README

Ashei is a epub parser that allows you to get epub books content.

Installation

Clone latest release via cURL.

composer require hans-thomas/ashei

then, publish config file.

php artisan vendor:publish --tag ashei-config

Usage

read

To get whole content at once.

use Hans\Ashei\Facades\Ashei;

Ashei::read( '/path/to/ebook.epub' );

It will return an array like this.

iterator

To get a large epub file's content, you can use iterator method to get one limited part of the epub file in each iteration.

use Hans\Ashei\Facades\Ashei;

foreach ( Ashei::iterator( '/path/to/ebook.epub' ) as $number => $page ) {
    // ...
}

setParagraphLength

Before getting content, you can set your idle paragraph length using setParagraphLength method. the default amount is 2000.

use Hans\Ashei\Facades\Ashei;

Ashei::setParagraphLength( 50 )->read( '/path/to/ebook.epub' );

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request ❤️

Support

• Report bugs