Cookbook

INTRODUCTION

PRACTICAL JAVADOCX

API DOCUMENTATION

Integrate javadocx with Yii 2

Warning

To run javadocx with Yii 2 it is mandatory to use the package that supports namespaces. This package is available for Advanced and Premium licenses.

1- Copy the content of the javadocx package in the folder vendor/javadocx.
2- Open the file composer.json. Add the autoload section, in case it doesn't exist yet. Then add the following classmap:
"vendor/javadocx/Classes/javadocx"

In a Yii 2 clean installation, the section should look like this:

"require-dev": {
      "yiisoft/yii2-codeception": "*",
      "yiisoft/yii2-debug": "*",
      "yiisoft/yii2-gii": "*",
      "yiisoft/yii2-faker": "*"
},
"autoload": {
      "classmap": [
          "vendor/javadocx/Classes/javadocx"
      ]
},
"config": {
      "process-timeout": 1800
},

3- Update the autoloader of Composer:

composer dump-autoload

Now, with these three easy steps completed, you can work with javadocx.

As an example, let's create a document in a controller, and then save it in the webroot folder with the name output.docx:

$docx = new \javadocx\Create\CreateDocx();

$docx->addText('This is a test');
$docx->embedHTML('<p style="font-size: 30px;">New paragraph</p>');
$docx->createDocx(Yii::getAlias('@webroot') . '/output.docx');