Spatie Pdf To Text

https://github.com/spatie/pdf-to-text
Admin
Spatie Pdf To Text is a PHP package designed to extract textual content from PDF documents...
Tokens:18,822
Snippets:227
Trust Score:10
License:MIT
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Package via Composer

Source: https://github.com/spatie/pdf-to-text/blob/main/README.md

Install the spatie/pdf-to-text package using Composer.

```bash
composer require spatie/pdf-to-text
```

--------------------------------

### Install pdftotext on RedHat/CentOS/Fedora

Source: https://github.com/spatie/pdf-to-text/blob/main/README.md

Install the poppler-utils package, which includes pdftotext, on RedHat-based systems.

```bash
yum install poppler-utils
```

--------------------------------

### Example: Append pdftotext Options

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/configuration.md

Shows how to set initial options and then append more options using addOptions, preserving the previously set options.

```php
$pdf = new Pdf();
$pdf->setOptions(['layout']);        
$pdf->addOptions(['f 2', 'l 5']);    
// Result: -layout -f 2 -l 5
```

--------------------------------

### Check pdftotext Installation

Source: https://github.com/spatie/pdf-to-text/blob/main/README.md

Verify if the pdftotext binary is installed on your system by checking its path.

```bash
which pdftotext
```

--------------------------------

### Example: Set pdftotext Options

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/configuration.md

Demonstrates setting multiple pdftotext command-line options, including layout preservation, resolution, page range, and encoding.

```php
$pdf = new Pdf();
$pdf->setOptions([
    'layout',
    'r 150',
    'f 2',
    'l 10',
    'enc UTF-8'
]);
```

--------------------------------

### Configuration Reference

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/DOCUMENTATION_MANIFEST.txt

A comprehensive guide to configuring the PDF to Text library, including all available options and best practices.

```APIDOC
## Configuration Reference

### Description
Detailed information on all configuration parameters available for the PDF to Text library, covering constructor parameters, method configuration, and `pdftotext` options.

### Configuration Areas

#### Constructor Parameters
- Lists and describes parameters accepted by the `Pdf` class constructor.

#### Method Configuration Parameters
- Details parameters that can be passed to methods like `setOptions()` and `addOptions()`.

#### `pdftotext` Options Table
- An exhaustive table of all available `pdftotext` command-line options that can be configured.

#### Environment Variables
- Describes any relevant environment variables that can influence the library's behavior.

### Best Practices
- Provides recommended configurations based on common use cases.

### Code Examples
- Includes practical code examples demonstrating how to apply various configuration settings.
```

--------------------------------

### Option Parsing Example

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/ARCHITECTURE.md

Demonstrates how the `parseOptions` method transforms an array of option strings into a flat array of individual tokens, ensuring each option is prefixed with a hyphen.

```text
Input: ['layout', 'r 96']
Output: ['-layout', '-r', '96']
```

--------------------------------

### Install pdftotext on Ubuntu/Debian

Source: https://github.com/spatie/pdf-to-text/blob/main/README.md

Install the poppler-utils package, which includes pdftotext, on Ubuntu or Debian-based systems.

```bash
apt-get install poppler-utils
```

--------------------------------

### Install pdftotext on macOS

Source: https://github.com/spatie/pdf-to-text/blob/main/README.md

Install the poppler package, which includes pdftotext, on macOS using Homebrew.

```bash
brew install poppler
```

--------------------------------

### Handling Binary Not Found Exception

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/DOCUMENTATION_MANIFEST.txt

Provides an example of how to catch the `BinaryNotFoundException` which is thrown when the pdftotext executable cannot be found. This ensures your application can gracefully handle missing dependencies.

```php
use Spatie\PdfToText\Exceptions\BinaryNotFoundException;
use Spatie\PdfToText\Pdf;

try {
    $text = (new Pdf("/path/to/your/document.pdf"))->text();
} catch (BinaryNotFoundException $e) {
    // Handle the exception, e.g., by logging an error or informing the user
    echo "Error: pdftotext binary not found.";
}
```

--------------------------------

### Example: Set Process Timeout

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/configuration.md

Example of setting a custom timeout for processing large PDF documents, in this case, 5 minutes (300 seconds).

```php
$pdf = new Pdf();
$pdf->setTimeout(300);  
// 5 minute timeout for large documents
```

--------------------------------

### Debug CouldNotExtractText with Exit Codes

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Exceptions.md

Provides an example of debugging CouldNotExtractText by inspecting the exit code of the underlying process to identify specific error causes.

```php
use Spatie\PdfToText\Exceptions\CouldNotExtractText;

try {
    Pdf::getText('document.pdf');
} catch (CouldNotExtractText $e) {
    $process = $e->getProcess();
    
    if ($process->getExitCode() === 1) {
        // Likely a bad PDF or wrong password
        error_log("Bad PDF: " . $process->getErrorOutput());
    } elseif ($process->getExitCode() === 2) {
        // Likely missing file or permission error
        error_log("Access error: " . $process->getErrorOutput());
    } else {
        // Other pdftotext errors
        error_log("pdftotext error: " . $process->getErrorOutput());
    }
}
```

--------------------------------

### Handle Common CouldNotExtractText Causes

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/errors.md

Provides examples for handling common causes of CouldNotExtractText, such as timeouts by retrying with a longer timeout, or invalid passwords/corrupted files by inspecting process error output.

```php
use Spatie\PdfToText\Pdf;
use Spatie\PdfToText\Exceptions\CouldNotExtractText;

try {
    $text = Pdf::getText('large-file.pdf');
} catch (CouldNotExtractText $e) {
    // Might be timeout - retry with longer timeout
    $text = Pdf::getText('large-file.pdf', null, [], 300);
}

try {
    $text = Pdf::getText('document.pdf', null, ['-opw', 'password']);
} catch (CouldNotExtractText $e) {
    // Might be invalid password or corrupted file
    // Access the process for error details
    $process = $e->getProcess();
    if ($process->getExitCode() !== 0) {
        echo "pdftotext error: " . $process->getErrorOutput();
    }
}
```

--------------------------------

### Getting Text via Static Method

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/DOCUMENTATION_MANIFEST.txt

Demonstrates the static `getText` method for a quick way to extract text from a PDF without instantiating the Pdf class. This is a convenience method for simple extractions.

```php
use Spatie\PdfToText\Pdf;

$text = Pdf::getText("/path/to/your/document.pdf");

echo $text;
```

--------------------------------

### Append pdftotext Options

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/configuration.md

Append additional pdftotext options to the existing configuration without overwriting them. This is useful for adding specific options after initial setup.

```php
public function addOptions(array $options): self
```

--------------------------------

### Catch CouldNotExtractText Exception

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/errors.md

Demonstrates catching CouldNotExtractText when the pdftotext command fails, for example, due to invalid options. It shows how to access the underlying Symfony Process object for error details.

```php
use Spatie\PdfToText\Pdf;
use Spatie\PdfToText\Exceptions\CouldNotExtractText;

try {
    $text = (new Pdf())
        ->setPdf('document.pdf')
        ->setOptions(['-invalid-option'])
        ->text();
} catch (CouldNotExtractText $e) {
    echo "Text extraction failed: " . $e->getMessage();
    
    // Access the underlying Symfony Process for more details
    $process = $e->getProcess();
    echo "Exit code: " . $process->getExitCode();
    echo "Error output: " . $process->getErrorOutput();
}
```

--------------------------------

### Handling Could Not Extract Text Exception

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/DOCUMENTATION_MANIFEST.txt

Demonstrates catching the `CouldNotExtractText` exception, which is thrown when the pdftotext process fails. This example shows how to access the underlying process's error output for debugging.

```php
use Spatie\PdfToText\Exceptions\CouldNotExtractText;
use Spatie\PdfToText\Pdf;

try {
    $text = (new Pdf("/path/to/corrupted/document.pdf"))->text();
} catch (CouldNotExtractText $e) {
    // Access the error output from the underlying process
    $errorOutput = $e->getProcessErrorOutput();
    echo "Error extracting text: " . $errorOutput;
}
```

--------------------------------

### Combine Multiple pdftotext Options (Append)

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Extracts text from a PDF file by appending new options to the existing set. This example first sets 'layout' and then appends 'r 96' and 'enc UTF-8'.

```php
use Spatie\PdfToText\Pdf;

$text = (new Pdf())
    ->setPdf('document.pdf')
    ->setOptions(['layout'])           // Set initial options
    ->addOptions(['r 96', 'enc UTF-8']) // Append without replacing
    ->text();
```

--------------------------------

### Extracting Page Ranges to Reduce Memory

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

For very large PDFs, extract text page by page to manage memory usage. This example iterates through pages in chunks.

```php
$pdf = new Pdf();
$allText = '';

$totalPages = 1000;
$pagesPerChunk = 100;

for ($i = 1; $i <= $totalPages; $i += $pagesPerChunk) {
    $endPage = min($i + $pagesPerChunk - 1, $totalPages);
    
    $text = $pdf
        ->setPdf('huge-document.pdf')
        ->setOptions(['f ' . $i, 'l ' . $endPage])
        ->text();
    
    $allText .= $text;
}
```

--------------------------------

### Handling PDF Text Extraction Errors

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/README.md

Implement error handling to gracefully manage issues during text extraction. This example catches specific exceptions and outputs error details.

```php
use Spatie\PdfToText\Pdf;
use Spatie\PdfToText\Exceptions\CouldNotExtractText;

try {
    $text = Pdf::getText('document.pdf');
} catch (CouldNotExtractText $e) {
    echo $e->getProcess()->getErrorOutput();
}
```

--------------------------------

### Instantiate Pdf Class

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Pdf.md

Create a new Pdf instance. You can either let it auto-detect the pdftotext binary or provide a custom path.

```php
$pdf = new Pdf();

// Use custom pdftotext location
$pdf = new Pdf('/usr/local/bin/pdftotext');
```

--------------------------------

### Instantiate Pdf with Binary Path

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/configuration.md

Instantiate the Pdf class, optionally providing an explicit path to the pdftotext binary. If not provided, the library attempts to auto-detect it.

```php
public function __construct(?string $binPath = null)
```

--------------------------------

### Configure PDF to Text for Production

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/configuration.md

Instantiate the Pdf class with the path to the pdftotext executable and set PDF file, options, and timeout for production use.

```php
$pdf = new Pdf('/usr/bin/pdftotext');

$text = $pdf
    ->setPdf('document.pdf')
    ->setOptions(['enc UTF-8', 'nopgbrk'])
    ->setTimeout(120)
    ->text();
```

--------------------------------

### Basic Text Extraction

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/REFERENCE.md

Extracts text from a PDF file using the default settings. Ensure the 'pdftotext' binary is installed and accessible.

```php
use Spatie\PdfToText\Pdf;

$text = (new Pdf())
    ->setPdf('document.pdf')
    ->text();
```

--------------------------------

### Instantiate Pdf with BinaryNotFoundException handling

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/REFERENCE.md

Instantiate the Pdf class. Catch BinaryNotFoundException if the pdftotext binary is not found in standard paths.

```php
try {
    new Pdf();
} catch (BinaryNotFoundException $e) {
    // pdftotext not in standard paths
}
```

--------------------------------

### Run Tests

Source: https://github.com/spatie/pdf-to-text/blob/main/README.md

Execute the package's tests using Composer.

```bash
composer test
```

--------------------------------

### Initialize PDF Extractor

Source: https://github.com/spatie/pdf-to-text/blob/main/README.md

Instantiate the Pdf class and set the PDF file to process. This is a more verbose way to extract text.

```php
$text = (new Pdf())
    ->setPdf('book.pdf')
    ->text();
```

--------------------------------

### Pdf Constructor

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Pdf.md

Creates a new Pdf instance and initializes the pdftotext binary path. It can auto-detect the binary or accept a custom path.

```APIDOC
## Constructor Pdf

### Description
Creates a new Pdf instance and initializes the pdftotext binary path. It can auto-detect the binary or accept a custom path.

### Parameters
#### Path Parameters
- **$binPath** (string|null) - Optional - Path to the pdftotext binary. If null, attempts to auto-detect from common installation paths.

### Throws
- `BinaryNotFoundException` - Thrown if the pdftotext binary cannot be found in common installation paths and no explicit path is provided.

### Usage Example
```php
// Auto-detect pdftotext binary
$pdf = new Pdf();

// Use custom pdftotext location
$pdf = new Pdf('/usr/local/bin/pdftotext');
```
```

--------------------------------

### Handle BinaryNotFoundException

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Exceptions.md

Demonstrates how to catch BinaryNotFoundException and provide an explicit path to the pdftotext binary if auto-detection fails.

```php
use Spatie\PdfToText\Pdf;
use Spatie\PdfToText\Exceptions\BinaryNotFoundException;

try {
    $pdf = new Pdf();
} catch (BinaryNotFoundException $e) {
    // Provide explicit path or install pdftotext
    $pdf = new Pdf('/usr/local/bin/pdftotext');
}
```

--------------------------------

### Pdf Class Constructor

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/REFERENCE.md

Initializes the Pdf class. Optionally accepts the path to the pdftotext binary.

```APIDOC
## Pdf Class Constructor

### Description
Initializes the main `Pdf` class for text extraction. You can optionally provide the path to the `pdftotext` executable if it's not in your system's standard PATH.

### Method
```php
public function __construct(?string $binPath = null)
```

### Parameters
#### Path Parameters
- **binPath** (string) - Optional - The absolute path to the `pdftotext` executable.
```

--------------------------------

### Setting PDF file path

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/DOCUMENTATION_MANIFEST.txt

Illustrates how to set the PDF file path using the `setPdf` method. This is an alternative to passing the path directly to the constructor.

```php
use Spatie\PdfToText\Pdf;

$pdf = new Pdf();
$pdf->setPdf("/path/to/your/document.pdf");

$text = $pdf->text();
echo $text;
```

--------------------------------

### Configure pdftotext Options

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/configuration.md

Configure pdftotext command-line options using an array. Options can be specified with or without leading hyphens.

```php
public function setOptions(array $options): self
```

--------------------------------

### Pdf Class Documentation

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/DOCUMENTATION_MANIFEST.txt

Provides detailed documentation for the main Pdf class, including its constructor, methods for setting PDF files and options, and methods for text extraction.

```APIDOC
## Pdf Class

### Description
Complete documentation for the Pdf class, covering its constructor, methods for setting PDF files and options, and text extraction capabilities.

### Methods

#### Constructor
- Initializes a new instance of the Pdf class.

#### `setPdf(string $path)`
- Sets the PDF file to be processed.
- Includes examples of usage.

#### `setOptions(array $options)`
- Sets multiple configuration options for text extraction.

#### `addOptions(array $options)`
- Adds or updates specific configuration options.

#### `setTimeout(int $seconds)`
- Configures the maximum time allowed for the text extraction process.

#### `text(callable $callback = null)`
- Extracts text from the PDF. Supports an optional callback for progress or custom handling.

#### `getText(string $path)`
- A static method to directly get text from a PDF file path without instantiating the class.

### Returns
- Method return values are documented with full signatures.
```

--------------------------------

### Fluent Interface for PDF Text Extraction

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/ARCHITECTURE.md

Demonstrates the fluent interface pattern for configuring and executing PDF text extraction. Methods return self to allow chaining.

```php
(new Pdf())
    ->setPdf('file.pdf')
    ->setOptions(['layout'])
    ->setTimeout(120)
    ->text();
```

--------------------------------

### Set PDF file with PdfNotFound exception handling

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/REFERENCE.md

Set the PDF file to be processed. Catch PdfNotFound if the specified file does not exist or is not readable.

```php
try {
    $pdf->setPdf('missing.pdf');
} catch (PdfNotFound $e) {
    // File doesn't exist or is not readable
}
```

--------------------------------

### Configure Static getText() Method

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/configuration.md

Utilize the static getText() method to configure all parameters, including PDF path, binary path, options, timeout, and a callback, in a single call. This is useful for direct, static access to text extraction functionality.

```php
public static function getText(
    string $pdf,
    ?string $binPath = null,
    array $options = [],
    int $timeout = 60,
    ?Closure $callback = null
): string
{
    // ...
}

```

```php
$text = Pdf::getText(
    pdf: 'document.pdf',
    binPath: '/usr/local/bin/pdftotext',
    options: ['layout', 'r 96', 'enc UTF-8'],
    timeout: 120,
    callback: fn ($process) => $process
);

```

--------------------------------

### Adding multiple options to pdftotext

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/DOCUMENTATION_MANIFEST.txt

Shows how to add multiple options to the pdftotext command using the `addOptions` method. This allows for flexible configuration of the text extraction process.

```php
use Spatie\PdfToText\Pdf;

$text = (new Pdf("/path/to/your/document.pdf"))
    ->addOptions([
        'layout',
        'verbose',
    ])
    ->text();

echo $text;
```

--------------------------------

### Set Environment Variables via Callback

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/configuration.md

Configure environment variables like LANG and LC_ALL for the pdftotext process using a callback function within the text() method. This allows fine-grained control over text encoding and locale settings.

```php
$text = (new Pdf())
    ->setPdf('document.pdf')
    ->text(function ($process) {
        $process->setEnv([
            'LANG' => 'en_US.UTF-8',
            'LC_ALL' => 'en_US.UTF-8'
        ]);
        return $process;
    });

```

--------------------------------

### Set pdftotext Options with Static Method

Source: https://github.com/spatie/pdf-to-text/blob/main/README.md

Configure pdftotext options using the static getText method. The third argument is an array of options.

```php
echo Pdf::getText('book.pdf', null, ['layout', 'opw myP1$$Word']);
```

--------------------------------

### Configure text() with a Callback

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/configuration.md

Use a callback to customize the Symfony Process instance for advanced configuration, such as setting environment variables or modifying I/O behavior. The callback receives the Process instance and should return it.

```php
public function text(?Closure $callback = null): string
{
    // ...
}

```

```php
fn (Symfony\Component\Process\Process $process): Symfony\Component\Process\Process
{
    // ...
}

```

```php
$pdf = new Pdf();
$text = $pdf
    ->setPdf('document.pdf')
    ->text(function ($process) {
        $process->setEnv(['LANG' => 'en_US.UTF-8', 'LC_ALL' => 'en_US.UTF-8']);
        return $process;
    });

```

--------------------------------

### Batch Process PDFs with Different Options

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Iterate through a list of PDFs, each with its own path and specific options, for batch processing.

```php
$pdfs = [
    ['path' => 'standard.pdf', 'options' => []],
    ['path' => 'table.pdf', 'options' => ['layout']],
    ['path' => 'pages.pdf', 'options' => ['f 1', 'l 10']],
];

foreach ($pdfs as $pdf) {
    $text = (new Pdf())
        ->setPdf($pdf['path'])
        ->setOptions($pdf['options'])
        ->text();
}
```

--------------------------------

### Specify Custom pdftotext Binary Path (Instance Method)

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Extracts text from a PDF file while specifying a custom path to the pdftotext binary using the instance method.

```php
use Spatie\PdfToText\Pdf;

$text = (new Pdf('/opt/custom/path/to/pdftotext'))
    ->setPdf('document.pdf')
    ->text();
```

--------------------------------

### Error Handling for Text Extraction

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/REFERENCE.md

Demonstrates how to catch specific exceptions that may occur during text extraction, such as the 'pdftotext' binary not being found, the PDF file not existing, or extraction failures.

```php
use Spatie\PdfToText\Pdf;
use Spatie\PdfToText\Exceptions;{
    BinaryNotFoundException,
    PdfNotFound,
    CouldNotExtractText
};

try {
    $text = (new Pdf())
        ->setPdf('document.pdf')
        ->text();
} catch (BinaryNotFoundException $e) {
    echo "pdftotext not installed";
} catch (PdfNotFound $e) {
    echo "PDF file not found";
} catch (CouldNotExtractText $e) {
    echo "Text extraction failed";
    echo $e->getProcess()->getErrorOutput();
}
```

--------------------------------

### Spatie\PdfToText\Pdf Class Methods

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/INDEX.md

This section details the methods available on the main `Pdf` class for processing PDF files and extracting text. It covers initialization, setting PDF files, configuring options, setting timeouts, and executing the text extraction process.

```APIDOC
## Class: Spatie\PdfToText\Pdf

### Description

The `Pdf` class is the primary interface for extracting text from PDF files using the `pdftotext` utility.

### Methods

#### `__construct(?string $binPath)`

*   **Description**: Initializes the PDF to Text converter. You can optionally provide the path to the `pdftotext` binary.
*   **Parameters**:
    *   `$binPath` (string|null) - Optional. The path to the `pdftotext` executable.

#### `setPdf(string $pdf)`

*   **Description**: Sets the PDF file that will be processed for text extraction.
*   **Parameters**:
    *   `$pdf` (string) - Required - The path to the PDF file.

#### `setOptions(array $options)`

*   **Description**: Configures the `pdftotext` options. This will replace any previously set options.
*   **Parameters**:
    *   `$options` (array) - Required - An array of `pdftotext` options.

#### `addOptions(array $options)`

*   **Description**: Adds `pdftotext` options. These options will be merged with any existing options.
*   **Parameters**:
    *   `$options` (array) - Required - An array of `pdftotext` options to add.

#### `setTimeout(int $timeout)`

*   **Description**: Sets the maximum time in seconds that the `pdftotext` process is allowed to run.
*   **Parameters**:
    *   `$timeout` (int) - Required - The timeout duration in seconds.

#### `text(?Closure $callback)`

*   **Description**: Executes the text extraction process. An optional callback can be provided to process the text in chunks.
*   **Parameters**:
    *   `$callback` (Closure|null) - Optional - A callback function to process extracted text chunks.
*   **Returns**: string - The extracted text from the PDF.

#### `getText(...)`

*   **Description**: A static convenience method for performing simple text extraction from a PDF file.
*   **Usage**: This method is a shortcut for common extraction scenarios.
```

--------------------------------

### Static Convenience Method for PDF Text Extraction

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/ARCHITECTURE.md

Provides a static convenience method for simple PDF text extraction use cases. This pattern internally creates an instance and uses the fluent API.

```php
Pdf::getText('file.pdf');
```

--------------------------------

### Specify Custom pdftotext Path with Static Method

Source: https://github.com/spatie/pdf-to-text/blob/main/README.md

Use a custom path to the pdftotext binary with the static getText method. The second argument specifies the binary path.

```php
echo Pdf::getText('book.pdf', '/custom/path/to/pdftotext');
```

--------------------------------

### Handle PdfNotFound Exception

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Exceptions.md

Shows how to catch PdfNotFound when the provided PDF file path is not readable or accessible.

```php
use Spatie\PdfToText\Pdf;
use Spatie\PdfToText\Exceptions\PdfNotFound;

try {
    $pdf = new Pdf();
    $pdf->setPdf('missing.pdf');
} catch (PdfNotFound $e) {
    echo "Cannot read PDF: " . $e->getMessage();
}
```

--------------------------------

### Method Chaining for PDF Text Extraction

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/REFERENCE.md

Demonstrates fluent interface for chaining methods to extract text from a PDF. Specify the PDF path, options, and timeout before calling text().

```php
// Fluent interface allows method chaining
$text = (new Pdf('/custom/pdftotext'))
    ->setPdf('document.pdf')
    ->setOptions(['layout'])
    ->addOptions(['r 96'])
    ->setTimeout(120)
    ->text();
```

--------------------------------

### PDF to Text Extraction with Callback

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/DOCUMENTATION_MANIFEST.txt

Illustrates using a callback function to process the extracted text. This is helpful for handling large amounts of text or performing real-time processing.

```php
use Spatie\PdfToText\Pdf;

$pdf = new Pdf("/path/to/your/document.pdf");

$pdf->text(function ($text) {
    // Process the extracted text here
    echo "Processing chunk...";
});
```

--------------------------------

### Handle All Extraction Errors

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/errors.md

A comprehensive try-catch block demonstrating how to handle all potential extraction errors: BinaryNotFoundException, PdfNotFound, and CouldNotExtractText, logging specific error messages.

```php
use Spatie\PdfToText\Pdf;
use Spatie\PdfToText\Exceptions\BinaryNotFoundException;
use Spatie\PdfToText\Exceptions\PdfNotFound;
use Spatie\PdfToText\Exceptions\CouldNotExtractText;

try {
    $text = (new Pdf($customPath))
        ->setPdf('document.pdf')
        ->text();
} catch (BinaryNotFoundException $e) {
    // Handle missing pdftotext binary
    error_log("pdftotext not installed");
} catch (PdfNotFound $e) {
    // Handle missing or unreadable PDF
    error_log("PDF file not accessible");
} catch (CouldNotExtractText $e) {
    // Handle extraction failure
    error_log("Failed to extract text from PDF");
    error_log($e->getProcess()->getErrorOutput());
}
```

--------------------------------

### Source Code Directory Structure

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/INDEX.md

This snippet shows the directory structure of the source code for the spatie/pdf-to-text package. It highlights the main PHP files and exception classes.

```text
src/
├── Pdf.php
└── Exceptions/
    ├── BinaryNotFoundException.php
    ├── PdfNotFound.php
    └── CouldNotExtractText.php
```

--------------------------------

### addOptions()

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Pdf.md

Adds pdftotext command-line options without overwriting previously set options. Merges new options with existing ones.

```APIDOC
## addOptions()

### Description
Adds pdftotext command-line options without overwriting previously set options. Merges new options with existing ones.

### Method
```php
public function addOptions(array $options): self
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **options** (array) - Required - Array of pdftotext options to append.

### Request Example
```php
$text = (new Pdf())
    ->setPdf('document.pdf')
    ->setOptions(['layout'])
    ->addOptions(['f 1', 'l 5'])
    ->text();
```

### Response
#### Success Response
* **self** - Returns the instance for method chaining.

#### Response Example
None provided.
```

--------------------------------

### Basic PDF to Text Extraction

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/DOCUMENTATION_MANIFEST.txt

Demonstrates the basic usage of the Pdf class to extract text from a PDF file. Ensure the PDF file exists at the specified path.

```php
use Spatie\PdfToText\Pdf;

$text = (new Pdf("/path/to/your/document.pdf"))->text();

echo $text;
```

--------------------------------

### Specify Custom pdftotext Path

Source: https://github.com/spatie/pdf-to-text/blob/main/README.md

Use a custom path to the pdftotext binary when initializing the Pdf class. This is useful if pdftotext is not in the system's PATH.

```php
$text = (new Pdf('/custom/path/to/pdftotext'))
    ->setPdf('book.pdf')
    ->text();
```

--------------------------------

### Process Multiple PDFs Sequentially

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Reuse a Pdf instance to efficiently process multiple PDF files in a loop.

```php
$pdf = new Pdf();

$files = ['document1.pdf', 'document2.pdf', 'document3.pdf'];

foreach ($files as $file) {
    $text = $pdf
        ->setPdf($file)
        ->text();
    
    // Process extracted text
    processPdfText($text);
}
```

--------------------------------

### Set Process Timeout (Instance Method)

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Extracts text from a large PDF file and sets a custom process timeout of 300 seconds (5 minutes) using the instance method.

```php
use Spatie\PdfToText\Pdf;

$text = (new Pdf())
    ->setPdf('large-document.pdf')
    ->setTimeout(300)  // 5 minutes
    ->text();
```

--------------------------------

### Optimizing PDF Extraction Speed

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Use the 'nopgbrk' option to disable layout preservation and speed up extraction at the cost of precision. Adjust timeout as needed.

```php
// Skip layout preservation, no resolution override
$text = (new Pdf())
    ->setPdf('document.pdf')
    ->setOptions(['nopgbrk'])  // No page breaks slows things down
    ->setTimeout(30)
    ->text();
```

--------------------------------

### PDF Text Extraction with Custom Configuration

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/README.md

Configure the PDF text extraction process by specifying the path to the pdftotext binary, custom options, and a timeout.

```php
use Spatie\PdfToText\Pdf;

$text = (new Pdf('/custom/path/to/pdftotext'))
    ->setPdf('table.pdf')
    ->setOptions(['layout', 'r 150'])
    ->setTimeout(120)
    ->text();
```

--------------------------------

### Define BinaryNotFoundException

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Exceptions.md

This exception is thrown when the pdftotext binary cannot be found during initialization. It extends PHP's base Exception class.

```php
class BinaryNotFoundException extends Exception {}
```

--------------------------------

### setOptions()

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Pdf.md

Sets pdftotext command-line options, overwriting any previously set options. This method is chainable.

```APIDOC
## setOptions()

### Description
Sets pdftotext command-line options, overwriting any previously set options. This method is chainable.

### Parameters
#### Path Parameters
- **$options** (array) - Required - Array of pdftotext options. Each option is a string that may or may not start with a hyphen.

### Returns
- `self` - Returns the instance for method chaining.

### Note
Calling this method multiple times will replace options from previous calls. Use `addOptions()` to append options instead.

### Usage Example
```php
// Extract with layout preservation
$text = (new Pdf())
    ->setPdf('table.pdf')
    ->setOptions(['layout', 'r 96'])
    ->text();

// Options with hyphens are also supported
$text = (new Pdf())
    ->setPdf('protected.pdf')
    ->setOptions(['-opw', 'password123'])
    ->text();
```
```

--------------------------------

### PDF to Text Extraction with Custom Options

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/DOCUMENTATION_MANIFEST.txt

Shows how to extract text from a PDF file using custom options to control the pdftotext command. This is useful for fine-tuning the extraction process.

```php
use Spatie\PdfToText\Pdf;

$text = (new Pdf("/path/to/your/document.pdf"))
    ->setOptions([
        'layout', // Example option
        'encoding' => 'UTF-8',
    ])
    ->text();

echo $text;
```

--------------------------------

### Handle CouldNotExtractText Exception

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Exceptions.md

Demonstrates catching CouldNotExtractText to access detailed error information from the underlying process, such as exit code and error output.

```php
use Spatie\PdfToText\Pdf;
use Spatie\PdfToText\Exceptions\CouldNotExtractText;

try {
    $text = (new Pdf())
        ->setPdf('document.pdf')
        ->setOptions(['-invalid-option'])
        ->text();
} catch (CouldNotExtractText $e) {
    $process = $e->getProcess();
    echo "Exit code: " . $process->getExitCode();
    echo "Error: " . $process->getErrorOutput();
}
```

--------------------------------

### Pdf::getText() with Options

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Pdf.md

Extracts text from a PDF file, providing custom pdftotext command-line options.

```php
$text = Pdf::getText('table.pdf', null, ['layout', 'r 96']);
```

--------------------------------

### Set pdftotext Options

Source: https://github.com/spatie/pdf-to-text/blob/main/README.md

Configure pdftotext options using the setOptions method. This allows for advanced text extraction settings like layout.

```php
$text = (new Pdf())
    ->setPdf('table.pdf')
    ->setOptions(['layout', 'r 96'])
    ->text();
```

--------------------------------

### Exception Class Reference

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/DOCUMENTATION_MANIFEST.txt

Details on the exception classes used by the library, including when they are thrown and how to handle them.

```APIDOC
## Exception Classes

### Description
Reference for all exception classes thrown by the library, detailing their purpose, triggers, and recommended handling strategies.

### Exception Hierarchy
- Lists the hierarchy of all exception classes.

### Exception Types

#### `BinaryNotFoundException`
- Thrown when the `pdftotext` binary cannot be found.
- Provides guidance on how to catch and respond to this exception.

#### `PdfNotFound`
- Thrown when the specified PDF file does not exist or is inaccessible.
- Includes examples of error handling.

#### `CouldNotExtractText`
- Thrown when the text extraction process fails for reasons other than the binary or file not being found.
- Offers access to the underlying process's error output for debugging.
- Details common failure scenarios and debugging strategies.

### Error Handling Examples
- Provides complete examples for catching and responding to each type of exception.
```

--------------------------------

### Add pdftotext Options

Source: https://github.com/spatie/pdf-to-text/blob/main/README.md

Add additional pdftotext options using the addOptions method. This is useful for combining default and context-specific options.

```php
$text = (new Pdf())
    ->setPdf('table.pdf')
    ->setOptions(['layout', 'r 96'])
    ->addOptions(['f 1'])
    ->text();
```

--------------------------------

### Set PDF File Path

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/configuration.md

Set the PDF file to be processed. The path can be relative or absolute, and the file must be readable.

```php
public function setPdf(string $pdf): self
```

--------------------------------

### Basic Text Extraction Flow

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/ARCHITECTURE.md

Illustrates the sequence of operations for extracting text from a PDF using the library, from user code to the pdftotext binary execution and output capture.

```text
User Code
  ↓
new Pdf() or Pdf::getText()
  ↓
setPdf(path)
  ↓
[setOptions() / addOptions() / setTimeout()]  (optional)
  ↓
text()
  ↓
Symfony Process spawns pdftotext binary
  ↓
pdftotext subprocess executes
  ↓
Text output captured from stdout
  ↓
Return trimmed text to caller
```

--------------------------------

### Setting a timeout for text extraction

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/DOCUMENTATION_MANIFEST.txt

Demonstrates how to set a timeout for the text extraction process using the `setTimeout` method. This is crucial for preventing long-running processes from blocking your application.

```php
use Spatie\PdfToText\Pdf;

$text = (new Pdf("/path/to/your/document.pdf"))
    ->setTimeout(60) // Timeout in seconds
    ->text();

echo $text;
```

--------------------------------

### Process Encrypted PDF with Owner Password

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Use the 'opw' option to provide the owner password when processing password-protected PDFs.

```php
$text = (new Pdf())
    ->setPdf('protected.pdf')
    ->setOptions(['opw myPassword'])  // Owner password
    ->text();
```

--------------------------------

### Pdf Class Methods

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/README.md

This section details the methods available on the main Pdf class for interacting with the pdf-to-text functionality.

```APIDOC
## Pdf Class Methods

### `__construct(?string $binPath)`

#### Description
Initialize Pdf instance with optional binary path.

#### Method
`__construct`

#### Parameters
##### Path Parameters
- **binPath** (string) - Optional - The path to the pdftotext binary.

### `setPdf(string $pdf)`

#### Description
Set the PDF file path to process.

#### Method
`setPdf`

#### Parameters
##### Path Parameters
- **pdf** (string) - Required - The path to the PDF file.

### `setOptions(array $options)`

#### Description
Configure pdftotext options (replaces existing).

#### Method
`setOptions`

#### Parameters
##### Path Parameters
- **options** (array) - Required - An array of pdftotext options.

### `addOptions(array $options)`

#### Description
Append pdftotext options (merges with existing).

#### Method
`addOptions`

#### Parameters
##### Path Parameters
- **options** (array) - Required - An array of pdftotext options to append.

### `setTimeout(int $timeout)`

#### Description
Set process execution timeout in seconds.

#### Method
`setTimeout`

#### Parameters
##### Path Parameters
- **timeout** (int) - Required - The timeout duration in seconds.

### `text(?Closure $callback)`

#### Description
Execute text extraction and return result.

#### Method
`text`

#### Parameters
##### Path Parameters
- **callback** (Closure) - Optional - A callback function to process the extracted text.

#### Returns
- **string** - The extracted text from the PDF.

### `getText(...)`

#### Description
Static method for single-call text extraction.

#### Method
`getText`

#### Parameters
No parameters explicitly documented for this static method in the provided text, but it is implied to take a PDF path.

#### Returns
- **string** - The extracted text from the PDF.
```

--------------------------------

### Pdf::getText() with Custom Binary Path

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Pdf.md

Extracts text from a PDF file, specifying a custom path to the pdftotext binary.

```php
$text = Pdf::getText('document.pdf', '/usr/local/bin/pdftotext');
```

--------------------------------

### Error Handling Flow

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/ARCHITECTURE.md

Details the error handling mechanisms within the library, covering exceptions thrown during binary discovery, file readability checks, and text extraction failures.

```text
Construction:
  ↓
findPdfToText() → No binary found? → BinaryNotFoundException

setPdf():
  ↓
is_readable() → File not readable? → PdfNotFound

text():
  ↓
Process->run() → Non-zero exit? → CouldNotExtractText
```

--------------------------------

### Customize PDF Text Extraction Process

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Pass a callback function to the text() method to customize the underlying process object, such as setting environment variables.

```php
$text = (new Pdf())
    ->setPdf('document.pdf')
    ->text(function ($process) {
        // Set environment variables
        $process->setEnv([
            'LANG' => 'en_US.UTF-8',
            'LC_ALL' => 'en_US.UTF-8'
        ]);
        return $process;
    });
```

--------------------------------

### High-Quality PDF Extraction

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

For high-quality extraction, preserve layout and set a resolution using 'layout' and 'r' options. An extended timeout is also configured.

```php
// Preserve layout, set resolution, extended timeout
$text = (new Pdf())
    ->setPdf('document.pdf')
    ->setOptions(['layout', 'r 150'])
    ->setTimeout(120)
    ->text();
```

--------------------------------

### Pdf::setOptions

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/REFERENCE.md

Configures pdftotext options, replacing any existing options.

```APIDOC
## Pdf::setOptions

### Description
Sets the options for the `pdftotext` command. This will overwrite any previously set options.

### Method
```php
public function setOptions(array $options)
```

### Parameters
#### Path Parameters
- **options** (array) - Required - An array of `pdftotext` options (e.g., `['-layout']`).
```

--------------------------------

### Pdf::getText() with Process Callback

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Pdf.md

Extracts text from a PDF file, providing a callback to modify the Symfony Process instance.

```php
$text = Pdf::getText(
    'document.pdf',
    '/usr/bin/pdftotext',
    ['layout'],
    60,
    fn (Process $process) => $process
);
```

--------------------------------

### Set pdftotext Options for Text Extraction

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Pdf.md

Configure pdftotext command-line options to customize text extraction. This overwrites any previously set options. Supports options with or without leading hyphens.

```php
// Extract with layout preservation
$text = (new Pdf())
    ->setPdf('table.pdf')
    ->setOptions(['layout', 'r 96'])
    ->text();

// Options with hyphens are also supported
$text = (new Pdf())
    ->setPdf('protected.pdf')
    ->setOptions(['-opw', 'password123'])
    ->text();
```

--------------------------------

### Set Process Timeout

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/configuration.md

Set the maximum execution time in seconds for the pdftotext process. The default is 60 seconds. Use null for an unlimited timeout, but exercise caution.

```php
public function setTimeout(int $timeout): self
```

--------------------------------

### Set PDF and Extract Text

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Pdf.md

Set the PDF file to process and extract its text content. Ensures the PDF file is readable and returns the extracted text.

```php
$text = (new Pdf())
    ->setPdf('document.pdf')
    ->text();
```

--------------------------------

### Process Encrypted PDF with User Password

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Use the 'upw' option to provide the user password when processing password-protected PDFs.

```php
$text = (new Pdf())
    ->setPdf('protected.pdf')
    ->setOptions(['upw myPassword'])  // User password
    ->text();
```

--------------------------------

### Basic PDF Text Extraction (Static Method)

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Extracts text from a PDF file using the simplest static method. The library automatically detects the pdftotext binary.

```php
use Spatie\PdfToText\Pdf;

$text = Pdf::getText('document.pdf');
echo $text;
```

--------------------------------

### Handle PDF Text Extraction Timeout

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Catch CouldNotExtractText for potential timeouts, and retry with an extended timeout duration if the initial attempt fails.

```php
use Spatie\PdfToText\Pdf;
use Spatie\PdfToText\Exceptions\CouldNotExtractText;

try {
    $text = (new Pdf())
        ->setPdf('large-document.pdf')
        ->setTimeout(60)
        ->text();
} catch (CouldNotExtractText $e) {
    // Likely timeout, retry with longer timeout
    try {
        $text = (new Pdf())
            ->setPdf('large-document.pdf')
            ->setTimeout(300)
            ->text();
    } catch (CouldNotExtractText $retryError) {
        echo "Still failed even with extended timeout.";
    }
}
```

--------------------------------

### Set pdftotext Process Timeout

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Pdf.md

Configures the maximum execution time for the pdftotext process in seconds. Ensure the timeout is a non-negative integer. Defaults to 60 seconds.

```php
$text = (new Pdf())
    ->setPdf('large-document.pdf')
    ->setTimeout(120)
    ->text();
```

--------------------------------

### Set Process Timeout (Static Method)

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Extracts text from a large PDF file and sets a custom process timeout of 300 seconds using the static method.

```php
use Spatie\PdfToText\Pdf;

$text = Pdf::getText('large-document.pdf', null, [], 300);
```

--------------------------------

### Pdf::getText() Basic Usage

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Pdf.md

Extracts text from a PDF file using the default pdftotext binary path and options.

```php
$text = Pdf::getText('document.pdf');
```

--------------------------------

### Handle PDF Text Extraction Failure

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Catch CouldNotExtractText exception for extraction failures, and retry with default options if initial attempts with custom options fail.

```php
use Spatie\PdfToText\Pdf;
use Spatie\PdfToText\Exceptions\CouldNotExtractText;

try {
    $text = (new Pdf())
        ->setPdf('document.pdf')
        ->setOptions(['-invalid-option'])
        ->text();
} catch (CouldNotExtractText $e) {
    // Try again with different options
    try {
        $text = Pdf::getText('document.pdf');
    } catch (CouldNotExtractText $retryError) {
        echo "Extraction failed even with default options.";
        echo $retryError->getProcess()->getErrorOutput();
    }
}
```

--------------------------------

### Customizing Symfony Process with a Callback

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/ARCHITECTURE.md

Allows advanced users to customize the Symfony Process object before execution using a callback function. This provides extensibility for the text extraction process.

```php
->text(fn (Process $process) => $process)
```

--------------------------------

### Pdf::addOptions

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/REFERENCE.md

Adds pdftotext options, merging them with existing ones.

```APIDOC
## Pdf::addOptions

### Description
Adds new options to the `pdftotext` command configuration. These options will be merged with any existing options.

### Method
```php
public function addOptions(array $options)
```

### Parameters
#### Path Parameters
- **options** (array) - Required - An array of `pdftotext` options to add.
```

--------------------------------

### text()

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/api-reference/Pdf.md

Executes the pdftotext process and returns the extracted text.

```APIDOC
## text()

### Description
Executes the pdftotext process and returns the extracted text.

### Method
```php
public function text(?Closure $callback = null): string
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **callback** (Closure|null) - Optional - Optional callback function that receives the Symfony Process instance for advanced customization before execution. Callback receives the Process object and must return it.

### Request Example
```php
// Simple extraction
$text = (new Pdf())
    ->setPdf('document.pdf')
    ->text();

// With process callback for advanced customization
$text = (new Pdf())
    ->setPdf('document.pdf')
    ->text(function (Process $process) {
        $process->setEnv(['LANG' => 'en_US.UTF-8']);
        return $process;
    });
```

### Response
#### Success Response
* **string** - The extracted text from the PDF, trimmed of whitespace and control characters.

#### Response Example
None provided.

### Throws
* **CouldNotExtractText** - Thrown if the pdftotext process fails (returns non-zero exit code).
```

--------------------------------

### Configure pdftotext Option: Set Resolution

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Extracts text from a scanned PDF file at 150 DPI for rasterized content using the 'r' option.

```php
use Spatie\PdfToText\Pdf;

// Extract at 150 DPI for rasterized content
$text = (new Pdf())
    ->setPdf('scanned-document.pdf')
    ->setOptions(['r 150'])
    ->text();
```

--------------------------------

### Web Upload Handler for PDF Text Extraction

Source: https://github.com/spatie/pdf-to-text/blob/main/_autodocs/USAGE_GUIDE.md

Handles PDF uploads via a web form, extracts text using the Pdf class, and saves it to a file. Includes error handling for common extraction issues.

```php
use Spatie\PdfToText\Pdf;
use Spatie\PdfToText\Exceptions\{
    BinaryNotFoundException,
    PdfNotFound,
    CouldNotExtractText
};

if ($_FILES['pdf_upload']['error'] === UPLOAD_ERR_OK) {
    $uploadedFile = $_FILES['pdf_upload']['tmp_name'];
    
    try {
        $text = (new Pdf())
            ->setPdf($uploadedFile)
            ->setTimeout(120)
            ->text();
        
        // Store extracted text
        file_put_contents('extracted_' . time() . '.txt', $text);
        echo "Success: Text extracted.";
    } catch (CouldNotExtractText $e) {
        echo "Error: Could not extract text from PDF.";
    } catch (PdfNotFound $e) {
        echo "Error: Invalid PDF file.";
    }
}
```
Tokens:
Raw