Skip to content

Commit 226fece

Browse files
committed
PDF Options support added.
1 parent c075fed commit 226fece

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,14 @@ echo (string) $output;
5050
```
5151
Run the extractor to any supported file:
5252
```
53-
Textract::run(string $file_path, [string $job_id],[TesseractOcrOptions $extra_data]);
53+
Textract::run(string $file_path, [string $job_id], [PdfOptions $pdfOption],[TesseractOcrOptions $ocrOption]);
5454
```
55-
| Option | Type | Default value | Required | Description |
56-
|:-----------:|:-------------------------:|:------------------:|:--------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
57-
| $file_path | ```String``` | _No default value_ | Yes | Text extractable file absolute path. |
58-
| $job_id | ```String``` | ```NULL``` | No | It's a optional parameter. Extraction **job id**. If this option is blank the plugin will auto create the **ID** |
59-
| $extra_data | ```TesseractOcrOptions``` | ```NULL``` | No | It's a optional parameter. To pass extra parameter. If you are extracting a image file, you can mention languages and more by this ```Nilgems\PhpTextract\ExtractorService\Ocr\Contracts\TesseractOcrOptions``` **parameter**. |
55+
| Option | Type | Default value | Required | Description |
56+
|:----------:|:-------------------------:|:------------------:|:--------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
57+
| $file_path | ```String``` | _No default value_ | Yes | Text extractable file absolute path. |
58+
| $job_id | ```String``` | ```NULL``` | No | It's a optional parameter. Extraction **job id**. If this option is blank the plugin will auto create the **ID** |
59+
| $pdfOption | ```PdfOptions``` | ```NULL``` | No | It's a optional parameter. To pass extra parameter. If you are extracting a pdf file, you can mention password and more by this ```Nilgems\PhpTextract\ExtractorService\Pdf\Contracts\PdfOptions``` **parameter**. |
60+
| $ocrOption | ```TesseractOcrOptions``` | ```NULL``` | No | It's a optional parameter. To pass extra parameter. If you are extracting a image file, you can mention languages and more by this ```Nilgems\PhpTextract\ExtractorService\Ocr\Contracts\TesseractOcrOptions``` **parameter**. |
6061

6162
### Configuration
6263

0 commit comments

Comments
 (0)