phing-tasks-system

# Class: MoveTask Source Location: /tasks/system/MoveTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --CopyTask
             |
             --MoveTask
Moves a file or directory to a new file or directory. #### Author(s): Andreas Aderhold, andi@binarycloud.com #### Version: $Revision: 552 $ #### Copyright: � 2001,2002 THYRELL. All rights reserved | ### Methods __construct doWork validateAttributes
### Inherited Variables #### Class: CopyTask CopyTask::$completeDirMap CopyTask::$destDir CopyTask::$destFile CopyTask::$dirCopyMap CopyTask::$file CopyTask::$fileCopyMap CopyTask::$filelists CopyTask::$filesets CopyTask::$fileUtils CopyTask::$filterChains CopyTask::$flatten CopyTask::$includeEmpty CopyTask::$mapperElement CopyTask::$mode CopyTask::$overwrite CopyTask::$preserveLMT CopyTask::$verbosity #### Class: Task Task::$description Task::$location Task::$target Task::$taskName Task::$taskType Task::$wrapper #### Class: ProjectComponent ProjectComponent::$project | ### Inherited Methods #### Class: CopyTask CopyTask::__construct() Sets up this object internal stuff. i.e. the Fileutils instance CopyTask::createFileList() Nested creator, adds a set of files (nested fileset attribute). CopyTask::createFileSet() Nested creator, creates a FileSet for this task CopyTask::createFilterChain() Creates a filterchain CopyTask::createMapper() Nested creator, creates one Mapper for this task CopyTask::doWork() Actually copies the files CopyTask::main() The main entry point where everything gets in motion. CopyTask::setFile() Set the file. We have to manually take care of the type that is coming due to limited type support in php in and convert it manually if neccessary. CopyTask::setIncludeEmptyDirs() Set the include empty dirs flag. IntrospectionHelper takes care of booleans in set* methods so we can assume that the right value (boolean primitive) is coming in here. CopyTask::setMode() Sets the mode to create destination directories with (ignored on Windows). CopyTask::setOverwrite() Set the overwrite flag. IntrospectionHelper takes care of booleans in set* methods so we can assume that the right value (boolean primitive) is coming in here. CopyTask::setTodir() Set the toDir. We have to manually take care of the type that is coming due to limited type support in php in and convert it manually if neccessary. CopyTask::setTofile() Set the toFile. We have to manually take care of the type that is coming due to limited type support in php in and convert it manually if neccessary. CopyTask::setTstamp() Set the preserve timestmap flag. IntrospectionHelper takes care of booleans in set* methods so we can assume that the right value (boolean primitive) is coming in here. CopyTask::setVerbose() Used to force listing of all names of copied files. CopyTask::validateAttributes() Validates attributes coming in from XML #### 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 41] Moves a file or directory to a new file or directory. By default, the destination file is overwritten if it already exists. When overwrite is turned off, then files are only moved if the source file is newer than the destination file, or when the destination file does not exist. Source files and directories are only deleted when the file or directory has been copied to the destination successfully. #### Tags:
author: | Andreas Aderhold, andi@binarycloud.com
version: | $Revision: 552 $
copyright: | � 2001,2002 THYRELL. All rights reserved
[ Top ] ### Class Methods ### constructor __construct [line 43]
`MoveTask __construct( )`
Overrides CopyTask::__construct() (Sets up this object internal stuff. i.e. the Fileutils instance) [ Top ] ### method doWork [line 80]
`void doWork( )`
#### Tags:
access: | protected
Overrides CopyTask::doWork() (Actually copies the files) [ Top ] ### method validateAttributes [line 55]
`void validateAttributes( )`
Validates attributes coming in from XML #### Tags:
throws: | BuildException
access: | protected
Overrides CopyTask::validateAttributes() (Validates attributes coming in from XML) [ Top ] Documentation generated on Mon, 19 Oct 2009 10:51:17 +0200 by phpDocumentor 1.4.3