TextConverter
extends BaseConverter
in package
Text Converter
Tags
Table of Contents
Properties
- $converter : array<string|int, mixed>
- List of installed text conversion converters
- $file : File
- $maxTextFileSize : int
- $options : array<string|int, mixed>
- All options used for the converted file variant.
Methods
- __call() : mixed
- Calls the named method which is not a class method.
- __construct() : mixed
- Constructor.
- __get() : mixed
- Returns the value of an object property.
- __isset() : bool
- Checks if a property is set, i.e. defined and not null.
- __set() : mixed
- Sets value of an object property.
- __unset() : mixed
- Sets an object property to null.
- applyFile() : bool
- Sets file for the converter
- canGetProperty() : bool
- Returns a value indicating whether a property can be read.
- canSetProperty() : bool
- Returns a value indicating whether a property can be set.
- className() : string
- Returns the fully qualified name of this class.
- getContentAsText() : string
- Returns the file content as text
- getConverter() : array<string|int, mixed>
- Returns the first matching converter for the file
- getFilename() : string
- Returns the filename of the converted file.
- getId() : string
- Returns the ID of the converted file variant.
- getUrl() : string
- Returns the url to the converted file
- hasMethod() : bool
- Returns a value indicating whether a method is defined.
- hasProperty() : bool
- Returns a value indicating whether a property is defined.
- init() : mixed
- Initializes the object.
- canConvert() : mixed
- Returns if the given file can be converted
- convert() : mixed
- Convert file
Properties
$converter
List of installed text conversion converters
public
array<string|int, mixed>
$converter
= []
Example:
[
'cmd' => '/usr/bin/pdftotext -q -enc UTF-8 {fileName} {outputFileName}',
'only' => ['pdf']
],
[
'cmd' => '/usr/bin/java -jar /path/to/tika-app-1.16.jar --text {fileName} 2>/dev/null',
'except' => ['image/']
]
$file
public
File
$file
the file record
$maxTextFileSize
public
int
$maxTextFileSize
= 32000000.0
maximum text file size in byte
$options
All options used for the converted file variant.
public
array<string|int, mixed>
$options
= []
These values also produce the unique ID of the cached returned file.
the converter options
Methods
__call()
Calls the named method which is not a class method.
public
__call(string $name, array<string|int, mixed> $params) : mixed
Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.
Parameters
- $name : string
-
the method name
- $params : array<string|int, mixed>
-
method parameters
Tags
Return values
mixed —the method return value
__construct()
Constructor.
public
__construct([array<string|int, mixed> $config = [] ]) : mixed
The default implementation does two things:
- Initializes the object with the given configuration
$config. - Call [[init()]].
If this method is overridden in a child class, it is recommended that
- the last parameter of the constructor is a configuration array, like
$confighere. - call the parent implementation at the end of the constructor.
Parameters
- $config : array<string|int, mixed> = []
-
name-value pairs that will be used to initialize the object properties
__get()
Returns the value of an object property.
public
__get(string $name) : mixed
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $object->property;.
Parameters
- $name : string
-
the property name
Tags
Return values
mixed —the property value
__isset()
Checks if a property is set, i.e. defined and not null.
public
__isset(string $name) : bool
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($object->property).
Note that if the property is not defined, false will be returned.
Parameters
- $name : string
-
the property name or the event name
Tags
Return values
bool —whether the named property is set (not null).
__set()
Sets value of an object property.
public
__set(string $name, mixed $value) : mixed
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $object->property = $value;.
Parameters
- $name : string
-
the property name or the event name
- $value : mixed
-
the property value
Tags
__unset()
Sets an object property to null.
public
__unset(string $name) : mixed
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing unset($object->property).
Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.
Parameters
- $name : string
-
the property name
Tags
applyFile()
Sets file for the converter
public
applyFile(File $file) : bool
Parameters
- $file : File
Return values
bool —returns false if file cannot be converted
canGetProperty()
Returns a value indicating whether a property can be read.
public
canGetProperty(string $name[, bool $checkVars = true ]) : bool
A property is readable if:
- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
Parameters
- $name : string
-
the property name
- $checkVars : bool = true
-
whether to treat member variables as properties
Tags
Return values
bool —whether the property can be read
canSetProperty()
Returns a value indicating whether a property can be set.
public
canSetProperty(string $name[, bool $checkVars = true ]) : bool
A property is writable if:
- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
Parameters
- $name : string
-
the property name
- $checkVars : bool = true
-
whether to treat member variables as properties
Tags
Return values
bool —whether the property can be written
className()
Returns the fully qualified name of this class.
public
static className() : string
Tags
Return values
string —the fully qualified name of this class.
getContentAsText()
Returns the file content as text
public
getContentAsText() : string
Return values
string —the text output
getConverter()
Returns the first matching converter for the file
public
getConverter() : array<string|int, mixed>
Return values
array<string|int, mixed> —the converter definitions
getFilename()
Returns the filename of the converted file.
public
getFilename() : string
Return values
string —the filename of converted file
getId()
Returns the ID of the converted file variant.
public
getId() : string
Tags
Return values
string —the id
getUrl()
Returns the url to the converted file
public
getUrl() : string
Return values
stringhasMethod()
Returns a value indicating whether a method is defined.
public
hasMethod(string $name) : bool
The default implementation is a call to php function method_exists().
You may override this method when you implemented the php magic method __call().
Parameters
- $name : string
-
the method name
Return values
bool —whether the method is defined
hasProperty()
Returns a value indicating whether a property is defined.
public
hasProperty(string $name[, bool $checkVars = true ]) : bool
A property is defined if:
- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
Parameters
- $name : string
-
the property name
- $checkVars : bool = true
-
whether to treat member variables as properties
Tags
Return values
bool —whether the property is defined
init()
Initializes the object.
public
init() : mixed
Tags
canConvert()
Returns if the given file can be converted
protected
canConvert(File $file) : mixed
Parameters
- $file : File
Tags
convert()
Convert file
protected
convert(mixed $fileName) : mixed
Parameters
- $fileName : mixed