phing-tasks-system

# Class: ReplaceRegexpTask Source Location: /tasks/ext/ReplaceRegexpTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --ReplaceRegexpTask
ReplaceRegExp is a directory based task for replacing the occurrence of a given regular expression with a substitution pattern in a selected file or set of files. #### Author(s): Jonathan Bond-Caron <jbondc@openmv.com> #### Version: $Id: ReplaceRegexpTask.php 552 2009-08-29 12:18:13Z mrook $ #### Copyright: � 2001,2002 THYRELL. All rights reserved | ### Methods createFileSet init main setByline setFile setFlags setMatch setPattern setReplace
### 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 40] ReplaceRegExp is a directory based task for replacing the occurrence of a given regular expression with a substitution pattern in a selected file or set of files. <replaceregexp file="${src}/build.properties" match="OldProperty=(.*)" replace="NewProperty=\1" byline="true"/> #### Tags:
author: | Jonathan Bond-Caron <jbondc@openmv.com>
version: | $Id: ReplaceRegexpTask.php 552 2009-08-29 12:18:13Z mrook $
copyright: | � 2001,2002 THYRELL. All rights reserved
see: | <http://ant.apache.org/manual/OptionalTasks/replaceregexp.html>
[ Top ] ### Class Methods ### method createFileSet [line 114]
`void createFileSet( )`
Nested creator, adds a set of files (nested fileset attribute). [ Top ] ### method init [line 120]
`void init( )`
Overrides Task::init() (Called by the parser to let the task initialize properly.) [ Top ] ### method main [line 125]
`void main( )`
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 setByline [line 108]
`void setByline( bool $yesNo)`
Match only per line #### Parameters:
bool | $yesNo |
[ Top ] ### method setFile [line 60]
`void setFile( $path)`
File to apply regexp on #### Parameters:
string | $path |
[ Top ] ### method setFlags [line 98]
`void setFlags( string $flags)`
Sets the regexp flags #### Parameters:
string | $flags |
[ Top ] ### method setMatch [line 70]
`void setMatch( string $regexp)`
Sets the regexp match pattern #### Parameters:
string | $regexp |
[ Top ] ### method setPattern [line 78]
`void setPattern( $regexp)`
#### Tags:
see: | ReplaceRegexpTask::setMatch()
#### Parameters:
| $regexp |
[ Top ] ### method setReplace [line 88]
`void setReplace( string $string)`
Sets the replacement string #### Parameters:
string | $string |
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:51:54 +0200 by phpDocumentor 1.4.3