WaitForTask

Extends \ConditionBase

Based on Apache Ant Wait For:

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

author

Michiel Rook mrook@php.net

version

$Id$

package

phing.tasks.system

Methods

Set the maximum length of time to wait.

setMaxWait(int $maxWait) 

Arguments

$maxWait

int

Set the max wait time unit

setMaxWaitUnit(string $maxWaitUnit) 

Arguments

$maxWaitUnit

string

Set the time between each check

setCheckEvery(int $checkEvery) 

Arguments

$checkEvery

int

Set the check every time unit

setCheckEveryUnit(string $checkEveryUnit) 

Arguments

$checkEveryUnit

string

Name of the property to set after a timeout.

setTimeoutProperty(string $timeoutProperty) 

Arguments

$timeoutProperty

string

Convert the unit to a multipler.

_convertUnit(string $unit) 

Arguments

$unit

string

Check repeatedly for the specified conditions until they become true or the timeout expires.

main() 
throws

countConditions

countConditions() 
inherited

Required for IteratorAggregate

getIterator() 
inherited

getConditions

getConditions() 
inherited

addAvailable

addAvailable(\AvailableTask $a) : void
inherited

Arguments

createNot

createNot() : \NotCondition
inherited

Response

\NotCondition

createAnd

createAnd() : \AndCondition
inherited

Response

\AndCondition

createOr

createOr() : \OrCondition
inherited

Response

\OrCondition

createEquals

createEquals() : \EqualsCondition
inherited

Response

\EqualsCondition

createOs

createOs() : \OsCondition
inherited

Response

\OsCondition

createIsFalse

createIsFalse() : \IsFalseCondition
inherited

createIsTrue

createIsTrue() : \IsTrueCondition
inherited

Response

\IsTrueCondition

createContains

createContains() : \ContainsCondition
inherited

createIsSet

createIsSet() : \IsSetCondition
inherited

Response

\IsSetCondition

createReferenceExists

createReferenceExists() : \ReferenceExistsCondition
inherited

customChildCreator

customChildCreator(string $elementName, \Project $project) : \Condition
inherited
throws

Arguments

$elementName

string

$project

\Project

Response

\Condition

References the project to the current component.

setProject(\Project $project) 
inherited

Arguments

$project

\Project

The reference to the current project

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO) 
inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Constants

ONE_MILLISECOND

ONE_MILLISECOND

ONE_SECOND

ONE_SECOND

ONE_MINUTE

ONE_MINUTE

ONE_HOUR

ONE_HOUR

ONE_DAY

ONE_DAY

ONE_WEEK

ONE_WEEK

DEFAULT_MAX_WAIT_MILLIS

DEFAULT_MAX_WAIT_MILLIS

DEFAULT_CHECK_MILLIS

DEFAULT_CHECK_MILLIS

Properties

maxWait

maxWait : 

maxWaitMultiplier

maxWaitMultiplier : 

checkEvery

checkEvery : 

checkEveryMultiplier

checkEveryMultiplier : 

timeoutProperty

timeoutProperty : 

conditions

conditions : 
inherited

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project