phing-tasks-ext-ioncube

# Class: IoncubeEncoderTask Source Location: /tasks/ext/ioncube/IoncubeEncoderTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --IoncubeEncoderTask
Invokes the ionCube Encoder (PHP4 or PHP5) #### Author(s): Michiel Rook <michiel.rook@gmail.com> Andrew Eddie <andrew.eddie@jamboworks.com> #### Version: $Id: IoncubeEncoderTask.php 552 2009-08-29 12:18:13Z mrook $ #### Copyright: � 2001,2002 THYRELL. All rights reserved | ### Methods addComment getAllowedServer getBinary getCopy getEncode getEncrypt getExpirein getExpireon getFromDir getIgnore getIoncubePath getKeep getLicensePath getNoDocComments getObfuscate getObfuscationKey getOptimize getPassPhrase getPhpVersion getTargetOption getToDir getWithoutRuntimeLoaderSupport main setAllowedServer setBinary setCopy setEncode setEncrypt setExpirein setExpireon setFromDir setIgnore setIoncubePath setKeep setLicensePath setNoDocComments setObfuscate setObfuscationKey setOptimize setPassPhrase setPhpVersion setTargetOption setToDir setWithoutRuntimeLoaderSupport
### Inherited Variables #### Class: Task Task::$description Task::$location Task::$target Task::$taskName Task::$taskType Task::$wrapper #### Class: ProjectComponent ProjectComponent::$project | ### Inherited Methods #### Class: Task Task::getDescription() Returns the textual description of the task Task::getLocation() Returns the location within the buildfile this task occurs. Used by BuildException to give detailed error messages. Task::getOwningTarget() Returns the owning target of this task. Task::getRegisterSlot() Returns a name Task::getRuntimeConfigurableWrapper() Returns the wrapper object for runtime configuration Task::getTaskName() Returns the name of task, used only for log messages Task::getTaskType() Returns the name of the task under which it was invoked, usually the XML tagname Task::init() Called by the parser to let the task initialize properly. Task::log() Provides a project level log event to the task. Task::main() Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice. Task::maybeConfigure() Configure this task if it hasn't been done already. Task::perform() Perfrom this task Task::setDescription() Sets a textual description of the task Task::setLocation() Sets the location within the buildfile this task occurs. Called by the parser to set location information. Task::setOwningTarget() Sets the owning target this task belongs to. Task::setRuntimeConfigurableWrapper() Sets the wrapper object this task should use for runtime configurable elements. Task::setTaskName() Sets the name of this task for log messages Task::setTaskType() Sets the type of the task. Usually this is the name of the XML tag #### Class: ProjectComponent ProjectComponent::getProject() Returns a reference to current project ProjectComponent::log() Logs a message with the given priority. ProjectComponent::setProject() References the project to the current component.
### Class Details [line 34] Invokes the ionCube Encoder (PHP4 or PHP5) #### Tags:
author: | Michiel Rook <michiel.rook@gmail.com>
author: | Andrew Eddie <andrew.eddie@jamboworks.com>
version: | $Id: IoncubeEncoderTask.php 552 2009-08-29 12:18:13Z mrook $
copyright: | � 2001,2002 THYRELL. All rights reserved
since: | 2.2.0
[ Top ] ### Class Methods ### method addComment [line 59]
`void addComment( IoncubeComment $comment)`
Adds a comment to be used in encoded files #### Parameters:
IoncubeComment | $comment |
[ Top ] ### method getAllowedServer [line 75]
`void getAllowedServer( )`
Returns the allowed server setting [ Top ] ### method getBinary [line 91]
`void getBinary( )`
Returns the binary option [ Top ] ### method getCopy [line 107]
`void getCopy( )`
Returns the copy setting [ Top ] ### method getEncode [line 124]
`void getEncode( )`
Returns the encode setting [ Top ] ### method getEncrypt [line 140]
`void getEncrypt( )`
Returns regexps of additional files to encrypt (separated by space) [ Top ] ### method getExpirein [line 156]
`void getExpirein( )`
Returns the expireIn setting [ Top ] ### method getExpireon [line 172]
`void getExpireon( )`
Returns the expireOn setting [ Top ] ### method getFromDir [line 188]
`void getFromDir( )`
Returns the source directory [ Top ] ### method getIgnore [line 205]
`void getIgnore( )`
Returns the ignore setting [ Top ] ### method getIoncubePath [line 221]
`void getIoncubePath( )`
Returns the path to the ionCube encoder [ Top ] ### method getKeep [line 237]
`void getKeep( )`
Returns the ignore setting [ Top ] ### method getLicensePath [line 253]
`void getLicensePath( )`
Returns the path to the license file to use [ Top ] ### method getNoDocComments [line 269]
`void getNoDocComments( )`
Returns the no-doc-comments option [ Top ] ### method getObfuscate [line 285]
`void getObfuscate( )`
Returns the optimize option [ Top ] ### method getObfuscationKey [line 301]
`void getObfuscationKey( )`
Returns the optimize option [ Top ] ### method getOptimize [line 317]
`void getOptimize( )`
Returns the optimize option [ Top ] ### method getPassPhrase [line 333]
`void getPassPhrase( )`
Returns the passphrase to use when encoding files [ Top ] ### method getPhpVersion [line 349]
`void getPhpVersion( )`
Returns the version of PHP to use (defaults to 5) [ Top ] ### method getTargetOption [line 397]
`void getTargetOption( )`
Returns he option to use when encoding target directory already exists (defaults to none) [ Top ] ### method getToDir [line 365]
`void getToDir( )`
Returns the target directory [ Top ] ### method getWithoutRuntimeLoaderSupport [line 381]
`void getWithoutRuntimeLoaderSupport( )`
Returns the without-runtime-loader-support option [ Top ] ### method main [line 407]
`void main( )`
The main entry point #### Tags:
throws: | BuildException
Overrides Task::main() (Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.) [ Top ] ### method setAllowedServer [line 67]
`void setAllowedServer( $value)`
Sets the allowed server #### Parameters:
| $value |
[ Top ] ### method setBinary [line 83]
`void setBinary( $value)`
Sets the binary option #### Parameters:
| $value |
[ Top ] ### method setCopy [line 99]
`void setCopy( $value)`
Sets files or folders to copy (separated by space) #### Parameters:
| $value |
[ Top ] ### method setEncode [line 116]
`void setEncode( $value)`
Sets additional file patterns, files or directories to encode, or to reverse the effect of copy (separated by space) #### Parameters:
| $value |
[ Top ] ### method setEncrypt [line 132]
`void setEncrypt( $value)`
Sets regexps of additional files to encrypt (separated by space) #### Parameters:
| $value |
[ Top ] ### method setExpirein [line 148]
`void setExpirein( $value)`
Sets a period after which the files expire #### Parameters:
| $value |
[ Top ] ### method setExpireon [line 164]
`void setExpireon( $value)`
Sets a YYYY-MM-DD date to expire the files #### Parameters:
| $value |
[ Top ] ### method setFromDir [line 180]
`void setFromDir( $value)`
Sets the source directory #### Parameters:
| $value |
[ Top ] ### method setIgnore [line 197]
`void setIgnore( $value)`
Set files and directories to ignore entirely and exclude from the target directory (separated by space). #### Parameters:
| $value |
[ Top ] ### method setIoncubePath [line 213]
`void setIoncubePath( $value)`
Sets the path to the ionCube encoder #### Parameters:
| $value |
[ Top ] ### method setKeep [line 229]
`void setKeep( $value)`
Set files and directories not to be ignored (separated by space). #### Parameters:
| $value |
[ Top ] ### method setLicensePath [line 245]
`void setLicensePath( $value)`
Sets the path to the license file to use #### Parameters:
| $value |
[ Top ] ### method setNoDocComments [line 261]
`void setNoDocComments( $value)`
Sets the no-doc-comments option #### Parameters:
| $value |
[ Top ] ### method setObfuscate [line 277]
`void setObfuscate( $value)`
Sets the obfuscate option #### Parameters:
| $value |
[ Top ] ### method setObfuscationKey [line 293]
`void setObfuscationKey( $value)`
Sets the obfuscation key (required if using the obfuscate option) #### Parameters:
| $value |
[ Top ] ### method setOptimize [line 309]
`void setOptimize( $value)`
Sets the optimize option #### Parameters:
| $value |
[ Top ] ### method setPassPhrase [line 325]
`void setPassPhrase( $value)`
Sets the passphrase to use when encoding files #### Parameters:
| $value |
[ Top ] ### method setPhpVersion [line 341]
`void setPhpVersion( $value)`
Sets the version of PHP to use (defaults to 5) #### Parameters:
| $value |
[ Top ] ### method setTargetOption [line 389]
`void setTargetOption( $targetOption)`
Sets the option to use when encoding target directory already exists (defaults to none) #### Parameters:
| $targetOption |
[ Top ] ### method setToDir [line 357]
`void setToDir( $value)`
Sets the target directory #### Parameters:
| $value |
[ Top ] ### method setWithoutRuntimeLoaderSupport [line 373]
`void setWithoutRuntimeLoaderSupport( $value)`
Sets the without-runtime-loader-support option #### Parameters:
| $value |
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:51:08 +0200 by phpDocumentor 1.4.3