phpxlsx CLI command

Information

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

How to use

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

php phpxlsx-cli.php

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

For example, the following command generates a skeleton (phpxlsx-sample-skeleton.php as default) to create a new XLSX adding cell, html and sheet methods:

php phpxlsx-cli.php -a generate -m "cell, html, sheet"

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 phpxlsx license information.
-o, --output                            Output file for skeletons. Default as "phpxlsx-sample-skeleton.php".
-t, --template <template>               XLSX template.
    --view-methods                      Display available methods to be used when generating skeletons.

Skeleton methods

Supported methods in spreadsheets generated from scratch:

activeSheet
backgroundImage
break
cell
cellRange
chart
comment
csv
definedName
footer
function
getCell
header
html
image
link
mathEquation
properties
removeCell
rtl
settings
shape
sheet
style
svg
table
textBox

Supported methods in spreadsheets generated with a template:

getTemplateVariables
removeVariable
removeVariableImage
replaceImage
replaceText
setTemplateSymbol

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

php phpxlsx-cli.php -a generate -m "replaceImage, replaceText" -t template.xlsx

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

Other supported methods:

encrypt
protect
sign
stream
transform

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

php phpxsx-cli.php --view-methods

Examples

Generate a phpxlsx skeleton using cell, html and sheet methods:

php phpxlsx-cli.php -a generate -m "cell, sheet"

Generate a phpxlsx skeleton using a template and replaceImage and replaceText methods:

php phpxlsx-cli.php -a generate -m "replaceImage, replaceText" -t template.xlsx

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

php phpxlsx-cli.php -a generate -m "cell" -o custom-skeleton.php

Check server settings:

php phpxlsx-cli.php -a check

View phpxlsx license information:

php phpxlsx-cli.php -l