The IoncubeEncoderTask executes the ionCube encoder (for either
PHP4 or PHP5 projects).
For more information on the meaning of the various options please consult the ionCube user guide.
Table C.49: Attributes
| Name | Type | Description | Default | Required |
|---|---|---|---|---|
allowedserver | String | Restricts the encoded files to particular servers and/or domains. Consult the IonCude documentation for more information. | none | No |
binary | Boolean | Whether to save encoded files in binary format (default is ASCII format) | false | No |
copy | String | Specifies files or directories to exclude from being encoded or encrypted and copy them to the target directory (separated by space). | none | No |
encode | String | Specifies additional file patterns, files or directories to encode,
or to reverse the effect of copy | none | No |
encrypt | String | Specify files or directories (space separated list) that are to be encrypted. | none | No |
expirein | String | Sets a period in seconds (s), minutes (m), hours (h) or days (d)
after which the files expire. Accepts: 500s or
55m or 24h or
7d | none | No |
expireon | String | Sets a YYYY-MM-DD date to expire the files. | none | No |
fromdir | String | Path containing source files | none | Yes |
ignore | String | Set files and directories to ignore entirely and exclude from the target directory (separated by space). | none | Yes |
ioncubepath | String | Path to the ionCube binaries | /usr/local/ioncube | No |
keep | String | Set files and directories not to be ignored (separated by space). | none | No |
licensepath | String | Path to the license file that will be used by the encoded files | none | No |
nodoccomments | String | Omits documents comments ( /** ... */ ) from the encoded files. | none | No |
| obfuscationkey | String | The obfuscation key must be supplied when using the obfuscate option | none | No |
obfuscate | String | The Encoder can obfuscate the names of global functions, the names of
local variables in global functions, and line numbers. Use either
all or any of functions,
locals or linenos separated by
a space. | none | No |
optimize | String | Controls the optimization of the encoded files, accepts either
more or max | none | No |
passphrase | String | The passphrase to use when encoding with a license file | none | No |
phpversion | String | Defines which php encoder version will be used (suffix of the encoder file) | 5 | No |
targetoption | String | Option to use when target directory exists, accepts
replace, merge,
update and rename | none | No |
todir | String | Path to save encoded files to | none | Yes |
withoutruntimeloadersupport | Boolean | Whether to disable support for runtime initialization of the ionCube Loader | false | No |
noshortopentags | Boolean | Whether to disable support for short PHP tags | false | No |
callbackfile | String | Path to callback file (.php) | n/a | No |
obfuscationexclusionsfile | String | Path to obfuscation exclusions file | n/a | No |
ignoredeprecatedwarnings | Boolean | Whether to ignore deprecated warnings | false | No |
ignorestrictwarnings | Boolean | Whether to ignore strict warnings | false | No |
allowencodingintosource | Boolean | Whether to allow encoding into the source tree | false | No |
messageifnoloader | String | A valid PHP expression to customize the "no loader installed" message | n/a | No |
actionifnoloader | String | A valid PHP expression to replace the "no loader installed" action | n/a | No |
showcommandline | Boolean | whether to show command line before it is executed | false | No |
<ioncubeencoder binary="true" copy="*.ini config/*" encode="*.inc licenses/license.key" encrypt="*.tpl *.xml" fromdir="files" ignore="*.bak RCS/ *~ docs/" ioncubepath="/usr/local/ioncube" keep="docs/README" licensepath="mylicense.txt" optimize="max" passphrase="mypassphrase" phpversion="4" noshortopentags="false" targetoption="replace" todir="encoded" withoutruntimeloadersupport="true" callbackfile="errhandler.php" obfuscationexlusionsfile="obfex.txt"> <comment>A project encoded with the ionCube encoder.</comment> </ioncubeencoder>