Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/pdf-to-text
Extract text from a pdf
https://github.com/spatie/pdf-to-text
pdf pdf-converter php text
Last synced: about 2 months ago
JSON representation
Extract text from a pdf
- Host: GitHub
- URL: https://github.com/spatie/pdf-to-text
- Owner: spatie
- License: mit
- Created: 2015-12-31T10:28:39.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-12-14T09:46:19.000Z (9 months ago)
- Last Synced: 2024-05-01T11:46:09.776Z (5 months ago)
- Topics: pdf, pdf-converter, php, text
- Language: PHP
- Homepage: https://freek.dev/348-a-package-to-extract-text-from-a-pdf
- Size: 117 KB
- Stars: 766
- Watchers: 20
- Forks: 118
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-pdf - pdf-to-text
README
# Extract text from a pdf
[](https://packagist.org/packages/spatie/pdf-to-text)
[](LICENSE.md)
[](https://scrutinizer-ci.com/g/spatie/pdf-to-text)
[](https://packagist.org/packages/spatie/pdf-to-text)
This package provides a class to extract text from a pdf.
```php
use Spatie\PdfToText\Pdf;
echo Pdf::getText('book.pdf'); //returns the text from the pdf
```
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).
## Support us
[
](https://spatie.be/github-ad-click/pdf-to-text)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Requirements
Behind the scenes this package leverages [pdftotext](https://en.wikipedia.org/wiki/Pdftotext). You can verify if the binary installed on your system by issueing this command:
```bash
which pdftotext
```
If it is installed it will return the path to the binary.
To install the binary you can use this command on Ubuntu or Debian:
```bash
apt-get install poppler-utils
```
On a mac you can install the binary using brew
```bash
brew install poppler
```
If you're on RedHat, CentOS, Rocky Linux or Fedora use this:
```bash
yum install poppler-utils
```
## Installation
You can install the package via composer:
```bash
composer require spatie/pdf-to-text
```
## Usage
Extracting text from a pdf is easy.
```php
$text = (new Pdf())
->setPdf('book.pdf')
->text();
```
Or easier:
```php
echo Pdf::getText('book.pdf');
```
By default the package will assume that the `pdftotext` command is located at `/usr/bin/pdftotext`.
If it is located elsewhere pass its binary path to constructor
```php
$text = (new Pdf('/custom/path/to/pdftotext'))
->setPdf('book.pdf')
->text();
```
or as the second parameter to the `getText` static method:
```php
echo Pdf::getText('book.pdf', '/custom/path/to/pdftotext');
```
Sometimes you may want to use [pdftotext options](https://linux.die.net/man/1/pdftotext). To do so you can set them up using the `setOptions` method.
```php
$text = (new Pdf())
->setPdf('table.pdf')
->setOptions(['layout', 'r 96'])
->text()
;
```
or as the third parameter to the `getText` static method:
```php
echo Pdf::getText('book.pdf', null, ['layout', 'opw myP1$$Word']);
```
Please note that successive calls to `setOptions()` will overwrite options passed in during previous calls.
If you need to make multiple calls to add options (for example if you need to pass in default options when creating
the `Pdf` object from a container, and then add context-specific options elsewhere), you can use the `addOptions()` method:
```php
$text = (new Pdf())
->setPdf('table.pdf')
->setOptions(['layout', 'r 96'])
->addOptions(['f 1'])
->text()
;
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information about what has changed recently.
## Testing
```bash
composer test
```
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security
If you've found a bug regarding security please mail [[email protected]](mailto:[email protected]) instead of using the issue tracker.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
## About Spatie
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.