Appends text, contents of a file or set of files defined by a filelist to a destination file.
package
|
phing.tasks.system
|
version
|
$Id$
|
Methods
Sets specific file to append.
setFile(\PhingFile $f)
Set target file to append to.
setTo(\PhingFile $f)
deprecated
|
Will be removed with final release.
|
|
|
Arguments
The more conventional naming for method to set destination file.
setDestFile(\PhingFile $f)
Supports embedded <filelist> element.
createFileList() : \FileList
Nested creator, adds a set of files (nested <fileset> attribute).
createFileSet() : \FileSet
This is for when you don't care what order files get appended.
Response
\FileSet
Creates a filterchain
createFilterChain() : \FilterChain
Sets text to append. (cannot be used in conjunction w/ files or filesets).
setText(string $txt)
Sets text to append. Supports CDATA.
addText(string $txt)
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.
main()
inherited abstract
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
Append an array of files in a directory.
appendFiles(\FileWriter $writer, array $files, \PhingFile $dir)
Arguments
$writer
\FileWriter
The FileWriter that is appending to target file.
$files
array
array of files to delete; can be of zero length
appendFile
appendFile(\FileWriter $writer, \PhingFile $f)
Sets the owning target this task belongs to.
setOwningTarget(\Target $target)
inherited
Returns the owning target of this task.
getOwningTarget() : \Target
inherited
Response
\Target
The target object that owns this task
Returns the name of task, used only for log messages
getTaskName() : string
inherited
Response
string
Name of this task
Sets the name of this task for log messages
setTaskName(string $name) : string
inherited
Arguments
Response
string
A string representing the name of this task for log
Returns the name of the task under which it was invoked,
usually the XML tagname
getTaskType() : string
inherited
Response
string
The type of this task (XML Tag)
Sets the type of the task. Usually this is the name of the XML tag
setTaskType($name)
inherited
Returns a name
getRegisterSlot(string $slotName)
inherited
Logs a message with the given priority.
log(string $msg, integer $level = \Project::MSG_INFO)
inherited
Arguments
$msg
string
The message to be logged.
$level
integer
The message's priority at this message should have
Sets a textual description of the task
setDescription(string $desc)
inherited
Arguments
$desc
string
The text describing the task
Returns the textual description of the task
getDescription() : string
inherited
Response
string
The text description of the task
Called by the parser to let the task initialize properly.
init()
inherited
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Returns the location within the buildfile this task occurs. Used
by {@link BuildException} to give detailed error messages.
getLocation() : \Location
inherited
Response
\Location
The location object describing the position of this
task within the buildfile.
Sets the location within the buildfile this task occurs. Called by
the parser to set location information.
setLocation(\Location $location)
inherited
Arguments
$location
\Location
The location object describing the position of this
task within the buildfile.
Returns the wrapper object for runtime configuration
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited
Sets the wrapper object this task should use for runtime
configurable elements.
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
inherited
References the project to the current component.
setProject(\Project $project)
inherited
Arguments
$project
\Project
The reference to the current project
Returns a reference to current project
getProject() : \Project
inherited
Response
\Project
Reference to current porject object
Properties
Append stuff to this file.
to :
Explicit file to append.
file :
Any filesets of files that should be appended.
filesets :
Any filelists of files that should be appended.
filelists :
Any filters to be applied before append happens.
filterChains :
Text to append. (cannot be used in conjunction w/ files or filesets)
text :
Owning Target object
target : \Target
inherited
Description of the task
description : string
inherited
Internal taskname (req)
taskType : string
inherited
Taskname for logger
taskName : string
inherited
Stored buildfile location
location : \Location
inherited
Wrapper of the task
wrapper : \RuntimeConfigurable
inherited
Holds a reference to the project that a project component
(a task, a target, etc.) belongs to
project : \Project
inherited
var
|
A reference to the current project instance
|
Type(s)
\Project