https://github.com/visavi/librator

Class text library to read and process text from a file by pages
https://github.com/visavi/librator

Last synced: 12 months ago
JSON representation

Class text library to read and process text from a file by pages

• Host: GitHub
• URL: https://github.com/visavi/librator
• Owner: visavi
• Created: 2015-10-29T12:53:29.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-06-27T07:12:12.000Z (about 10 years ago)
• Last Synced: 2025-03-21T04:43:07.137Z (over 1 year ago)
• Language: PHP
• Homepage: http://visavi.net
• Size: 25.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# Class text library to read and process text from a file by pages

[![Latest Stable Version](https://poser.pugx.org/visavi/librator/v/stable)](https://packagist.org/packages/visavi/librator)

[![Total Downloads](https://poser.pugx.org/visavi/librator/downloads)](https://packagist.org/packages/visavi/librator)

[![Latest Unstable Version](https://poser.pugx.org/visavi/librator/v/unstable)](https://packagist.org/packages/visavi/librator)

[![License](https://poser.pugx.org/visavi/librator/license)](https://packagist.org/packages/visavi/librator)

Basic useful feature list:

 * Reading text files

 * A breakdown of the text on page

 * Splits text based on the number of lines, number of words and characters to choose from

 * Beautiful displays pages, with the ability to jump to the last and first page

 * Automatic output of the header text from the first row

 * The output of the current page

### Example of use

```php

read(20);

// Or split the file by the number of words

$librator->read(300, 'words');

// Or split the file by the number of characters

$librator->read(2000, 'chars');

// Get current page

$librator->currentPage();

// Automatic output of the header text from the first row

$librator->getTitle();

```

### Installing

```

composer require visavi/librator

```

### License

The class is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)