phing-tasks-system

# Class: TstampTask Source Location: /tasks/system/TstampTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --TstampTask
Sets properties to the current time, or offsets from the current time. #### Author(s): Michiel Rook <michiel.rook@gmail.com> #### Version: $Revision: 557 $ #### Copyright: � 2001,2002 THYRELL. All rights reserved | ### Methods addFormat main prefixProperty setPrefix
### 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 35] Sets properties to the current time, or offsets from the current time. The default properties are TSTAMP, DSTAMP and TODAY; Based on Ant's Tstamp task. #### Tags:
author: | Michiel Rook <michiel.rook@gmail.com>
version: | $Revision: 557 $
copyright: | � 2001,2002 THYRELL. All rights reserved
since: | 2.2.0
[ Top ] ### Class Methods ### method addFormat [line 61]
`void addFormat( TstampCustomFormat $cf)`
Adds a custom format #### Tags:
access: | public
#### Parameters:
TstampCustomFormat | $cf | custom format
[ Top ] ### method main [line 72]
`void main( )`
Create the timestamps. Custom ones are done before the standard ones. #### Tags:
throws: | BuildException
access: | public
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 prefixProperty [line 93]
`void prefixProperty( $name, $value)`
helper that encapsulates prefix logic and property setting policy (i.e. we use setNewProperty instead of setProperty). #### Tags:
access: | public
#### Parameters:
| $name |
| $value |
[ Top ] ### method setPrefix [line 46]
`void setPrefix( prefix $prefix)`
Set a prefix for the properties. If the prefix does not end with a "." one is automatically added. #### Tags:
access: | public
#### Parameters:
prefix | $prefix | the prefix to use.
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:52:17 +0200 by phpDocumentor 1.4.3