# tasks/system/DeleteTask.php

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

Package
  phing.tasks.system
Version
  $Revision: 552 $

## \DeleteTask
jump to top

Package: phing\tasks\system

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

Parent(s)
  \Task < \ProjectComponent
Version
  $Revision: 552 $

### Properties

`$dir= ''`
Details

Type
  n/a

`$failonerror= 'true'`
Default value `true` Details

Type
  n/a

`$file= ''`
Details

Type
  n/a

`$filelists= 'array()'`

Any filelists of files that should be deleted.

Default value `array()`Details

Type
  n/a

`$filesets= 'array()'`
Default value `array()`Details

Type
  n/a

`$includeEmpty= 'false'`
Default value `false` Details

Type
  n/a

`$quiet= 'false'`
Default value `false` Details

Type
  n/a

`$verbosity= 'Project::MSG_VERBOSE'`
Default value `Project::MSG_VERBOSE` Details

Type
  n/a

### Methods

`createFileList( ) : void`

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

`createFileSet( ) : void`

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

`getDescription( ) : void`

`getLocation( ) : void`

`getOwningTarget( ) : void`

`getProject( ) : void`

`getRegisterSlot( ) : void`

`getRuntimeConfigurableWrapper( ) : void`

`getTaskName( ) : void`

`getTaskType( ) : void`

`init( ) : void`

`log( ) : void`

`main( ) : void`

Delete the file(s).

`maybeConfigure( ) : void`

`perform( ) : void`

`removeDir( \PhingFile $d ) : void`

Recursively removes a directory.

Parameters

Name | Type | Description
--- | --- | ---
$d | \PhingFile | The directory to remove.

`removeFiles( \PhingFile $d, array $files, array $dirs ) : void`

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

Parameters

Name | Type | Description
--- | --- | ---
$d | \PhingFile | directory to work from
$files | array | &$files array of files to delete; can be of zero length
$dirs | array | &$dirs array of directories to delete; can of zero length

`setDescription( ) : void`

`setDir( \PhingFile $dir ) : void`

Set the directory from which files are to be deleted.

Parameters

Name | Type | Description
--- | --- | ---
$dir | \PhingFile |

`setFailOnError( $bool ) : void`

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

Parameters

Name | Type | Description
--- | --- | ---
$bool |  |

`setFile( \PhingFile $file ) : void`

Set the name of a single file to be removed.

Parameters

Name | Type | Description
--- | --- | ---
$file | \PhingFile |

`setIncludeEmptyDirs( $includeEmpty ) : void`

Used to delete empty directories.

Parameters

Name | Type | Description
--- | --- | ---
$includeEmpty |  |

`setLocation( ) : void`

`setOwningTarget( ) : void`

`setProject( ) : void`

`setQuiet( $bool ) : void`

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

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

Parameters

Name | Type | Description
--- | --- | ---
$bool |  |

`setRuntimeConfigurableWrapper( ) : void`

`setTaskName( ) : void`

`setTaskType( ) : void`

`setVerbose( boolean $verbosity ) : void`

Used to force listing of all names of deleted files.

Parameters

Name | Type | Description
--- | --- | ---
$verbosity | boolean |

Documentation was generated by DocBlox 0.17.1.