phppptx CLI command

Information

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

How to use

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

php phppptx-cli.php

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

For example, the following command generates a skeleton (phppptx-sample-skeleton.php as default) to create a new PPTX adding html, list and text methods:

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

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

Skeleton methods

Supported methods in presentations generated from scratch:

activeSlide
audio
backgroundColor
backgroundImage
chart
comment
footer
html
image
link
list
mathEquation
notes
properties
removeShape
rtl
section
shape
slide
settings
svg
table
text
textBox
video

Supported methods in presentations generated with a template:

getTemplateVariables
removeNotes
removeVariable
removeVariableAudio
removeVariableImage
removeVariableVideo
replaceAudio
replaceImage
replaceList
replaceTable
replaceText
replaceVideo
setTemplateSymbol

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

php phppptx-cli.php -a generate -m "replaceImage, replaceList, replaceText" -t template.pptx

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

Other supported methods:

encrypt
merge
sign
stream
transform

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

php phppptx-cli.php --view-methods

Examples

Generate a phppptx skeleton using html, list and text methods:

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

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

php phppptx-cli.php -a generate -m "replaceImage, replaceList, replaceText" -t template.pptx

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

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

Check server settings:

php phppptx-cli.php -a check

View phppptx license information:

php phppptx-cli.php -l