AppendTask

Extends \Task

Appends text, contents of a file or set of files defined by a filelist to a destination file.

OR

OR

package

phing.tasks.system

version

$Id: 0c5074ef90c18649dffa29835f7230c7ad80a1ac $

Methods

__construct

__construct() 
inherited

addFileList

addFileList(\FileList $fileList) 
inherited

Arguments

$fileList

\FileList

addFileSet

addFileSet(\FileSet $fileSet) 
inherited

Arguments

$fileSet

\FileSet

addFilterChain

addFilterChain(\FilterChain $filterChain) 
inherited

Arguments

$filterChain

\FilterChain

addFooter

addFooter(\TextElement $footerToAdd) 

Arguments

$footerToAdd

\TextElement

addHeader

addHeader(\TextElement $headerToAdd) 

Arguments

$headerToAdd

\TextElement

Sets text to append. Supports CDATA.

addText(string $txt) : void

Arguments

$txt

string

appendFile

appendFile(\FileWriter $writer, \PhingFile $f) : void

Arguments

$writer

\FileWriter

Append an array of files in a directory.

appendFiles(\Writer $writer, array $files, \PhingFile $dir = null) : void

Arguments

$writer

\Writer

The FileWriter that is appending to target file.

$files

array

array of files to delete; can be of zero length

$dir

\PhingFile

directory to work from

appendFooter

appendFooter( $string) 

Arguments

$string

appendHeader

appendHeader( $string) 

Arguments

$string

checkFilename

checkFilename( $filename,  $dir = null) 

Arguments

$filename

$dir

createPath

createPath() 

Returns the description of the current action.

getDescription() : string
inherited

Response

string

the description of the current action, or null if no description is available.

getFileLists

getFileLists() 
inherited

getFileSets

getFileSets() 
inherited

getFilterChains

getFilterChains() : array<mixed,\FilterChain>
inherited

Response

array<mixed,\FilterChain>

getFilteredReader

getFilteredReader(\Reader $r) 

Arguments

$r

\Reader

Returns the file/location where this task was defined.

getLocation() : \Location
inherited

Response

\Location

the file/location where this task was defined. Should not return null.

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Returns a name

getRegisterSlot(string $slotName) : \RegisterSlot
inherited

Arguments

$slotName

string

Response

\RegisterSlot

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

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)

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.

Throws
\BuildException

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO) : void
inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

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.

Configure this task if it hasn't been done already.

maybeConfigure() 
inherited

Perfrom this task

perform() : void
inherited
Throws
\BuildException
\Error

sanitizeText

sanitizeText() 

Sets the behavior when the destination exists. If set to <code>true</code> the task will append the stream data an {@link Appendable} resource; otherwise existing content will be overwritten. Defaults to <code>false</code>.

setAppend(boolean $append) 

Arguments

$append

boolean

if true append output.

Sets a description of the current action. This may be used for logging purposes.

setDescription(string $desc) 
inherited

Arguments

$desc

string

Description of the current action. May be null, indicating that no description is available.

The more conventional naming for method to set destination file.

setDestFile(\PhingFile $f) : void

Arguments

Specify the end of line to find and to add if not present at end of each input file. This attribute is used in conjunction with fixlastline.

setEol(string $crlf) 

Arguments

$crlf

string

the type of new line to add - cr, mac, lf, unix, crlf, or dos

Sets specific file to append.

setFile(\PhingFile $f) 

Arguments

setFiltering

setFiltering(boolean $filtering) 

Arguments

$filtering

boolean

Append line.separator to files that do not end with a line.separator, default false.

setFixLastLine(boolean $fixLastLine) 

Arguments

$fixLastLine

boolean

if true make sure each input file has new line on the concatenated stream

Sets the file/location where this task was defined.

setLocation(\Location $location) 
inherited

Arguments

$location

\Location

The file/location where this task was defined. Should not be null

setOverwrite

setOverwrite(boolean $overwrite) 

Arguments

$overwrite

boolean

Sets the owning target this task belongs to.

setOwningTarget(\Target $target) 
inherited

Arguments

$target

\Target

References the project to the current component.

setProject(\Project $project) : void
inherited

Arguments

$project

\Project

The reference to the current project

Sets the wrapper object this task should use for runtime configurable elements.

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper) 
inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Sets the name of this task for log messages

setTaskName(string $name) 
inherited

Arguments

$name

string

Sets the type of the task. Usually this is the name of the XML tag

setTaskType(string $name) 
inherited

Arguments

$name

string

The type of this task (XML Tag)

Sets text to append. (cannot be used in conjunction w/ files or filesets).

setText(string $txt) : void

Arguments

$txt

string

validate

validate() 

Properties

Append stuff to this file.

to : 

Type(s)

Explicit file to append.

file : 

Type(s)

Text to append. (cannot be used in conjunction w/ files or filesets)

text : 

Type(s)

filtering

filtering : 

Type(s)

header

header : \TextElement
var

Type(s)

\TextElement

append

append : 

Type(s)

fixLastLine

fixLastLine : 

Type(s)

overwrite

overwrite : 

Type(s)

eolString

eolString : 

Type(s)

filelists

filelists : array<mixed,\FileList>
inherited
var

Type(s)

array<mixed,\FileList>

filesets

filesets : array<mixed,\FileSet>
inherited
var

Type(s)

array<mixed,\FileSet>

filterChains

filterChains : array<mixed,\FilterChain>
inherited
var

Type(s)

array<mixed,\FilterChain>

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

Wrapper of the task

wrapper : \RuntimeConfigurable
inherited
var

Type(s)

\RuntimeConfigurable

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

location

location : \Location
inherited
var

Type(s)

\Location

description

description : string
inherited
var

Type(s)

string