classes/phing/tasks/ext/ioncube/IoncubeEncoderTask.php

\IoncubeEncoderTask
jump to top

Invokes the ionCube Encoder (PHP4 or PHP5)

Use {@link Project#createTask} to register a new Task.

Extends from
\Task
author
Michiel Rook
author
Andrew Eddie
author
Domenico Sgarbossa
copyright
2001,2002 THYRELL. All rights reserved
package
phing.tasks.ext.ioncube
since
2.2.0
version
$Id: IoncubeEncoderTask.php 1183 2011-06-22 13:31:31Z mrook $

Properties

Propertyprivate  $comments= 'array'
Default valuearrayDetails
Type
Propertyprivate  $encoderName= 'ioncube_encoder'
Default valueioncube_encoderDetails
Type
Propertyprivate  $fromDir= ''
Details
Type
Propertyprivate  $ionOptions= 'array'
Default valuearrayDetails
Type
Propertyprivate  $ionOptionsXS= 'array'
Default valuearrayDetails
Type
Propertyprivate  $ionSwitches= 'array'
Default valuearrayDetails
Type
Propertyprivate  $ioncubePath= '/usr/local/ioncube'
Default value/usr/local/ioncubeDetails
Type
Propertyprivate  $phpVersion= '5'
Default value5Details
Type
Propertyprivate  $showCommandLine= 'false'
Default valuefalseDetails
Type
Propertyprivate  $targetOption= ''
Details
Type
Propertyprivate  $toDir= ''
Details
Type

Methods

methodpublic  addComment(  $comment ) :
Adds a comment to be used in encoded files
Parameters
Name Type Description
$comment
methodprivate  constructArguments( ) :
Constructs an argument string for the ionCube encoder
methodpublic  getActionIfNoLoader( ) :
Returns the action-if-no-loader option
methodpublic  getAllowEncodingIntoSource( ) :
Returns the allow-encoding-into-source option
methodpublic  getAllowedServer( ) :
Returns the allowed server setting
methodpublic  getBinary( ) :
Returns the binary option
methodpublic  getCallbackFile( ) :
Returns the callback-file option
methodpublic  getCopy( ) :
Returns the copy setting
methodpublic  getEncode( ) :
Returns the encode setting
methodpublic  getEncrypt( ) :
Returns regexps of additional files to encrypt (separated by space)
methodpublic  getExpirein( ) :
Returns the expireIn setting
methodpublic  getExpireon( ) :
Returns the expireOn setting
methodpublic  getFromDir( ) :
Returns the source directory
methodpublic  getIgnore( ) :
Returns the ignore setting
methodpublic  getIgnoreDeprecatedWarnings( ) :
Returns the ignore-deprecated-warnings option
methodpublic  getIgnoreStrictWarnings( ) :
Returns the ignore-strict-warnings option
methodpublic  getIoncubePath( ) :
Returns the path to the ionCube encoder
methodpublic  getKeep( ) :
Returns the ignore setting
methodpublic  getLicensePath( ) :
Returns the path to the license file to use
methodpublic  getMessageIfNoLoader( ) :
Returns the message-if-no-loader option
methodpublic  getNoDocComments( ) :
Returns the no-doc-comments option
methodpublic  getNoShortOpenTags( ) :
Returns the no-short-open-tags option
methodpublic  getObfuscate( ) :
Returns the optimize option
methodpublic  getObfuscationExclusionFile( ) :
Returns the obfuscation-exclusions-file option
methodpublic  getObfuscationKey( ) :
Returns the optimize option
methodpublic  getOptimize( ) :
Returns the optimize option
methodpublic  getPassPhrase( ) :
Returns the passphrase to use when encoding files
methodpublic  getPhpVersion( ) :
Returns the version of PHP to use (defaults to 5)
methodpublic  getTargetOption( ) :
Returns he option to use when encoding target directory already exists (defaults to none)
methodpublic  getToDir( ) :
Returns the target directory
methodpublic  getWithoutRuntimeLoaderSupport( ) :
Returns the without-runtime-loader-support option
methodpublic  main( ) :
The main entry point
Details
throws
methodpublic  setActionIfNoLoader(  $value ) :
Sets the action-if-no-loader option
Parameters
Name Type Description
$value
methodpublic  setAllowEncodingIntoSource(  $value ) :
Sets the allow-encoding-into-source option
Parameters
Name Type Description
$value
methodpublic  setAllowedServer(  $value ) :
Sets the allowed server
Parameters
Name Type Description
$value
methodpublic  setBinary(  $value ) :
Sets the binary option
Parameters
Name Type Description
$value
methodpublic  setCallbackFile(  $value ) :
Sets the callback-file option
Parameters
Name Type Description
$value
methodpublic  setCopy(  $value ) :
Sets files or folders to copy (separated by space)
Parameters
Name Type Description
$value
methodpublic  setEncode(  $value ) :
Sets additional file patterns, files or directories to encode, or to reverse the effect of copy (separated by space)
Parameters
Name Type Description
$value
methodpublic  setEncrypt(  $value ) :
Sets regexps of additional files to encrypt (separated by space)
Parameters
Name Type Description
$value
methodpublic  setExpirein(  $value ) :
Sets a period after which the files expire
Parameters
Name Type Description
$value
methodpublic  setExpireon(  $value ) :
Sets a YYYY-MM-DD date to expire the files
Parameters
Name Type Description
$value
methodpublic  setFromDir(  $value ) :
Sets the source directory
Parameters
Name Type Description
$value
methodpublic  setIgnore(  $value ) :
Set files and directories to ignore entirely and exclude from the target directory (separated by space).
Parameters
Name Type Description
$value
methodpublic  setIgnoreDeprecatedWarnings(  $value ) :
Sets the ignore-deprecated-warnings option
Parameters
Name Type Description
$value
methodpublic  setIgnoreStrictWarnings(  $value ) :
Sets the ignore-strict-warnings option
Parameters
Name Type Description
$value
methodpublic  setIoncubePath(  $value ) :
Sets the path to the ionCube encoder
Parameters
Name Type Description
$value
methodpublic  setKeep(  $value ) :
Set files and directories not to be ignored (separated by space).
Parameters
Name Type Description
$value
methodpublic  setLicensePath(  $value ) :
Sets the path to the license file to use
Parameters
Name Type Description
$value
methodpublic  setMessageIfNoLoader(  $value ) :
Sets the message-if-no-loader option
Parameters
Name Type Description
$value
methodpublic  setNoDocComments(  $value ) :
Sets the no-doc-comments option
Parameters
Name Type Description
$value
methodpublic  setNoShortOpenTags(  $value ) :
Sets the no-short-open-tags option
Parameters
Name Type Description
$value
methodpublic  setObfuscate(  $value ) :
Sets the obfuscate option
Parameters
Name Type Description
$value
methodpublic  setObfuscationExclusionFile(  $value ) :
Sets the obfuscation-exclusions-file option
Parameters
Name Type Description
$value
methodpublic  setObfuscationKey(  $value ) :
Sets the obfuscation key (required if using the obfuscate option)
Parameters
Name Type Description
$value
methodpublic  setOptimize(  $value ) :
Sets the optimize option
Parameters
Name Type Description
$value
methodpublic  setPassPhrase(  $value ) :
Sets the passphrase to use when encoding files
Parameters
Name Type Description
$value
methodpublic  setPhpVersion(  $value ) :
Sets the version of PHP to use (defaults to 5)
Parameters
Name Type Description
$value
methodpublic  setShowCommandLine(  $value ) :
Sets whether to show command line before it is executed
Parameters
Name Type Description
$value
methodpublic  setTargetOption(  $targetOption ) :
Sets the option to use when encoding target directory already exists (defaults to none)
Parameters
Name Type Description
$targetOption
methodpublic  setToDir(  $value ) :
Sets the target directory
Parameters
Name Type Description
$value
methodpublic  setWithoutRuntimeLoaderSupport(  $value ) :
Sets the without-runtime-loader-support option
Parameters
Name Type Description
$value
Documentation was generated by DocBlox 0.13.1.