tasks/ext/zendguard/ZendGuardEncodeTask.php
Encodes files using Zeng Guard Encoder
- Author
- Petr Rybak
- Package
- phing.tasks.ext.zendguard
- Since
- 2.4.3
- Version
- $Id: cdbb2883ab70c650896a465a872b3da30f13eb00 $
\ZendGuardEncodeTask
Encodes files using Zeng Guard Encoder
This is very closely based on the ANT class of the same name.
- Parent(s)
- \MatchingTask < \SelectorContainer < \ProjectComponent
- Author
- Petr Rybak
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Since
- 2.4.3
- Version
- $Id: cdbb2883ab70c650896a465a872b3da30f13eb00 $
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
false
Details- 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
true
Details- Type
- bool


string
$description= ''
- Type
- string
- Inherited_from
- \Task::$$description
- Inherited_from
- \MatchingTask::$$description


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
false
Details- Type
- bool


string
$expires= 'null'
Make an encoded file to expire on the given date. Date is in yyyy-mm-dd format.
null
Details- Type
- string


\FileSet
$fileset= ''
- Type
- \FileSet
- Inherited_from
- \MatchingTask::$$fileset


bool
$forceEncode= 'false'
Allow encoding previously encoded files. (NOT recommended!)
false
Details- Type
- bool


bool
$ignoreFileModes= 'false'
If true the ownership, permissions and timestamps of the encoded files won't be preserved.
false
Details- Type
- bool


bool
$licenseProduct= 'false'
Enable licensing.
If enabled, productName must be defined.
false
Details- Type
- bool


\Location
$location= ''
- Type
- \Location
- Inherited_from
- \Task::$$location
- Inherited_from
- \MatchingTask::$$location


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
false
Details- Type
- bool


int
$obfuscationLevel= '0'
Level of obfuscation. Defaults to 0 (no obfuscation).
0
Details- 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
null
Details- Type
- int


string
$privateKeyPath= 'null'
Path to private key for licensing
null
Details- Type
- string


string
$productName= 'null'
Product name. Must be defined if licenseProduct or signProduct is set to 1
null
Details- Type
- string


\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::$$project\MatchingTask::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
- Inherited_from
- \MatchingTask::$$project


string
$prologFile= 'null'
Embed the information in the specified file into the header of the encoded file (overrides noHeader)
null
Details- 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.
null
Details- 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
true
Details- Type
- bool


bool
$signProduct= 'false'
Enable signing If enabled, productName must be defined.
false
Details- Type
- bool


\Target
$target= ''
- Type
- \Target
- Inherited_from
- \Task::$$target
- Inherited_from
- \MatchingTask::$$target


string
$taskName= ''
- Type
- string
- Inherited_from
- \Task::$$taskName
- Inherited_from
- \MatchingTask::$$taskName


string
$taskType= ''
- Type
- string
- Inherited_from
- \Task::$$taskType
- Inherited_from
- \MatchingTask::$$taskType


bool
$useCrypto= 'false'
If cryptography should be used to encode the source code
false
Details- Type
- bool


boolean
$useDefaultExcludes= 'true'
true
Details- Type
- boolean
- Inherited_from
- \MatchingTask::$$useDefaultExcludes


\RuntimeConfigurable
$wrapper= ''
- Type
- \RuntimeConfigurable
- Inherited_from
- \Task::$$wrapper
- Inherited_from
- \MatchingTask::$$wrapper
Methods


appendSelector(
\FileSelector $selector
)
:
void
Name | Type | Description |
---|---|---|
$selector | \FileSelector | the new selector to add |


createAnd(
)
:
\AndSelector
add an "And" selector entry on the selector list
Inherited from: \MatchingTask::createAnd()Type | Description |
---|---|
\AndSelector |


createContains(
)
:
\ContainsSelector
add a contains selector entry on the selector list
Inherited from: \MatchingTask::createContains()Type | Description |
---|---|
\ContainsSelector |


createCustom(
)
:
\ExtendSelector
add an extended selector entry on the selector list
Inherited from: \MatchingTask::createCustom()Type | Description |
---|---|
\ExtendSelector |


createDepend(
)
:
\DependSelector
add a depends selector entry on the selector list
Inherited from: \MatchingTask::createDepend()Type | Description |
---|---|
\DependSelector |


createDepth(
)
:
\DepthSelector
add a depth selector entry on the selector list
Inherited from: \MatchingTask::createDepth()Type | Description |
---|---|
\DepthSelector |


createExcludesFile(
)
:
\PatternSetNameEntry
add a name entry on the include files list
Inherited from: \MatchingTask::createExcludesFile()Type | Description |
---|---|
\PatternSetNameEntry |


createFilename(
)
:
\FilenameSelector
add a selector filename entry on the selector list
Inherited from: \MatchingTask::createFilename()Type | Description |
---|---|
\FilenameSelector |


createIncludesFile(
)
:
\PatternSetNameEntry
add a name entry on the include files list
Inherited from: \MatchingTask::createIncludesFile()Type | Description |
---|---|
\PatternSetNameEntry |


createMajority(
)
:
\MajoritySelector
add a majority selector entry on the selector list
Inherited from: \MatchingTask::createMajority()Type | Description |
---|---|
\MajoritySelector |


createNone(
)
:
\NoneSelector
add a "None" selector entry on the selector list
Inherited from: \MatchingTask::createNone()Type | Description |
---|---|
\NoneSelector |


createPresent(
)
:
\PresentSelector
add a present selector entry on the selector list
Inherited from: \MatchingTask::createPresent()Type | Description |
---|---|
\PresentSelector |


createSelector(
)
:
\SelectSelector
add a "Select" selector entry on the selector list
Inherited from: \MatchingTask::createSelector()Type | Description |
---|---|
\SelectSelector |


encodeFile(
string $filePath
)
:
void
Encodes a file using currently defined Zend Guard settings
Name | Type | Description |
---|---|---|
$filePath | string | Path to the encoded file |


getDescription(
)
:
string
Returns the textual description of the task
Inherited from: \Task::getDescription()\MatchingTask::getDescription()Type | Description |
---|---|
string | The text description of the task |


getDirectoryScanner(
$baseDir
)
:
\DirectoryScanner
Returns the directory scanner needed to access the files to process.
Inherited from: \MatchingTask::getDirectoryScanner()Name | Type | Description |
---|---|---|
$baseDir |
Type | Description |
---|---|
\DirectoryScanner |


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


getOwningTarget(
)
:
\Target
Returns the owning target of this task.
Inherited from: \Task::getOwningTarget()\MatchingTask::getOwningTarget()Type | Description |
---|---|
\Target | The target object that owns this task |


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


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()\MatchingTask::getRuntimeConfigurableWrapper()Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


getSelectors(
$p
)
:
array
Name | Type | Description |
---|---|---|
$p |
Type | Description |
---|---|
array | FileSelector[] An array of selectors in this container |


getTaskName(
)
:
string
Returns the name of task, used only for log messages
Inherited from: \Task::getTaskName()\MatchingTask::getTaskName()Type | Description |
---|---|
string | Name of this task |


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


hasSelectors(
)
:
boolean
Indicates whether there are any selectors here.
Inherited from: \MatchingTask::hasSelectors()Type | Description |
---|---|
boolean | Whether any selectors are in this container |


init(
)
:
void
Called by the parser to let the task initialize properly.
Inherited from: \Task::init()\MatchingTask::init()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
Provides a project level log event to the task.
Inherited from: \Task::log()\MatchingTask::log()Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
Do the work
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()\MatchingTask::maybeConfigure()

prepareEncoderCommand(
)
:
void
Prepares the main part of the command that will be used to encode the given file(s).


selectorCount(
)
:
int
Gives the count of the number of selectors in this container
Inherited from: \MatchingTask::selectorCount()Type | Description |
---|---|
int | The number of selectors in this container |


selectorElements(
)
:
\an
Returns an enumerator for accessing the set of selectors.
Inherited from: \MatchingTask::selectorElements()Type | Description |
---|---|
\an | enumerator that goes through each of the selectors |


setCaseSensitive(
boolean $isCaseSensitive
)
:
void
Name | Type | Description |
---|---|---|
$isCaseSensitive | boolean | "true"|"on"|"yes" if file system is case sensitive, "false"|"off"|"no" when not. |


setDefaultexcludes(
boolean $useDefaultExcludes
)
:
void
Sets whether default exclusions should be used or not.
Inherited from: \MatchingTask::setDefaultexcludes()Name | Type | Description |
---|---|---|
$useDefaultExcludes | boolean | "true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used. |


setDescription(
string $desc
)
:
void
Sets a textual description of the task
Inherited from: \Task::setDescription()\MatchingTask::setDescription()Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setExcludes(
string $excludes
)
:
void
Sets the set of exclude patterns. Patterns may be separated by a comma or a space.
Inherited from: \MatchingTask::setExcludes()Name | Type | Description |
---|---|---|
$excludes | string | the string containing the exclude patterns |


setExcludesfile(
\PhingFile $excludesfile
)
:
void
Sets the name of the file containing the includes patterns.
Inherited from: \MatchingTask::setExcludesfile()Name | Type | Description |
---|---|---|
$excludesfile | \PhingFile | A string containing the filename to fetch the include patterns from. |


setFollowSymlinks(
boolean $followSymlinks
)
:
void
Sets whether or not symbolic links should be followed.
Inherited from: \MatchingTask::setFollowSymlinks()Name | Type | Description |
---|---|---|
$followSymlinks | boolean | whether or not symbolic links should be followed |


setIncludes(
string $includes
)
:
void
Sets the set of include patterns. Patterns may be separated by a comma or a space.
Inherited from: \MatchingTask::setIncludes()Name | Type | Description |
---|---|---|
$includes | string | the string containing the include patterns |


setIncludesfile(
\PhingFile $includesfile
)
:
void
Sets the name of the file containing the includes patterns.
Inherited from: \MatchingTask::setIncludesfile()Name | Type | Description |
---|---|---|
$includesfile | \PhingFile | A string containing the filename to fetch the include patterns from. |


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()\MatchingTask::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setOwningTarget(
\Target $target
)
:
void
Sets the owning target this task belongs to.
Inherited from: \Task::setOwningTarget()\MatchingTask::setOwningTarget()Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \MatchingTask::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()\MatchingTask::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setTaskName(
string $name
)
:
string
Sets the name of this task for log messages
Inherited from: \Task::setTaskName()\MatchingTask::setTaskName()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()\MatchingTask::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |


verifyConfiguration(
)
:
void
Verifies 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
- Author
- Hans Lellelid
(Phing) - Author
- Arnout J. Kuiper
(Ant) - Author
- Stefano Mazzocchi
(Ant) - Author
- Sam Ruby
(Ant) - Author
- Jon S. Stevens
(Ant) - Author
- Stefan Bodewig
(Ant) - Author
- Magesh Umasankar (Ant)
- Version
- $Id$
Properties


$additionalPatterns= 'array()'
array()
Details- Type
- n/a
- Inherited_from
- \AbstractFileSet::$$additionalPatterns
- Inherited_from
- \FileSet::$$additionalPatterns


boolean
$checked= 'true'
Are we sure we don't hold circular references?
Inherited from: \DataType::$$checked\AbstractFileSet::$$checked\FileSet::$$checkedSubclasses are responsible for setting this value to false if we'd need to investigate this condition (usually because a child element has been added that is a subclass of DataType).
true
Details- Type
- boolean
- Inherited_from
- \DataType::$$checked
- Inherited_from
- \AbstractFileSet::$$checked
- Inherited_from
- \FileSet::$$checked


\PatternSet
$defaultPatterns= ''
- Type
- \PatternSet
- Inherited_from
- \AbstractFileSet::$$defaultPatterns
- Inherited_from
- \FileSet::$$defaultPatterns


$description= 'null'
The descriptin the user has set.
Inherited from: \DataType::$$description\AbstractFileSet::$$description\FileSet::$$descriptionnull
Details- Type
- n/a
- Inherited_from
- \DataType::$$description
- Inherited_from
- \AbstractFileSet::$$description
- Inherited_from
- \FileSet::$$description


boolean
$expandSymbolicLinks= 'false'
Whether to expand/dereference symbolic links, default is false
Inherited from: \AbstractFileSet::$$expandSymbolicLinks\FileSet::$$expandSymbolicLinksfalse
Details- Type
- boolean
- Inherited_from
- \AbstractFileSet::$$expandSymbolicLinks
- Inherited_from
- \FileSet::$$expandSymbolicLinks


$isCaseSensitive= 'true'
true
Details- Type
- n/a
- Inherited_from
- \AbstractFileSet::$$isCaseSensitive
- Inherited_from
- \FileSet::$$isCaseSensitive


\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\DataType::$$project\AbstractFileSet::$$project\FileSet::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \DataType::$$project
- Inherited_from
- \AbstractFileSet::$$project
- Inherited_from
- \FileSet::$$project


$ref= 'null'
Value to the refid attribute. Type of Reference
Inherited from: \DataType::$$ref\AbstractFileSet::$$ref\FileSet::$$refnull
Details- Type
- n/a
- Inherited_from
- \DataType::$$ref
- Inherited_from
- \AbstractFileSet::$$ref
- Inherited_from
- \FileSet::$$ref


$selectors= 'array()'
array()
Details- Type
- n/a
- Inherited_from
- \AbstractFileSet::$$selectors
- Inherited_from
- \FileSet::$$selectors


boolean
$useDefaultExcludes= 'true'
true
Details- Type
- boolean
- Inherited_from
- \AbstractFileSet::$$useDefaultExcludes
- Inherited_from
- \FileSet::$$useDefaultExcludes
Methods


__clone(
)
:
void
Return a FileSet that has the same basedir and same patternsets as this one.
Inherited from: \FileSet::__clone()

__construct(
$fileset
=
null
)
:
void
Name | Type | Description |
---|---|---|
$fileset |


appendSelector(
\selector $selector
)
:
void
Add a new selector into this container.
Inherited from: \AbstractFileSet::appendSelector()\FileSet::appendSelector()Name | Type | Description |
---|---|---|
$selector | \selector | the new selector to add |


circularReference(
)
:
void
Creates an exception that indicates the user has generated a loop of data types referencing each other.
Inherited from: \DataType::circularReference()\AbstractFileSet::circularReference()\FileSet::circularReference()

createAnd(
)
:
void
add an "And" selector entry on the selector list
Inherited from: \AbstractFileSet::createAnd()\FileSet::createAnd()

createContains(
)
:
void
add a contains selector entry on the selector list
Inherited from: \AbstractFileSet::createContains()\FileSet::createContains()

createContainsRegexp(
)
:
void
add a contains selector entry on the selector list
Inherited from: \AbstractFileSet::createContainsRegexp()\FileSet::createContainsRegexp()

createCustom(
)
:
void
add an extended selector entry on the selector list
Inherited from: \AbstractFileSet::createCustom()\FileSet::createCustom()

createDate(
)
:
void
add a selector date entry on the selector list
Inherited from: \AbstractFileSet::createDate()\FileSet::createDate()

createDepend(
)
:
void
add a depends selector entry on the selector list
Inherited from: \AbstractFileSet::createDepend()\FileSet::createDepend()

createDepth(
)
:
void
add a depth selector entry on the selector list
Inherited from: \AbstractFileSet::createDepth()\FileSet::createDepth()

createExclude(
)
:
void
add a name entry on the exclude list
Inherited from: \AbstractFileSet::createExclude()\FileSet::createExclude()

createExcludesFile(
)
:
void
add a name entry on the include files list
Inherited from: \AbstractFileSet::createExcludesFile()\FileSet::createExcludesFile()

createFilename(
)
:
void
add a selector filename entry on the selector list
Inherited from: \AbstractFileSet::createFilename()\FileSet::createFilename()

createInclude(
)
:
void
add a name entry on the include list
Inherited from: \AbstractFileSet::createInclude()\FileSet::createInclude()

createIncludesFile(
)
:
void
add a name entry on the include files list
Inherited from: \AbstractFileSet::createIncludesFile()\FileSet::createIncludesFile()

createMajority(
)
:
void
add a majority selector entry on the selector list
Inherited from: \AbstractFileSet::createMajority()\FileSet::createMajority()

createNone(
)
:
void
add a "None" selector entry on the selector list
Inherited from: \AbstractFileSet::createNone()\FileSet::createNone()

createNot(
)
:
void
add a "Not" selector entry on the selector list
Inherited from: \AbstractFileSet::createNot()\FileSet::createNot()

createOr(
)
:
void
add an "Or" selector entry on the selector list
Inherited from: \AbstractFileSet::createOr()\FileSet::createOr()

createPresent(
)
:
void
add a present selector entry on the selector list
Inherited from: \AbstractFileSet::createPresent()\FileSet::createPresent()

createSelector(
)
:
void
add a "Select" selector entry on the selector list
Inherited from: \AbstractFileSet::createSelector()\FileSet::createSelector()

createSize(
)
:
void
add a selector size entry on the selector list
Inherited from: \AbstractFileSet::createSize()\FileSet::createSize()

createType(
)
:
void
add a type selector entry on the selector list
Inherited from: \AbstractFileSet::createType()\FileSet::createType()

dieOnCircularReference(
$stk, $p
)
:
void
Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).
Inherited from: \DataType::dieOnCircularReference()\AbstractFileSet::dieOnCircularReference()\FileSet::dieOnCircularReference()If one is included, throw a BuildException created by circularReference
This implementation is appropriate only for a DataType that cannot hold other DataTypes as children.
The general contract of this method is that it shouldn't do anything if checked is true and set it to true on exit.
Name | Type | Description |
---|---|---|
$stk | ||
$p |


getCheckedRef(
$requiredClass, $dataTypeName
)
:
void
Performs the check for circular references and returns the referenced object.
Inherited from: \DataType::getCheckedRef()\AbstractFileSet::getCheckedRef()\FileSet::getCheckedRef()Name | Type | Description |
---|---|---|
$requiredClass | ||
$dataTypeName |


getDescription(
)
:
void
Return the description for the current data type.
Inherited from: \DataType::getDescription()\AbstractFileSet::getDescription()\FileSet::getDescription()

getDirectoryScanner(
$p
)
:
void
returns a reference to the dirscanner object belonging to this fileset
Inherited from: \AbstractFileSet::getDirectoryScanner()\FileSet::getDirectoryScanner()Name | Type | Description |
---|---|---|
$p |


getFiles(
$p, $includeEmpty
=
true
)
:
void
Get 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(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\DataType::getProject()\AbstractFileSet::getProject()\FileSet::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRef(
$p
)
:
void
Performs the check for circular references and returns the referenced FileSet.
Inherited from: \AbstractFileSet::getRef()\FileSet::getRef()Name | Type | Description |
---|---|---|
$p |


getSelectors(
$p
)
:
\an
Returns the set of selectors as an array.
Inherited from: \AbstractFileSet::getSelectors()\FileSet::getSelectors()Name | Type | Description |
---|---|---|
$p |
Type | Description |
---|---|
\an | array of selectors in this container |


hasPatterns(
)
:
boolean
Indicates whether there are any patterns here.
Inherited from: \AbstractFileSet::hasPatterns()\FileSet::hasPatterns()Type | Description |
---|---|
boolean | Whether any patterns are in this container. |


hasSelectors(
)
:
boolean
Indicates whether there are any selectors here.
Inherited from: \AbstractFileSet::hasSelectors()\FileSet::hasSelectors()Type | Description |
---|---|
boolean | Whether any selectors are in this container |


isReference(
)
:
void
Has the refid attribute of this element been set?
Inherited from: \DataType::isReference()\AbstractFileSet::isReference()\FileSet::isReference()

log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Logs a message with the given priority.
Inherited from: \ProjectComponent::log()\DataType::log()\AbstractFileSet::log()\FileSet::log()Name | Type | Description |
---|---|---|
$msg | string | The message to be logged. |
$level | integer | The message's priority at this message should have |


noChildrenAllowed(
)
:
void
Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.
Inherited from: \DataType::noChildrenAllowed()\AbstractFileSet::noChildrenAllowed()\FileSet::noChildrenAllowed()

parsingComplete(
)
:
void
Template method being called when the data type has been parsed completely.
Inherited from: \DataType::parsingComplete()\AbstractFileSet::parsingComplete()\FileSet::parsingComplete()

selectorCount(
)
:
int
Gives the count of the number of selectors in this container
Inherited from: \AbstractFileSet::selectorCount()\FileSet::selectorCount()Type | Description |
---|---|
int | The number of selectors in this container |


selectorElements(
)
:
array
Returns an array for accessing the set of selectors.
Inherited from: \AbstractFileSet::selectorElements()\FileSet::selectorElements()Type | Description |
---|---|
array | The array of selectors |


setCaseSensitive(
$isCaseSensitive
)
:
void
Sets case sensitivity of the file system
Inherited from: \AbstractFileSet::setCaseSensitive()\FileSet::setCaseSensitive()Name | Type | Description |
---|---|---|
$isCaseSensitive |


setDefaultexcludes(
\$useDefaultExcludes $useDefaultExcludes
)
:
void
Sets whether default exclusions should be used or not.
Inherited from: \AbstractFileSet::setDefaultexcludes()\FileSet::setDefaultexcludes()Name | Type | Description |
---|---|---|
$useDefaultExcludes | \$useDefaultExcludes | "true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used. |


setDescription(
$desc
)
:
void
Sets a description of the current data type. It will be useful in commenting what we are doing.
Inherited from: \DataType::setDescription()\AbstractFileSet::setDescription()\FileSet::setDescription()Name | Type | Description |
---|---|---|
$desc |


setExcludes(
$excludes
)
:
void
Sets the set of exclude patterns. Patterns may be separated by a comma or a space.
Inherited from: \AbstractFileSet::setExcludes()\FileSet::setExcludes()Name | Type | Description |
---|---|---|
$excludes |


setExcludesfile(
\$excl $excl
)
:
void
Sets the name of the file containing the includes patterns.
Inherited from: \AbstractFileSet::setExcludesfile()\FileSet::setExcludesfile()Name | Type | Description |
---|---|---|
$excl | \$excl | The file to fetch the exclude patterns from. |
Exception | Description |
---|---|
\BE |


setExpandSymbolicLinks(
$expandSymbolicLinks
)
:
void
Sets whether to expand/dereference symbolic links, default is false
Inherited from: \AbstractFileSet::setExpandSymbolicLinks()\FileSet::setExpandSymbolicLinks()Name | Type | Description |
---|---|---|
$expandSymbolicLinks |
- boolean


setIncludes(
$includes
)
:
void
Sets the set of include patterns. Patterns may be separated by a comma or a space.
Inherited from: \AbstractFileSet::setIncludes()\FileSet::setIncludes()Name | Type | Description |
---|---|---|
$includes |


setIncludesfile(
\$incl $incl
)
:
void
Sets the name of the file containing the includes patterns.
Inherited from: \AbstractFileSet::setIncludesfile()\FileSet::setIncludesfile()Name | Type | Description |
---|---|---|
$incl | \$incl | The file to fetch the include patterns from. |
Exception | Description |
---|---|
\BE |


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


setRefid(
\Reference $r
)
:
void
Makes this instance in effect a reference to another PatternSet instance.
Inherited from: \AbstractFileSet::setRefid()\FileSet::setRefid()You must not set another attribute or nest elements inside this element if you make it a reference.
Name | Type | Description |
---|---|---|
$r | \Reference |


setupDirectoryScanner(
$ds, $p
)
:
void
feed dirscanner with infos defined by this fileset
Inherited from: \AbstractFileSet::setupDirectoryScanner()\FileSet::setupDirectoryScanner()Name | Type | Description |
---|---|---|
$ds | ||
$p |


tooManyAttributes(
)
:
void
Creates an exception that indicates that refid has to be the only attribute if it is set.
Inherited from: \DataType::tooManyAttributes()\AbstractFileSet::tooManyAttributes()\FileSet::tooManyAttributes()