A phing sleep task.
A task for sleeping a short period of time, useful when a build or deployment process requires an interval between tasks.
A negative value can be supplied to any of attributes provided the total sleep time is positive, pending fundamental changes in physics and PHP execution times.
Note that sleep times are always hints to be interpreted by the OS how it feels small times may either be ignored or rounded up to a minimum timeslice. Note also that the system clocks often have a fairly low granularity too, which complicates measuring how long a sleep actually took.
author |
Daniel Kutik, daniel@kutik.eu |
---|---|
version |
$Id: 95d0328752cfbcc4e3ed9e3f003d942299e5d4d0 $ |
package |
phing.tasks.system |
getDescription() : string
string
The text description of the task
getFailOnError() : boolean
boolean
getHours() : mixed
mixed
getLocation() : \Location
getMilliseconds() : mixed
mixed
getMinutes() : mixed
mixed
getOwningTarget() : \Target
getProject() : \Project
getRegisterSlot(string $slotName) : \RegisterSlot
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
getSeconds() : mixed
mixed
getSleepTime() : integer
integer
time. if below 0 then there is an error
getTaskName() : string
string
Name of this task
getTaskType() : string
string
The type of this task (XML Tag)
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
throws | |
---|---|
log(string $msg, integer $level = \Project::MSG_INFO) : void
string
The message to be logged.
integer
The message's priority at this message should have
main()
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
maybeConfigure()
perform()
throws | |
---|---|
setDescription(string $desc)
string
The text describing the task
setFailOnError(string $var)
string
setHours(mixed $hours)
mixed
setLocation(\Location $location)
setMilliseconds(mixed $milliseconds)
mixed
setMinutes(mixed $minutes)
mixed
setOwningTarget(\Target $target)
setProject(\Project $project) : void
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
setSeconds(mixed $seconds)
mixed
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
setTaskType( $name)
validateAttributes()
throws |
if something is invalid |
---|---|
failOnError : boolean
var |
---|
boolean
seconds :
hours :
minutes :
milliseconds :
description : string
var |
---|
string
taskType : string
var |
---|
string
taskName : string
var |
---|
string
project : \Project