tasks/ext/ioncube/IoncubeEncoderTask.php

Show: inherited
Table of Contents

\IoncubeEncoderTask

Package: phing\tasks\ext\ioncube

Invokes the ionCube Encoder (PHP4 or PHP5)

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

Parent(s)
\Task < \ProjectComponent
Author
Michiel Rook  
Author
Andrew Eddie  
Author
Domenico Sgarbossa  
Copyright
2001,2002 THYRELL. All rights reserved  
Since
2.2.0  
Version
$Id: a6ce870b3d14be7f365468e3a272e5ac16128e93 $  

Properties

Propertyprivate  $comments= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description
Details
Type
string
Inherited_from
\Task::$$description  
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
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Propertyprivate  $phpVersion= ''5''
Default value'5'Details
Type
n/a
Propertyprotected\Project  $project= 'null'
inherited

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

A reference to the current project instanceInherited from: \ProjectComponent::$$project\Task::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Propertyprivate  $showCommandLine= 'false'
Default valuefalseDetails
Type
n/a
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Propertyprivate  $targetOption= ''''
Default value''Details
Type
n/a
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Propertyprivate  $toDir= ''''
Default value''Details
Type
n/a
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  

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( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns
Type Description
string The text description of the task
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( ) : \Location
inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()
Returns
Type Description
\Location The location object describing the position of this task within the buildfile.
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( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetPassPhrase( ) : void

Returns the passphrase to use when encoding files

methodpublicgetPhpVersion( ) : void

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

methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()
Returns
Type Description
\Project Reference to current porject object
methodprotectedgetRegisterSlot( string $slotName ) : void
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()
Parameters
Name Type Description
$slotName string
methodpublicgetRuntimeConfigurableWrapper( ) : \RuntimeConfigurable
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()
Returns
Type Description
\RuntimeConfigurable The wrapper object used by this task
methodpublicgetTargetOption( ) : void

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

methodpublicgetTaskName( ) : string
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()
Returns
Type Description
string Name of this task
methodpublicgetTaskType( ) : string
inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()
Returns
Type Description
string The type of this task (XML Tag)
methodpublicgetToDir( ) : void

Returns the target directory

methodpublicgetWithoutRuntimeLoaderSupport( ) : void

Returns the without-runtime-loader-support option

methodpublicinit( ) : void
inherited

Called by the parser to let the task initialize properly.

Inherited from: \Task::init()

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

Throws
Exception Description
\BuildException
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()
Parameters
Name Type Description
$msg string

The message to log

$level integer

The priority of the message

Details
See
\BuildEvent  
See
\BuildListener  
methodpublicmain( ) : void

The main entry point

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Throws
Exception Description
\BuildException
methodpublicmaybeConfigure( ) : void
inherited

Configure this task if it hasn't been done already.

Inherited from: \Task::maybeConfigure()
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()
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( string $desc ) : void
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()
Parameters
Name Type Description
$desc string

The text describing the task

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( \Location $location ) : void
inherited

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

Inherited from: \Task::setLocation()
Parameters
Name Type Description
$location \Location

The location object describing the position of this task within the buildfile.

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( \Target $target ) : void
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()
Parameters
Name Type Description
$target \Target

Reference to owning target

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( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetRuntimeConfigurableWrapper( \RuntimeConfigurable $wrapper ) : void
inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()
Parameters
Name Type Description
$wrapper \RuntimeConfigurable

The wrapper object this task should use

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( string $name ) : string
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()
Parameters
Name Type Description
$name string
Returns
Type Description
string A string representing the name of this task for log
methodpublicsetTaskType( string $name ) : void
inherited

Sets the type of the task. Usually this is the name of the XML tag

Inherited from: \Task::setTaskType()
Parameters
Name Type Description
$name string

The type of this task (XML Tag)

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.18.1.