tasks/ext/ioncube/IoncubeEncoderTask.php

Show:

inherited

Classes
- \IoncubeEncoderTask

Table of Contents

\IoncubeEncoderTask
jump to top

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


                 $comments= 'array()'

Default valuearray()Details

Type: n/a

string
                 $description= ''

inherited

Description of the task

Inherited from: \Task::$$description

Details

Type: string
Inherited_from: \Task::$$description


                 $encoderName= ''ioncube_encoder''

Default value'ioncube_encoder'Details

Type: n/a


                 $fromDir= ''''

Default value''Details

Type: n/a


                 $ionOptions= 'array()'

Default valuearray()Details

Type: n/a


                 $ionOptionsXS= 'array()'

Default valuearray()Details

Type: n/a


                 $ionSwitches= 'array()'

Default valuearray()Details

Type: n/a


                 $ioncubePath= ''/usr/local/ioncube''

Default value'/usr/local/ioncube'Details

Type: n/a

\Location
                 $location= ''

inherited

Stored buildfile location

Inherited from: \Task::$$location

Details

Type: \Location
Inherited_from: \Task::$$location


                 $phpVersion= ''5''

Default value'5'Details

Type: n/a

\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


                 $showCommandLine= 'false'

Default valuefalseDetails

Type: n/a

\Target
                 $target= ''

inherited

Owning Target object

Inherited from: \Task::$$target

Details

Type: \Target
Inherited_from: \Task::$$target


                 $targetOption= ''''

Default value''Details

Type: n/a

string
                 $taskName= ''

inherited

Taskname for logger

Inherited from: \Task::$$taskName

Details

Type: string
Inherited_from: \Task::$$taskName

string
                 $taskType= ''

inherited

Internal taskname (req)

Inherited from: \Task::$$taskType

Details

Type: string
Inherited_from: \Task::$$taskType


                 $toDir= ''''

Default value''Details

Type: n/a

\RuntimeConfigurable
                 $wrapper= ''

inherited

Wrapper of the task

Inherited from: \Task::$$wrapper

Details

Type: \RuntimeConfigurable
Inherited_from: \Task::$$wrapper

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

inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()

Returns

Type	Description
string	The text description of the task

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(
          
          )
        
        :
          \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.

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(
          
          )
        
        :
          \Target

inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()

Returns

Type	Description
\Target	The target object that owns this task

getPassPhrase(
          
          )
        
        :
          void

Returns the passphrase to use when encoding files

getPhpVersion(
          
          )
        
        :
          void

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

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRegisterSlot(
          string $slotName
          )
        
        :
          void

inherited

Returns a name

Inherited from: \Task::getRegisterSlot()

Parameters

Name	Type	Description
$slotName	string

getRuntimeConfigurableWrapper(
          
          )
        
        :
          \RuntimeConfigurable

inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()

Returns

Type	Description
\RuntimeConfigurable	The wrapper object used by this task

getTargetOption(
          
          )
        
        :
          void

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

getTaskName(
          
          )
        
        :
          string

inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()

Returns

Type	Description
string	Name of this task

getTaskType(
          
          )
        
        :
          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)

getToDir(
          
          )
        
        :
          void

Returns the target directory

getWithoutRuntimeLoaderSupport(
          
          )
        
        :
          void

Returns the without-runtime-loader-support option

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

log(
          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

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

maybeConfigure(
          
          )
        
        :
          void

inherited

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

Inherited from: \Task::maybeConfigure()

perform(
          
          )
        
        :
          void

inherited

Perfrom this task

Inherited from: \Task::perform()

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(
          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

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(
          \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.

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(
          \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

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(
          \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

setRuntimeConfigurableWrapper(
          \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

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(
          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

setTaskType(
          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)

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

tasks/ext/ioncube/IoncubeEncoderTask.php

\IoncubeEncoderTaskjump to top

Properties

Methods

\IoncubeEncoderTask
jump to top