# tasks/ext/ioncube/IoncubeEncoderTask.php

$Id: IoncubeEncoderTask.php 1183 2011-06-22 13:31:31Z mrook $

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of voluntary contributions made by many individuals and is licensed under the LGPL. For more information please see http://phing.info.

## \IoncubeEncoderTask
jump to top

Package: phing\tasks\ext\ioncube

Invokes the ionCube Encoder (PHP4 or PHP5)

Parent(s)
  \Task < \ProjectComponent
Author
  Michiel Rook
Author
  Andrew Eddie
Author
  Domenico Sgarbossa
Since
  2.2.0
Version
  $Id: IoncubeEncoderTask.php 1183 2011-06-22 13:31:31Z mrook $

### Properties

`$comments= 'array()'`
Default value `array()`Details

Type
  n/a

`$encoderName= ''ioncube_encoder''`
Default value`'ioncube_encoder'`Details

Type
  n/a

`$fromDir= ''''`
Default value`''`Details

Type
  n/a

`$ionOptions= 'array()'`
Default value `array()`Details

Type
  n/a

`$ionOptionsXS= 'array()'`
Default value `array()`Details

Type
  n/a

`$ionSwitches= 'array()'`
Default value `array()`Details

Type
  n/a

`$ioncubePath= ''/usr/local/ioncube''`
Default value`'/usr/local/ioncube'`Details

Type
  n/a

`$phpVersion= ''5''`
Default value`'5'`Details

Type
  n/a

`$showCommandLine= 'false'`
Default value `false` Details

Type
  n/a

`$targetOption= ''''`
Default value`''`Details

Type
  n/a

`$toDir= ''''`
Default value`''`Details

Type
  n/a

### Methods

`addComment( $comment ) : void`

Adds a comment to be used in encoded files

Parameters

Name | Type | Description
--- | --- | ---
$comment |  |

`constructArguments( ) : void`

Constructs an argument string for the ionCube encoder

`getActionIfNoLoader( ) : void`

Returns the action-if-no-loader option

`getAllowEncodingIntoSource( ) : void`

Returns the allow-encoding-into-source option

`getAllowedServer( ) : void`

Returns the allowed server setting

`getBinary( ) : void`

Returns the binary option

`getCallbackFile( ) : void`

Returns the callback-file option

`getCopy( ) : void`

Returns the copy setting

`getDescription( ) : void`

`getEncode( ) : void`

Returns the encode setting

`getEncrypt( ) : void`

Returns regexps of additional files to encrypt (separated by space)

`getExpirein( ) : void`

Returns the expireIn setting

`getExpireon( ) : void`

Returns the expireOn setting

`getFromDir( ) : void`

Returns the source directory

`getIgnore( ) : void`

Returns the ignore setting

`getIgnoreDeprecatedWarnings( ) : void`

Returns the ignore-deprecated-warnings option

`getIgnoreStrictWarnings( ) : void`

Returns the ignore-strict-warnings option

`getIoncubePath( ) : void`

Returns the path to the ionCube encoder

`getKeep( ) : void`

Returns the ignore setting

`getLicensePath( ) : void`

Returns the path to the license file to use

`getLocation( ) : void`

`getMessageIfNoLoader( ) : void`

Returns the message-if-no-loader option

`getNoDocComments( ) : void`

Returns the no-doc-comments option

`getNoShortOpenTags( ) : void`

Returns the no-short-open-tags option

`getObfuscate( ) : void`

Returns the optimize option

`getObfuscationExclusionFile( ) : void`

Returns the obfuscation-exclusions-file option

`getObfuscationKey( ) : void`

Returns the optimize option

`getOptimize( ) : void`

Returns the optimize option

`getOwningTarget( ) : void`

`getPassPhrase( ) : void`

Returns the passphrase to use when encoding files

`getPhpVersion( ) : void`

Returns the version of PHP to use (defaults to 5)

`getProject( ) : void`

`getRegisterSlot( ) : void`

`getRuntimeConfigurableWrapper( ) : void`

`getTargetOption( ) : void`

Returns he option to use when encoding target directory already exists (defaults to none)

`getTaskName( ) : void`

`getTaskType( ) : void`

`getToDir( ) : void`

Returns the target directory

`getWithoutRuntimeLoaderSupport( ) : void`

Returns the without-runtime-loader-support option

`init( ) : void`

`log( ) : void`

`main( ) : void`

The main entry point

Throws

Exception | Description
--- | ---
\BuildException |

`maybeConfigure( ) : void`

`perform( ) : void`

`setActionIfNoLoader( $value ) : void`

Sets the action-if-no-loader option

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setAllowEncodingIntoSource( $value ) : void`

Sets the allow-encoding-into-source option

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setAllowedServer( $value ) : void`

Sets the allowed server

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setBinary( $value ) : void`

Sets the binary option

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setCallbackFile( $value ) : void`

Sets the callback-file option

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setCopy( $value ) : void`

Sets files or folders to copy (separated by space)

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setDescription( ) : void`

`setEncode( $value ) : void`

Sets additional file patterns, files or directories to encode, or to reverse the effect of copy (separated by space)

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setEncrypt( $value ) : void`

Sets regexps of additional files to encrypt (separated by space)

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setExpirein( $value ) : void`

Sets a period after which the files expire

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setExpireon( $value ) : void`

Sets a YYYY-MM-DD date to expire the files

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setFromDir( $value ) : void`

Sets the source directory

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setIgnore( $value ) : void`

Set files and directories to ignore entirely and exclude from the target directory (separated by space).

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setIgnoreDeprecatedWarnings( $value ) : void`

Sets the ignore-deprecated-warnings option

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setIgnoreStrictWarnings( $value ) : void`

Sets the ignore-strict-warnings option

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setIoncubePath( $value ) : void`

Sets the path to the ionCube encoder

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setKeep( $value ) : void`

Set files and directories not to be ignored (separated by space).

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setLicensePath( $value ) : void`

Sets the path to the license file to use

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setLocation( ) : void`

`setMessageIfNoLoader( $value ) : void`

Sets the message-if-no-loader option

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setNoDocComments( $value ) : void`

Sets the no-doc-comments option

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setNoShortOpenTags( $value ) : void`

Sets the no-short-open-tags option

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setObfuscate( $value ) : void`

Sets the obfuscate option

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setObfuscationExclusionFile( $value ) : void`

Sets the obfuscation-exclusions-file option

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setObfuscationKey( $value ) : void`

Sets the obfuscation key (required if using the obfuscate option)

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setOptimize( $value ) : void`

Sets the optimize option

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setOwningTarget( ) : void`

`setPassPhrase( $value ) : void`

Sets the passphrase to use when encoding files

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setPhpVersion( $value ) : void`

Sets the version of PHP to use (defaults to 5)

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setProject( ) : void`

`setRuntimeConfigurableWrapper( ) : void`

`setShowCommandLine( $value ) : void`

Sets whether to show command line before it is executed

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setTargetOption( $targetOption ) : void`

Sets the option to use when encoding target directory already exists (defaults to none)

Parameters

Name | Type | Description
--- | --- | ---
$targetOption |  |

`setTaskName( ) : void`

`setTaskType( ) : void`

`setToDir( $value ) : void`

Sets the target directory

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setWithoutRuntimeLoaderSupport( $value ) : void`

Sets the without-runtime-loader-support option

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

Documentation was generated by DocBlox 0.17.1.