phing-tasks-system
[ class tree: phing-tasks-system ] [ index: phing-tasks-system ] [ all elements ]

Class: DeleteTask

Source Location: /tasks/system/DeleteTask.php

Class Overview

ProjectComponent
   |
   --Task
      |
      --DeleteTask

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


Author(s):

Version:

  • $Revision: 552 $

Copyright:

  • � 2001,2002 THYRELL. All rights reserved

Variables

Methods


Inherited Variables

Inherited Methods

Class: Task

Task::getDescription()
Returns the textual description of the task
Task::getLocation()
Returns the location within the buildfile this task occurs. Used by BuildException to give detailed error messages.
Task::getOwningTarget()
Returns the owning target of this task.
Task::getRegisterSlot()
Returns a name
Task::getRuntimeConfigurableWrapper()
Returns the wrapper object for runtime configuration
Task::getTaskName()
Returns the name of task, used only for log messages
Task::getTaskType()
Returns the name of the task under which it was invoked, usually the XML tagname
Task::init()
Called by the parser to let the task initialize properly.
Task::log()
Provides a project level log event to the task.
Task::main()
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.
Task::maybeConfigure()
Configure this task if it hasn't been done already.
Task::perform()
Perfrom this task
Task::setDescription()
Sets a textual description of the task
Task::setLocation()
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Task::setOwningTarget()
Sets the owning target this task belongs to.
Task::setRuntimeConfigurableWrapper()
Sets the wrapper object this task should use for runtime configurable elements.
Task::setTaskName()
Sets the name of this task for log messages
Task::setTaskType()
Sets the type of the task. Usually this is the name of the XML tag

Class: ProjectComponent

ProjectComponent::getProject()
Returns a reference to current project
ProjectComponent::log()
Logs a message with the given priority.
ProjectComponent::setProject()
References the project to the current component.

Class Details

[line 30]
Deletes a file or directory, or set of files defined by a fileset.



Tags:

author:  Andreas Aderhold <andi@binarycloud.com>
version:  $Revision: 552 $
copyright:  � 2001,2002 THYRELL. All rights reserved


[ Top ]


Class Variables

$dir =

[line 33]



Tags:

access:  protected

Type:   mixed


[ Top ]

$failonerror =  true

[line 38]



Tags:

access:  protected

Type:   mixed


[ Top ]

$file =

[line 32]



Tags:

access:  protected

Type:   mixed


[ Top ]

$filesets = array()

[line 34]



Tags:

access:  protected

Type:   mixed


[ Top ]

$includeEmpty =  false

[line 35]



Tags:

access:  protected

Type:   mixed


[ Top ]

$quiet =  false

[line 37]



Tags:

access:  protected

Type:   mixed


[ Top ]

$verbosity =  Project::MSG_VERBOSE

[line 39]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


method createFileList [line 105]

void createFileList( )

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



[ Top ]

method createFileSet [line 99]

void createFileSet( )

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



[ Top ]

method main [line 111]

void main( )

Delete the file(s).



Overrides Task::main() (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.)

[ Top ]

method setDir [line 56]

void setDir( $dir)

Set the directory from which files are to be deleted.



Parameters:

PhingFile   $dir  

[ Top ]

method setFailOnError [line 88]

void setFailOnError( $bool)

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



Parameters:

   $bool  

[ Top ]

method setFile [line 48]

void setFile( $file)

Set the name of a single file to be removed.



Parameters:

PhingFile   $file  

[ Top ]

method setIncludeEmptyDirs [line 94]

void setIncludeEmptyDirs( $includeEmpty)

Used to delete empty directories.



Parameters:

   $includeEmpty  

[ Top ]

method setQuiet [line 80]

void setQuiet( $bool)

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:

   $bool  

[ Top ]

method setVerbose [line 64]

void setVerbose( boolean $verbosity)

Used to force listing of all names of deleted files.



Parameters:

boolean   $verbosity  

[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:50:46 +0200 by phpDocumentor 1.4.3