phpdocx CLI command

Information

phpdocx Premium licenses include a phpdocx-cli script to speed up developments and assist you in the work with phpdocx by generating sample code skeletons, checking server settings, returning information and other useful tasks.

How to use

To run phpdocx-cli.php and view all available options, execute:

php phpdocx-cli.php

If no option or valid parameter are set, the help information is displayed.

For example, the following command generates a skeleton (phpdocx-sample-skeleton.php as default) to create a new DOCX adding text, image, list, header, footer and html methods:

php phpdocx-cli.php -a generate -m "text, image, list, header, footer, html"

Available options

The available options are the following:.

-a, --action <action>                   Action. Allowed values:
                                                · "check": check and view PHP settings.
                                                · "generate": create a skeleton.
    --color                             Change output colors. Allowed values: auto, none.
-m, --methods <method1, method2...>     Methods to be included in the output separated by commas.
-h, --help                              View help information.
-l, --license                           View phpdocx license information.
-o, --output                            Output file for skeletons. Default as "phpdocx-sample-skeleton.php".
-t, --template <template>               DOCX template.
    --view-methods                      Display available methods to be used when generating skeletons.

Skeleton methods

Supported methods in documents generated from scratch:

backgroundColor
backgroundImage
bookmark
break
chart
citation
comment
cross-reference
date
endnote
externalFile
footnote
footer
formElement
header
heading
html
image
link
list
mathEquation
mergeField
ole
onlineVideo
pageNumber
properties
section
shape
simpleField
source
structuredDocumentTag
styleCharacter
styleList
styleParagraph
styleTable
svg
tab
table
tableContents
tableFigures
text
textBox
wordML

Supported methods in documents generated with a template:

clearBlocks
cloneBlock
deleteBlock
getTemplateVariables
modifyInputFields
modifyMergeFields
removeVariable
replaceBlock
replaceImage
replaceList
replaceTable
replaceText
setTemplateSymbol
tickCheckboxes

Template methods are only added to the skeleton when a DOCX template is set using "-t" parameter:

php phpdocx-cli.php -a generate -m "replaceImage, replaceList, replaceText" -t template.docx

These template methods are not added to the skeleton when creating a new DOCX without a template.

Other supported methods:

encrypt
sign
stream
transform
watermark

To display all available methods use --view-methods:

php phpdocx-cli.php --view-methods

Examples

Generate a phpdocx skeleton using header, html, list and text methods:

php phpdocx-cli.php -a generate -m "header, html, list, text"

Generate a phpdocx skeleton using a template and replaceImage, replaceList and replaceText methods:

php phpdocx-cli.php -a generate -m "replaceImage, replaceList, replaceText" -t template.docx

Generate a phpdocx skeleton and save the sample as custom-skeleton.php:

php phpdocx-cli.php -a generate -m "text" -o custom-skeleton.php

Check server settings:

php phpdocx-cli.php -a check

View phpdocx license information:

php phpdocx-cli.php -l