tasks/system/AppendTask.php
inherited
Classes
\AppendTask
Appends text, contents of a file or set of files defined by a filelist to a destination file.
OR
OR
- Parent(s)
- \Task < \ProjectComponent
- Version
- $Revision: 526 $
Properties
$file= ''
Explicit file to append.
- Type
- n/a
$filelists= 'array()'
Any filelists of files that should be appended.
array()Details- Type
- n/a
$filesets= 'array()'
Any filesets of files that should be appended.
array()Details- Type
- n/a
$filterChains= 'array()'
Any filters to be applied before append happens.
array()Details- Type
- n/a
$text= ''
Text to append. (cannot be used in conjunction w/ files or filesets)
- Type
- n/a
$to= ''
Append stuff to this file.
- Type
- n/a
Methods
addText(
string $txt
)
:
voidSets text to append. Supports CDATA.
| Name | Type | Description |
|---|---|---|
| $txt | string |
appendFile(
$writer, $f
)
:
void| Name | Type | Description |
|---|---|---|
| $writer | ||
| $f |
appendFiles(
\FileWriter $writer, array $files, \PhingFile $dir
)
:
voidAppend an array of files in a directory.
| Name | Type | Description |
|---|---|---|
| $writer | \FileWriter | 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 |
createFileSet(
)
:
\FileSetNested creator, adds a set of files (nested
This is for when you don't care what order files get appended.
| Type | Description |
|---|---|
| \FileSet |
createFilterChain(
)
:
\FilterChainCreates a filterchain
| Type | Description |
|---|---|
| \FilterChain | The created filterchain object |
getDescription(
)
:
voidgetLocation(
)
:
voidgetOwningTarget(
)
:
voidgetProject(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidinit(
)
:
voidlog(
)
:
voidmain(
)
:
voidAppend the file(s).
maybeConfigure(
)
:
voidperform(
)
:
voidsetDescription(
)
:
voidsetDestFile(
\PhingFile $f
)
:
voidThe more conventional naming for method to set destination file.
| Name | Type | Description |
|---|---|---|
| $f | \PhingFile |
setFile(
$f
)
:
voidSets specific file to append.
| Name | Type | Description |
|---|---|---|
| $f |
setLocation(
)
:
voidsetOwningTarget(
)
:
voidsetProject(
)
:
voidsetRuntimeConfigurableWrapper(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
voidsetText(
string $txt
)
:
voidSets text to append. (cannot be used in conjunction w/ files or filesets).
| Name | Type | Description |
|---|---|---|
| $txt | string |
setTo(
$f
)
:
voidSet target file to append to.
| Name | Type | Description |
|---|---|---|
| $f |
- Deprecated
- Will be removed with final release.