ExtractTextCommand
in package
implements
CommandInterface
pdfbox ExtractText command.
Interfaces, Classes, Traits and Enums
- CommandInterface
- pdfbox command.
Table of Contents
- $inputFile : mixed
- $options : mixed
- $outputFile : mixed
- __construct() : mixed
- console() : self
- Set -console.
- debug() : self
- Set -debug.
- encoding() : self
- Set -encoding <output encoding>.
- endPage() : self
- Set -endPage <number>.
- html() : self
- Set -html.
- ignoreBeads() : self
- Set -ignoreBeads.
- inputFile() : self
- Set <input-file>.
- outputFile() : self
- Set <output-text-file>.
- password() : self
- Set -password <password>.
- sort() : self
- Set -sort.
- startPage() : self
- Set -startPage <number>.
- toArray() : array<string|int, mixed>
- setFlag() : self
- Set flags (eg -password)
- setOption() : self
- Set options (eg -password MyPasswd)
Properties
$inputFile
private
mixed
$inputFile
$options
private
mixed
$options
$outputFile
private
mixed
$outputFile
Methods
__construct()
public
__construct() : mixed
Return values
mixed —console()
Set -console.
public
console() : self
Send text to console instead of file.
Return values
self —debug()
Set -debug.
public
debug() : self
Enables debug output about the time consumption of every stage.
Return values
self —encoding()
Set -encoding <output encoding>.
public
encoding(string $outputEncoding) : self
UTF-8 (default) or ISO-8859-1, UTF-16BE, UTF-16LE, etc.
Parameters
- $outputEncoding : string
Return values
self —endPage()
Set -endPage <number>.
public
endPage(int $endPage) : self
The last page to extract (inclusive).
Parameters
- $endPage : int
Return values
self —html()
Set -html.
public
html() : self
Output in HTML format instead of raw text.
Return values
self —ignoreBeads()
Set -ignoreBeads.
public
ignoreBeads() : self
Disables the separation by beads.
Return values
self —inputFile()
Set <input-file>.
public
inputFile(string $inputFile) : self
The PDF document to use.
Parameters
- $inputFile : string
Return values
self —outputFile()
Set <output-text-file>.
public
outputFile(string $outputFile) : self
The file to write the text to.
Parameters
- $outputFile : string
Return values
self —password()
Set -password <password>.
public
password(string $password) : self
Password to decrypt document.
Parameters
- $password : string
Return values
self —sort()
Set -sort.
public
sort() : self
Sort the text before writing.
Return values
self —startPage()
Set -startPage <number>.
public
startPage(int $startPage) : self
The first page to start extraction (1 based).
Parameters
- $startPage : int
Return values
self —toArray()
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —setFlag()
Set flags (eg -password)
private
setFlag(string $key) : self
Parameters
- $key : string
-
Name of the flag including leading hyphen
Return values
self —setOption()
Set options (eg -password MyPasswd)
private
setOption(string $key, string $value) : self
Parameters
- $key : string
-
Name of the option
- $value : string
-
Value to be passed with the option