phing-tasks-system

# Class: TouchTask Source Location: /tasks/system/TouchTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --TouchTask
Touch a file and/or fileset(s); corresponds to the Unix touch command. #### Author(s): Andreas Aderhold <andi@binarycloud.com> #### Version: $Revision: 526 $ #### Copyright: � 2001,2002 THYRELL. All rights reserved | ### Methods __construct createFileSet main setDatetime setFile setMillis _touch
### Inherited Variables #### Class: Task Task::$description Task::$location Task::$target Task::$taskName Task::$taskType Task::$wrapper #### Class: ProjectComponent ProjectComponent::$project | ### 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 37] Touch a file and/or fileset(s); corresponds to the Unix touch command. If the file to touch doesn't exist, an empty one is created. #### Tags:
author: | Andreas Aderhold <andi@binarycloud.com>
version: | $Revision: 526 $
copyright: | � 2001,2002 THYRELL. All rights reserved
[ Top ] ### Class Methods ### constructor __construct [line 45]
`TouchTask __construct( )`
[ Top ] ### method createFileSet [line 79]
`FileSet createFileSet( )`
Nested creator, adds a set of files (nested fileset attribute). [ Top ] ### method main [line 87]
`void main( )`
Execute the touch operation. 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 setDatetime [line 71]
`void setDatetime( $dateTime)`
the new modification time of the file in the format MM/DD/YYYY HH:MM AM or PM; Optional, default=now #### Parameters:
| $dateTime |
[ Top ] ### method setFile [line 53]
`void setFile( $file)`
Sets a single source file to touch. If the file does not exist an empty file will be created. #### Parameters:
PhingFile | $file |
[ Top ] ### method setMillis [line 62]
`void setMillis( $millis)`
the new modification time of the file in milliseconds since midnight Jan 1 1970. Optional, default=now #### Parameters:
| $millis |
[ Top ] ### method _touch [line 117]
`void _touch( )`
Does the actual work. [ Top ] Documentation generated on Mon, 19 Oct 2009 10:52:16 +0200 by phpDocumentor 1.4.3