tasks/system/WaitForTask.php

Show:

inherited

Classes
- \WaitForTask

Table of Contents

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
Package: phing.tasks.system
Version: $Id$

\WaitForTask
jump to top

Package: phing\tasks\system

Based on Apache Ant Wait For:

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

Parent(s): \ConditionBase < \ProjectComponent
Author: Michiel Rook
Copyright: 2001,2002 THYRELL. All rights reserved
Version: $Id$

Constants

 
                ONE_MILLISECOND
                = 1

 
                ONE_SECOND
                = 1000

 
                ONE_MINUTE
                = 60000

 
                ONE_HOUR
                = 3600000

 
                ONE_DAY
                = 86400000

 
                ONE_WEEK
                = 604800000

 
                DEFAULT_MAX_WAIT_MILLIS
                = 180000

 
                DEFAULT_CHECK_MILLIS
                = 500

Properties


                 $checkEvery= 'self::DEFAULT_CHECK_MILLIS'

Default valueself::DEFAULT_CHECK_MILLISDetails

Type: n/a


                 $checkEveryMultiplier= 'self::ONE_MILLISECOND'

Default valueself::ONE_MILLISECONDDetails

Type: n/a


                 $conditions= 'array()'

inheritedInherited from: \ConditionBase::$$conditions

Default valuearray()Details

Type: n/a
Inherited_from: \ConditionBase::$$conditions


                 $maxWait= 'self::DEFAULT_MAX_WAIT_MILLIS'

Default valueself::DEFAULT_MAX_WAIT_MILLISDetails

Type: n/a


                 $maxWaitMultiplier= 'self::ONE_MILLISECOND'

Default valueself::ONE_MILLISECONDDetails

Type: n/a

\Project
                 $project= 'null'

inherited

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

A reference to the current project instanceInherited from: \ProjectComponent::$$project \ConditionBase::$$project

Default valuenullDetails

Type: \Project
Inherited_from: \ProjectComponent::$$project
Inherited_from: \ConditionBase::$$project


                 $timeoutProperty= 'null'

Default valuenullDetails

Type: n/a

Methods

_convertUnit(
          string $unit
          )
        
        :
          void

Convert the unit to a multipler.

Parameters

Name	Type	Description
$unit	string

addAvailable(
           $a
          )
        
        :
          void

inherited

Inherited from: \ConditionBase::addAvailable()

Parameters

Name	Type	Description
$a

countConditions(
          
          )
        
        :
          void

inherited

Inherited from: \ConditionBase::countConditions()

createAnd(
          
          )
        
        :
          \AndCondition

inherited

Inherited from: \ConditionBase::createAnd()

Returns

Type	Description
\AndCondition

createContains(
          
          )
        
        :
          \ContainsCondition

inherited

Inherited from: \ConditionBase::createContains()

Returns

Type	Description
\ContainsCondition

createEquals(
          
          )
        
        :
          \EqualsCondition

inherited

Inherited from: \ConditionBase::createEquals()

Returns

Type	Description
\EqualsCondition

createIsFalse(
          
          )
        
        :
          \IsFalseCondition

inherited

Inherited from: \ConditionBase::createIsFalse()

Returns

Type	Description
\IsFalseCondition

createIsSet(
          
          )
        
        :
          \IsSetCondition

inherited

Inherited from: \ConditionBase::createIsSet()

Returns

Type	Description
\IsSetCondition

createIsTrue(
          
          )
        
        :
          \IsTrueCondition

inherited

Inherited from: \ConditionBase::createIsTrue()

Returns

Type	Description
\IsTrueCondition

createNot(
          
          )
        
        :
          \NotCondition

inherited

Inherited from: \ConditionBase::createNot()

Returns

Type	Description
\NotCondition

createOr(
          
          )
        
        :
          \OrCondition

inherited

Inherited from: \ConditionBase::createOr()

Returns

Type	Description
\OrCondition

createOs(
          
          )
        
        :
          \OsCondition

inherited

Inherited from: \ConditionBase::createOs()

Returns

Type	Description
\OsCondition

createReferenceExists(
          
          )
        
        :
          \ReferenceExistsCondition

inherited

Inherited from: \ConditionBase::createReferenceExists()

Returns

Type	Description
\ReferenceExistsCondition

getConditions(
          
          )
        
        :
          void

inherited

Inherited from: \ConditionBase::getConditions()

getIterator(
          
          )
        
        :
          void

inherited

Required for IteratorAggregate

Inherited from: \ConditionBase::getIterator()

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\ConditionBase::getProject()

Returns

Type	Description
\Project	Reference to current porject object

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

inherited

Logs a message with the given priority.

Inherited from: \ProjectComponent::log()\ConditionBase::log()

Parameters

Name	Type	Description
$msg	string	The message to be logged.
$level	integer	The message's priority at this message should have

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

Throws

Exception	Description
\BuildException

setCheckEvery(
          int $checkEvery
          )
        
        :
          void

Set the time between each check

Parameters

Name	Type	Description
$checkEvery	int

setCheckEveryUnit(
          string $checkEveryUnit
          )
        
        :
          void

Set the check every time unit

Parameters

Name	Type	Description
$checkEveryUnit	string

setMaxWait(
          int $maxWait
          )
        
        :
          void

Set the maximum length of time to wait.

Parameters

Name	Type	Description
$maxWait	int

setMaxWaitUnit(
          string $maxWaitUnit
          )
        
        :
          void

Set the max wait time unit

Parameters

Name	Type	Description
$maxWaitUnit	string

setProject(
          \Project $project
          )
        
        :
          void

inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\ConditionBase::setProject()

Parameters

Name	Type	Description
$project	\Project	The reference to the current project

setTimeoutProperty(
          string $timeoutProperty
          )
        
        :
          void

Name of the property to set after a timeout.

Parameters

Name	Type	Description
$timeoutProperty	string

tasks/system/WaitForTask.php

\WaitForTaskjump to top

Constants

Properties

Methods

\WaitForTask
jump to top