Cookbook

The installation of phpdocx in a project that works with Composer can be manual or using a private repository with GitHub, Bitbucket or any other distributed version control system.

To use a private repository with GitHub, Bitbucket or Gitlab you have to generate and use an SSH key or auth.json:

• GitHub: https://dudi.dev/composer-private-packages-github-repository
• Bitbucket: https://dev.to/minompi/using-a-bitbucket-private-repository-in-your-projects-24j9
• GitLab: https://docs.gitlab.com/user/packages/composer_repository/#install-a-composer-package

Advanced and Premium licenses include a sample composer.json file (plugins/sample_composer.json file in the namespaces package) that can be added in a phpdocx private repository.

To perform a manual integration just follow these three easy steps:

• 1- Copy the content of the phpdocx package in the folder you use for third parties libraries, e.g. lib/phpdocx, vendor/phpdocx or 3rd-party/phpdocx.
• 2- Open the file composer.json and add the following classmap in the autoload section: "lib/phpdocx/Classes/Phpdocx" . Replacing lib/phpdocx with the folder name where phpdocx has been copied.

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

• 3- Update the autoloader of Composer:

phpdocx can also be integrated manually by using PHP functions such as require_once or include_once. The CreateDocx class implements an autoloader to dynamically load the dependent classes.

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