tasks/ext/ioncube/IoncubeEncoderTask.php

Show: inherited
Table of Contents

$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

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

Propertyprivate  $comments= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $encoderName= ''ioncube_encoder''
Default value'ioncube_encoder'Details
Type
n/a
Propertyprivate  $fromDir= ''''
Default value''Details
Type
n/a
Propertyprivate  $ionOptions= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $ionOptionsXS= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $ionSwitches= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $ioncubePath= ''/usr/local/ioncube''
Default value'/usr/local/ioncube'Details
Type
n/a
Propertyprivate  $phpVersion= ''5''
Default value'5'Details
Type
n/a
Propertyprivate  $showCommandLine= 'false'
Default valuefalseDetails
Type
n/a
Propertyprivate  $targetOption= ''''
Default value''Details
Type
n/a
Propertyprivate  $toDir= ''''
Default value''Details
Type
n/a

Methods

methodpublicaddComment(  $comment ) : void

Adds a comment to be used in encoded files

Parameters
Name Type Description
$comment
methodprivateconstructArguments( ) : void

Constructs an argument string for the ionCube encoder

methodpublicgetActionIfNoLoader( ) : void

Returns the action-if-no-loader option

methodpublicgetAllowEncodingIntoSource( ) : void

Returns the allow-encoding-into-source option

methodpublicgetAllowedServer( ) : void

Returns the allowed server setting

methodpublicgetBinary( ) : void

Returns the binary option

methodpublicgetCallbackFile( ) : void

Returns the callback-file option

methodpublicgetCopy( ) : void

Returns the copy setting

methodpublicgetDescription( ) : void

methodpublicgetEncode( ) : void

Returns the encode setting

methodpublicgetEncrypt( ) : void

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

methodpublicgetExpirein( ) : void

Returns the expireIn setting

methodpublicgetExpireon( ) : void

Returns the expireOn setting

methodpublicgetFromDir( ) : void

Returns the source directory

methodpublicgetIgnore( ) : void

Returns the ignore setting

methodpublicgetIgnoreDeprecatedWarnings( ) : void

Returns the ignore-deprecated-warnings option

methodpublicgetIgnoreStrictWarnings( ) : void

Returns the ignore-strict-warnings option

methodpublicgetIoncubePath( ) : void

Returns the path to the ionCube encoder

methodpublicgetKeep( ) : void

Returns the ignore setting

methodpublicgetLicensePath( ) : void

Returns the path to the license file to use

methodpublicgetLocation( ) : void

methodpublicgetMessageIfNoLoader( ) : void

Returns the message-if-no-loader option

methodpublicgetNoDocComments( ) : void

Returns the no-doc-comments option

methodpublicgetNoShortOpenTags( ) : void

Returns the no-short-open-tags option

methodpublicgetObfuscate( ) : void

Returns the optimize option

methodpublicgetObfuscationExclusionFile( ) : void

Returns the obfuscation-exclusions-file option

methodpublicgetObfuscationKey( ) : void

Returns the optimize option

methodpublicgetOptimize( ) : void

Returns the optimize option

methodpublicgetOwningTarget( ) : void

methodpublicgetPassPhrase( ) : void

Returns the passphrase to use when encoding files

methodpublicgetPhpVersion( ) : void

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

methodpublicgetProject( ) : void

methodprotectedgetRegisterSlot( ) : void

methodpublicgetRuntimeConfigurableWrapper( ) : void

methodpublicgetTargetOption( ) : void

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

methodpublicgetTaskName( ) : void

methodpublicgetTaskType( ) : void

methodpublicgetToDir( ) : void

Returns the target directory

methodpublicgetWithoutRuntimeLoaderSupport( ) : void

Returns the without-runtime-loader-support option

methodpublicinit( ) : void

methodpubliclog( ) : void

methodpublicmain( ) : void

The main entry point

Throws
Exception Description
\BuildException
methodpublicmaybeConfigure( ) : void

methodpublicperform( ) : void

methodpublicsetActionIfNoLoader(  $value ) : void

Sets the action-if-no-loader option

Parameters
Name Type Description
$value
methodpublicsetAllowEncodingIntoSource(  $value ) : void

Sets the allow-encoding-into-source option

Parameters
Name Type Description
$value
methodpublicsetAllowedServer(  $value ) : void

Sets the allowed server

Parameters
Name Type Description
$value
methodpublicsetBinary(  $value ) : void

Sets the binary option

Parameters
Name Type Description
$value
methodpublicsetCallbackFile(  $value ) : void

Sets the callback-file option

Parameters
Name Type Description
$value
methodpublicsetCopy(  $value ) : void

Sets files or folders to copy (separated by space)

Parameters
Name Type Description
$value
methodpublicsetDescription( ) : void

methodpublicsetEncode(  $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
methodpublicsetEncrypt(  $value ) : void

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

Parameters
Name Type Description
$value
methodpublicsetExpirein(  $value ) : void

Sets a period after which the files expire

Parameters
Name Type Description
$value
methodpublicsetExpireon(  $value ) : void

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

Parameters
Name Type Description
$value
methodpublicsetFromDir(  $value ) : void

Sets the source directory

Parameters
Name Type Description
$value
methodpublicsetIgnore(  $value ) : void

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

Parameters
Name Type Description
$value
methodpublicsetIgnoreDeprecatedWarnings(  $value ) : void

Sets the ignore-deprecated-warnings option

Parameters
Name Type Description
$value
methodpublicsetIgnoreStrictWarnings(  $value ) : void

Sets the ignore-strict-warnings option

Parameters
Name Type Description
$value
methodpublicsetIoncubePath(  $value ) : void

Sets the path to the ionCube encoder

Parameters
Name Type Description
$value
methodpublicsetKeep(  $value ) : void

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

Parameters
Name Type Description
$value
methodpublicsetLicensePath(  $value ) : void

Sets the path to the license file to use

Parameters
Name Type Description
$value
methodpublicsetLocation( ) : void

methodpublicsetMessageIfNoLoader(  $value ) : void

Sets the message-if-no-loader option

Parameters
Name Type Description
$value
methodpublicsetNoDocComments(  $value ) : void

Sets the no-doc-comments option

Parameters
Name Type Description
$value
methodpublicsetNoShortOpenTags(  $value ) : void

Sets the no-short-open-tags option

Parameters
Name Type Description
$value
methodpublicsetObfuscate(  $value ) : void

Sets the obfuscate option

Parameters
Name Type Description
$value
methodpublicsetObfuscationExclusionFile(  $value ) : void

Sets the obfuscation-exclusions-file option

Parameters
Name Type Description
$value
methodpublicsetObfuscationKey(  $value ) : void

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

Parameters
Name Type Description
$value
methodpublicsetOptimize(  $value ) : void

Sets the optimize option

Parameters
Name Type Description
$value
methodpublicsetOwningTarget( ) : void

methodpublicsetPassPhrase(  $value ) : void

Sets the passphrase to use when encoding files

Parameters
Name Type Description
$value
methodpublicsetPhpVersion(  $value ) : void

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

Parameters
Name Type Description
$value
methodpublicsetProject( ) : void

methodpublicsetRuntimeConfigurableWrapper( ) : void

methodpublicsetShowCommandLine(  $value ) : void

Sets whether to show command line before it is executed

Parameters
Name Type Description
$value
methodpublicsetTargetOption(  $targetOption ) : void

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

Parameters
Name Type Description
$targetOption
methodpublicsetTaskName( ) : void

methodpublicsetTaskType( ) : void

methodpublicsetToDir(  $value ) : void

Sets the target directory

Parameters
Name Type Description
$value
methodpublicsetWithoutRuntimeLoaderSupport(  $value ) : void

Sets the without-runtime-loader-support option

Parameters
Name Type Description
$value
Documentation was generated by DocBlox 0.17.1.