tasks/ext/zendguard/ZendGuardEncodeTask.php
inherited
Classes
\ZendGuardEncodeTask
Encodes files using Zeng Guard Encoder
- Parent(s)
- \MatchingTask < \Task < \ProjectComponent
- Author
- Petr Rybak
- Since
- 2.4.3
- Version
- $Id: ZendGuardEncodeTask.php 1084 2011-05-06 09:55:25Z mrook $
Properties
bool
$aspTags= 'false'
Turn ASP tag (“<%” ) recognition on/off. (default: off). On or off must be specified as an argument when using this option.
The default, when this option is not used in the command-line, is - off
falseDetails- Type
- bool
bool
$deleteSource= 'true'
Permanently deletes (see warning below) the original source files specified in the SourceInputPath and saves the encoded files in its place.
This option has no option parameter. When this option is use, do not use the output_file parameter.
Warning: To avoid permanent loss of non-encoded scripts, make a backup. Deleted files cannot be restored or recovered and will be permanently deleted with this option. If you are unsure about deleting the source files, use the ––rename-source option instead
trueDetails- Type
- bool
$encodeCommand= ''
- Type
- n/a
bool
$encodedOnly= 'false'
Force cooperation with other encoded files only. This option generates files that work exclusively with associated encoded files. Associated encoded files are those generated by the same company. Files that do not share the same encoded company association cannot call these files
falseDetails- Type
- bool
string
$expires= 'null'
Make an encoded file to expire on the given date. Date is in yyyy-mm-dd format.
nullDetails- Type
- string
$filesets= 'array()'
array()Details- Type
- n/a
bool
$forceEncode= 'false'
Allow encoding previously encoded files. (NOT recommended!)
falseDetails- Type
- bool
bool
$ignoreFileModes= 'false'
If true the ownership, permissions and timestamps of the encoded files won't be preserved.
falseDetails- Type
- bool
bool
$licenseProduct= 'false'
Enable licensing.
If enabled, productName must be defined.
falseDetails- Type
- bool
bool
$noHeader= 'false'
Disables the PHP-compatible header that is added to the top of every encoded file by default. Encoded files generated with this option will not display a meaningful error when loaded by PHP that doesn't have the Zend Optimizer properly installed.
Using this option saves approximately 1.5KB for every encoded file. Do not use it unless disk space constraints are critica
falseDetails- Type
- bool
int
$obfuscationLevel= '0'
Level of obfuscation. Defaults to 0 (no obfuscation).
0Details- Type
- int
int
$optMask= 'null'
Optimization mask. (default value: [+++++++]) opt_mask is an integer representing a bit-mask.
The default value enables all of the optimization passes. Each optimization pass of the Zend Optimizer can be turned on or off based on the mask entered
nullDetails- Type
- int
string
$privateKeyPath= 'null'
Path to private key for licensing
nullDetails- Type
- string
string
$productName= 'null'
Product name. Must be defined if licenseProduct or signProduct is set to 1
nullDetails- Type
- string
string
$prologFile= 'null'
Embed the information in the specified file into the header of the encoded file (overrides noHeader)
nullDetails- Type
- string
string
$renameSourceExt= 'null'
Move the original source file to <input_file>.<renameSourceExt> and save the encoded file in its place.
If specified deleteSource will be automatically disabled.
nullDetails- Type
- string
bool
$shortTags= 'true'
Turns short PHP tag (“<?” ) recognition either on or off.
On or off must be specified as an argument when using this option. The default, when option is not used in the command-line, is - on
trueDetails- Type
- bool
bool
$signProduct= 'false'
Enable signing If enabled, productName must be defined.
falseDetails- Type
- bool
bool
$useCrypto= 'false'
If cryptography should be used to encode the source code
falseDetails- Type
- bool
string
$zendEncoderPath= 'null'
Path to the zend encoder binary
nullDetails- Type
- string
Methods
__construct(
)
:
voidappendSelector(
)
:
voidcreateAnd(
)
:
voidcreateContains(
)
:
voidcreateCustom(
)
:
voidcreateDate(
)
:
voidcreateDepend(
)
:
voidcreateDepth(
)
:
voidcreateExclude(
)
:
voidcreateExcludesFile(
)
:
voidcreateFilename(
)
:
voidcreateInclude(
)
:
voidcreateIncludesFile(
)
:
voidcreateMajority(
)
:
voidcreateNone(
)
:
voidcreateNot(
)
:
voidcreateOr(
)
:
voidcreatePatternSet(
)
:
voidcreatePresent(
)
:
voidcreateSelector(
)
:
voidcreateSize(
)
:
voidencodeFile(
string $filePath
)
:
voidEncodes a file using currently defined Zend Guard settings
| Name | Type | Description |
|---|---|---|
| $filePath | string | Path to the encoded file |
getDescription(
)
:
voidgetDirectoryScanner(
)
:
voidgetImplicitFileSet(
)
:
voidgetLocation(
)
:
voidgetOwningTarget(
)
:
voidgetProject(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetSelectors(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidhasSelectors(
)
:
voidinit(
)
:
voidlog(
)
:
voidmaybeConfigure(
)
:
voidperform(
)
:
voidprepareEncoderCommand(
)
:
voidPrepares the main part of the command that will be used to encode the given file(s).
selectorCount(
)
:
voidselectorElements(
)
:
voidsetAspTags(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setCaseSensitive(
)
:
voidsetDefaultexcludes(
)
:
voidsetDeleteSource(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setDescription(
)
:
voidsetEncodedOnly(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setExcludes(
)
:
voidsetExcludesfile(
)
:
voidsetExpires(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setFollowSymlinks(
)
:
voidsetForceEncode(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setIgnoreFileModes(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setIncludes(
)
:
voidsetIncludesfile(
)
:
voidsetLicenseProduct(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setLocation(
)
:
voidsetNoHeader(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setObfuscationLevel(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setOptMask(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setOwningTarget(
)
:
voidsetPrivateKeyPath(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setProductName(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setProject(
)
:
voidsetPrologFile(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setRenameSourceExt(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setRuntimeConfigurableWrapper(
)
:
voidsetShortTags(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setSignProduct(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setTaskName(
)
:
voidsetTaskType(
)
:
voidsetUseCrypto(
$value
)
:
void| Name | Type | Description |
|---|---|---|
| $value |
setZendEncoderPath(
$value
)
:
voidTASK PROPERTIES SETTERS
| Name | Type | Description |
|---|---|---|
| $value |
verifyConfiguration(
)
:
voidVerifies that the configuration is correct
| Exception | Description |
|---|---|
| \BuildException |
\ZendGuardFileSet
This is a FileSet with the to specify permissions.
Permissions are currently not implemented by PEAR Archive_Tar, but hopefully they will be in the future.
- Parent(s)
- \FileSet < \AbstractFileSet < \DataType < \ProjectComponent
Properties
Methods
__clone(
)
:
void__construct(
)
:
voidappendSelector(
)
:
voidcircularReference(
)
:
voidcreateAnd(
)
:
voidcreateContains(
)
:
voidcreateContainsRegexp(
)
:
voidcreateCustom(
)
:
voidcreateDate(
)
:
voidcreateDepend(
)
:
voidcreateDepth(
)
:
voidcreateExclude(
)
:
voidcreateExcludesFile(
)
:
voidcreateFilename(
)
:
voidcreateInclude(
)
:
voidcreateIncludesFile(
)
:
voidcreateMajority(
)
:
voidcreateNone(
)
:
voidcreateNot(
)
:
voidcreateOr(
)
:
voidcreatePatternSet(
)
:
voidcreatePresent(
)
:
voidcreateSelector(
)
:
voidcreateSize(
)
:
voidcreateType(
)
:
voiddieOnCircularReference(
)
:
voidgetCheckedRef(
)
:
voidgetDescription(
)
:
voidgetDir(
)
:
voidgetDirectoryScanner(
)
:
voidgetFiles(
$p, $includeEmpty
=
true
)
:
voidGet a list of files and directories specified in the fileset.
@return array a list of file and directory names, relative to the baseDir for the project.
| Name | Type | Description |
|---|---|---|
| $p | ||
| $includeEmpty |
getProject(
)
:
voidgetRef(
)
:
voidgetSelectors(
)
:
voidhasPatterns(
)
:
voidhasSelectors(
)
:
voidisReference(
)
:
voidlog(
)
:
voidnoChildrenAllowed(
)
:
voidparsingComplete(
)
:
voidselectorCount(
)
:
voidselectorElements(
)
:
voidsetCaseSensitive(
)
:
voidsetDefaultexcludes(
)
:
voidsetDescription(
)
:
voidsetDir(
)
:
voidsetExcludes(
)
:
voidsetExcludesfile(
)
:
voidsetExpandSymbolicLinks(
)
:
voidsetIncludes(
)
:
voidsetIncludesfile(
)
:
voidsetProject(
)
:
voidsetRefid(
)
:
voidsetupDirectoryScanner(
)
:
voidtooManyAttributes(
)
:
void