Abstract Class kartik\wordreport\utils\Converter
| Inheritance | kartik\wordreport\utils\Converter » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Uses Traits | kartik\wordreport\utils\LogTrait |
| Subclasses | kartik\wordreport\pdf\LibreOffice, kartik\wordreport\pdf\Unoconv |
Abstract Converter class manages Document format conversions
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $args | array | The arguments to be passed to command as key value pairs | kartik\wordreport\utils\Converter |
| $binary | string | The name of the binary | kartik\wordreport\utils\Converter |
| $command | kartik\wordreport\utils\Command | kartik\wordreport\utils\Converter | |
| $input | string | The input file path | kartik\wordreport\utils\Converter |
| $output | string | The output file path | kartik\wordreport\utils\Converter |
| $profile | string | The user profile directory on the server | kartik\wordreport\utils\Converter |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $_command | kartik\wordreport\utils\Command | kartik\wordreport\utils\Converter |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\BaseObject |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of an object property. | yii\base\BaseObject |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
| __set() | Sets value of an object property. | yii\base\BaseObject |
| __unset() | Sets an object property to null. | yii\base\BaseObject |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| convert() | Convert the document to the target format | kartik\wordreport\utils\Converter |
| getCommand() | kartik\wordreport\utils\Converter | |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\BaseObject |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject |
| init() | Initializes the object. | yii\base\BaseObject |
| log() | Log / report a message. | kartik\wordreport\utils\LogTrait |
| runBinary() | Runs the binary command on the server | kartik\wordreport\utils\Converter |
| setCommand() | Sets command | kartik\wordreport\utils\Converter |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| validateArgs() | Validation of input file, output file and profile location | kartik\wordreport\utils\Converter |
Property Details
The arguments to be passed to command as key value pairs
The name of the binary
The input file path
The output file path
The user profile directory on the server
Method Details
Convert the document to the target format
| public abstract void convert ( ) |
| public kartik\wordreport\utils\Command getCommand ( ) |
Runs the binary command on the server
| public void runBinary ( ) |
Sets command
| public void setCommand ( $config = [] ) | ||
| $config | array | The command configuration |
Validation of input file, output file and profile location
| protected void validateArgs ( ) | ||
| throws | kartik\wordreport\utils\ConverterException | |
|---|---|---|