tasks/ext/ioncube/IoncubeEncoderTask.php
\IoncubeEncoderTask
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


\Project
$project= 'null'
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::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
Methods


addComment(
$comment
)
:
void
Adds a comment to be used in encoded files
Name | Type | Description |
---|---|---|
$comment |


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Inherited from: \Task::getLocation()Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()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)


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Inherited from: \Task::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


init(
)
:
void
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
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.
Exception | Description |
---|---|
\BuildException |


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()

setActionIfNoLoader(
$value
)
:
void
Sets the action-if-no-loader option
Name | Type | Description |
---|---|---|
$value |


setAllowEncodingIntoSource(
$value
)
:
void
Sets the allow-encoding-into-source option
Name | Type | Description |
---|---|---|
$value |


setCallbackFile(
$value
)
:
void
Sets the callback-file option
Name | Type | Description |
---|---|---|
$value |


setCopy(
$value
)
:
void
Sets files or folders to copy (separated by space)
Name | Type | Description |
---|---|---|
$value |


setDescription(
string $desc
)
:
void
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)
Name | Type | Description |
---|---|---|
$value |


setEncrypt(
$value
)
:
void
Sets regexps of additional files to encrypt (separated by space)
Name | Type | Description |
---|---|---|
$value |


setExpirein(
$value
)
:
void
Sets a period after which the files expire
Name | Type | Description |
---|---|---|
$value |


setExpireon(
$value
)
:
void
Sets a YYYY-MM-DD date to expire the files
Name | Type | Description |
---|---|---|
$value |


setIgnore(
$value
)
:
void
Set files and directories to ignore entirely and exclude from the target directory (separated by space).
Name | Type | Description |
---|---|---|
$value |


setIgnoreDeprecatedWarnings(
$value
)
:
void
Sets the ignore-deprecated-warnings option
Name | Type | Description |
---|---|---|
$value |


setIgnoreStrictWarnings(
$value
)
:
void
Sets the ignore-strict-warnings option
Name | Type | Description |
---|---|---|
$value |


setIoncubePath(
$value
)
:
void
Sets the path to the ionCube encoder
Name | Type | Description |
---|---|---|
$value |


setKeep(
$value
)
:
void
Set files and directories not to be ignored (separated by space).
Name | Type | Description |
---|---|---|
$value |


setLicensePath(
$value
)
:
void
Sets the path to the license file to use
Name | Type | Description |
---|---|---|
$value |


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Inherited from: \Task::setLocation()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
Name | Type | Description |
---|---|---|
$value |


setNoDocComments(
$value
)
:
void
Sets the no-doc-comments option
Name | Type | Description |
---|---|---|
$value |


setNoShortOpenTags(
$value
)
:
void
Sets the no-short-open-tags option
Name | Type | Description |
---|---|---|
$value |


setObfuscationExclusionFile(
$value
)
:
void
Sets the obfuscation-exclusions-file option
Name | Type | Description |
---|---|---|
$value |


setObfuscationKey(
$value
)
:
void
Sets the obfuscation key (required if using the obfuscate option)
Name | Type | Description |
---|---|---|
$value |


setOwningTarget(
\Target $target
)
:
void
Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setPassPhrase(
$value
)
:
void
Sets the passphrase to use when encoding files
Name | Type | Description |
---|---|---|
$value |


setPhpVersion(
$value
)
:
void
Sets the version of PHP to use (defaults to 5)
Name | Type | Description |
---|---|---|
$value |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\Task::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()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
Name | Type | Description |
---|---|---|
$value |


setTargetOption(
$targetOption
)
:
void
Sets the option to use when encoding target directory already exists (defaults to none)
Name | Type | Description |
---|---|---|
$targetOption |


setTaskName(
string $name
)
:
string
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |