Phing API Documentation
Back to top  

DeleteTask

Extends \Task

Deletes a file or directory, or set of files defined by a fileset.

Use {@link Project#createTask} to register a new Task.

version

$Id: c8a27d142a32a51a6cba57b752ad7d36bd4c8a0c $
package

phing.tasks.system

Methods

Set the name of a single file to be removed.

setFile(\PhingFile $file)

Arguments

$file

\PhingFile

Set the directory from which files are to be deleted.

setDir(\PhingFile $dir)

Arguments

$dir

\PhingFile

Used to force listing of all names of deleted files.

setVerbose(boolean $verbosity)

Arguments

$verbosity

boolean

If the file does not exist, do not display a diagnostic message or modify the exit status to reflect an error.

setQuiet($bool)

This means that if a file or directory cannot be deleted, then no error is reported. This setting emulates the -f option to the Unix rm command. Default is false meaning things are verbose

Arguments

$bool

this flag means 'note errors to the output, but keep going'

setFailOnError($bool)

Arguments

$bool

Used to delete empty directories.

setIncludeEmptyDirs($includeEmpty)

Arguments

$includeEmpty

Nested creator, adds a set of files (nested fileset attribute).

addFileSet(\FileSet $fs)

Arguments

$fs

\FileSet

Nested creator, adds a set of files (nested fileset attribute).

createFileList()

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.

Recursively removes a directory.

removeDir(\PhingFile $d)

Arguments

$d

\PhingFile

The directory to remove.

remove an array of files in a directory, and a list of subdirectories which will only be deleted if 'includeEmpty' is true

removeFiles(\PhingFile $d, $files, $dirs)

Arguments

$d

\PhingFile

directory to work from

$files

$dirs

Sets the owning target this task belongs to.

setOwningTarget(\Target $target)
inherited

Arguments

$target

\Target

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

$name

string

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

Arguments

$name

Returns a name

getRegisterSlot(string $slotName)
inherited

Arguments

$slotName

string

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.

throws

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

Response

\RuntimeConfigurable

The wrapper object used by this task

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

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

maybeConfigure()
inherited

Perfrom this task

perform()
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

file

file :

dir

dir :

filesets

filesets :

includeEmpty

includeEmpty :

quiet

quiet :

failonerror

failonerror :

verbosity

verbosity :

Any filelists of files that should be deleted.

filelists :

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Description of the task

description : string
inherited
var

Type(s)

string

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

Stored buildfile location

location : \Location
inherited
var

Type(s)

\Location

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