phing-tasks-system

# Class: MatchingTask Source Location: /tasks/system/MatchingTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --MatchingTask
This is an abstract task that should be used by all those tasks that require to include or exclude files based on pattern matching. #### Author(s): Arnout J. Kuiper <ajkuiper@wxs.nl> (Ant) Hans Lellelid <hans@xmpl.org> (Phing) Bruce Atherton <bruce@callenish.com> (Ant) Stefano Mazzocchi <stefano@apache.org> (Ant) Sam Ruby <rubys@us.ibm.com> (Ant) Stefan Bodewig <stefan.bodewig@epost.de> (Ant) Jon S. Stevens <jon@clearink.com> (Ant #### Version: $Revision: 532 $ #### Copyright: � 2001,2002 THYRELL. All rights reserved Implements interfaces: SelectorContainer | ### Variables $fileset $useDefaultExcludes | ### Methods __construct appendSelector createAnd createContains createCustom createDate createDepend createDepth createExclude createExcludesFile createFilename createInclude createIncludesFile createMajority createNone createNot createOr createPatternSet createPresent createSelector createSize getDirectoryScanner getImplicitFileSet getSelectors hasSelectors selectorCount selectorElements setCaseSensitive setDefaultexcludes setExcludes setExcludesfile setFollowSymlinks setIncludes setIncludesfile setProject
### Child classes: TarTask Creates a tar archive using PEAR Archive_Tar. PearPackageTask A task to create PEAR package.xml file. ZipTask Creates a zip archive using PEAR Archive_Zip (which is presently unreleased and included with Phing). ExtractBaseTask Base class for extracting tasks such as Unzip and Untar. PharPackageTask Package task for Phar technology. | ### 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 44] This is an abstract task that should be used by all those tasks that require to include or exclude files based on pattern matching. This is very closely based on the ANT class of the same name. #### Tags:
author: | Arnout J. Kuiper <ajkuiper@wxs.nl> (Ant)
author: | Hans Lellelid <hans@xmpl.org> (Phing)
author: | Bruce Atherton <bruce@callenish.com> (Ant)
author: | Stefano Mazzocchi <stefano@apache.org> (Ant)
author: | Sam Ruby <rubys@us.ibm.com> (Ant)
author: | Stefan Bodewig <stefan.bodewig@epost.de> (Ant)
author: | Jon S. Stevens <jon@clearink.com> (Ant
version: | $Revision: 532 $
copyright: | � 2001,2002 THYRELL. All rights reserved
abstract: |
[ Top ] ### Class Variables #### $fileset = [line 50] #### Tags:
access: | protected
Type: | FileSet
[ Top ] #### $useDefaultExcludes = true [line 47] #### Tags:
access: | protected
Type: | boolean
[ Top ] ### Class Methods ### constructor __construct [line 55]
`MatchingTask __construct( )`
Create instance; set fileset to new FileSet. #### Tags:
access: | public
[ Top ] ### method appendSelector [line 235]
`void appendSelector( $selector)`
Add a new selector into this container. #### Tags:
access: | public
Implementation of: SelectorContainer::appendSelector #### Parameters:
FileSelector | $selector | the new selector to add
[ Top ] ### method createAnd [line 253]
`AndSelector createAnd( )`
add an "And" selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createAnd [ Top ] ### method createContains [line 325]
`ContainsSelector createContains( )`
add a contains selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createContains [ Top ] ### method createCustom [line 317]
`ExtendSelector createCustom( )`
add an extended selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createCustom [ Top ] ### method createDate [line 293]
`DateSelector createDate( )`
add a selector date entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createDate [ Top ] ### method createDepend [line 349]
`DependSelector createDepend( )`
add a depends selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createDepend [ Top ] ### method createDepth [line 341]
`DepthSelector createDepth( )`
add a depth selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createDepth [ Top ] ### method createExclude [line 87]
`PatternSetNameEntry createExclude( )`
add a name entry on the exclude list #### Tags:
access: | public
[ Top ] ### method createExcludesFile [line 95]
`PatternSetNameEntry createExcludesFile( )`
add a name entry on the include files list #### Tags:
access: | public
[ Top ] ### method createFilename [line 309]
`FilenameSelector createFilename( )`
add a selector filename entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createFilename [ Top ] ### method createInclude [line 71]
`PatternSetNameEntry createInclude( )`
add a name entry on the include list #### Tags:
access: | public
[ Top ] ### method createIncludesFile [line 79]
`PatternSetNameEntry createIncludesFile( )`
add a name entry on the include files list #### Tags:
access: | public
[ Top ] ### method createMajority [line 285]
`MajoritySelector createMajority( )`
add a majority selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createMajority [ Top ] ### method createNone [line 277]
`NoneSelector createNone( )`
add a "None" selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createNone [ Top ] ### method createNot [line 269]
`NotSelector createNot( )`
add a "Not" selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createNot [ Top ] ### method createOr [line 261]
`void createOr( )`
add an "Or" selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createOr [ Top ] ### method createPatternSet [line 103]
`PatternSet createPatternSet( )`
add a set of patterns #### Tags:
access: | public
[ Top ] ### method createPresent [line 333]
`PresentSelector createPresent( )`
add a present selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createPresent [ Top ] ### method createSelector [line 245]
`SelectSelector createSelector( )`
add a "Select" selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createSelector [ Top ] ### method createSize [line 301]
`SizeSelector createSize( )`
add a selector size entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createSize [ Top ] ### method getDirectoryScanner [line 144]
`DirectoryScanner getDirectoryScanner( $baseDir)`
Returns the directory scanner needed to access the files to process. #### Tags:
access: | protected
#### Parameters:
PhingFile | $baseDir |
[ Top ] ### method getImplicitFileSet [line 358]
`FileSet getImplicitFileSet( )`
Accessor for the implict fileset. #### Tags:
access: | protected
[ Top ] ### method getSelectors [line 216]
`array getSelectors( $p)`
Returns the set of selectors as an array. #### Tags:
return: | FileSelector[] An array of selectors in this container
access: | public
Implementation of: SelectorContainer::getSelectors #### Parameters:
Project | $p |
[ Top ] ### method hasSelectors [line 198]
`boolean hasSelectors( )`
Indicates whether there are any selectors here. #### Tags:
return: | Whether any selectors are in this container
access: | public
Implementation of: SelectorContainer::hasSelectors [ Top ] ### method selectorCount [line 207]
`int selectorCount( )`
Gives the count of the number of selectors in this container #### Tags:
return: | The number of selectors in this container
access: | public
Implementation of: SelectorContainer::selectorCount [ Top ] ### method selectorElements [line 225]
`an selectorElements( )`
Returns an enumerator for accessing the set of selectors. #### Tags:
return: | enumerator that goes through each of the selectors
access: | public
Implementation of: SelectorContainer::selectorElements [ Top ] ### method setCaseSensitive [line 179]
`void setCaseSensitive( boolean $isCaseSensitive)`
Sets case sensitivity of the file system #### Tags:
access: | public
#### Parameters:
boolean | $isCaseSensitive | "true"|"on"|"yes" if file system is case sensitive, "false"|"off"|"no" when not.
[ Top ] ### method setDefaultexcludes [line 136]
`void setDefaultexcludes( boolean $useDefaultExcludes)`
Sets whether default exclusions should be used or not. #### Tags:
access: | public
#### Parameters:
boolean | $useDefaultExcludes | "true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used.
[ Top ] ### method setExcludes [line 124]
`void setExcludes( string $excludes)`
Sets the set of exclude patterns. Patterns may be separated by a comma or a space. #### Tags:
access: | public
#### Parameters:
string | $excludes | the string containing the exclude patterns
[ Top ] ### method setExcludesfile [line 168]
`void setExcludesfile( $excludesfile)`
Sets the name of the file containing the includes patterns. #### Tags:
access: | public
#### Parameters:
PhingFile | $excludesfile | A string containing the filename to fetch the include patterns from.
[ Top ] ### method setFollowSymlinks [line 189]
`void setFollowSymlinks( boolean $followSymlinks)`
Sets whether or not symbolic links should be followed. #### Tags:
access: | public
#### Parameters:
boolean | $followSymlinks | whether or not symbolic links should be followed
[ Top ] ### method setIncludes [line 114]
`void setIncludes( string $includes)`
Sets the set of include patterns. Patterns may be separated by a comma or a space. #### Tags:
access: | public
#### Parameters:
string | $includes | the string containing the include patterns
[ Top ] ### method setIncludesfile [line 157]
`void setIncludesfile( $includesfile)`
Sets the name of the file containing the includes patterns. #### Tags:
access: | public
#### Parameters:
PhingFile | $includesfile | A string containing the filename to fetch the include patterns from.
[ Top ] ### method setProject [line 62]
`void setProject( $project)`
#### Tags:
see: | ProjectComponent::setProject()
access: | public
Overrides ProjectComponent::setProject() (References the project to the current component.) #### Parameters:
| $project |
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:51:16 +0200 by phpDocumentor 1.4.3