BlockForTask

Extends \WaitForTask

Based on Apache Ant Block 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

Siad Ardroumli siad.ardroumli@gmail.com

package

phing.tasks.system

Methods

__construct

__construct( $taskName = 'component') 
inherited

Arguments

$taskName

Convert the unit to a multipler.

_convertUnit(string $unit) : integer
inherited
throws

Arguments

$unit

string

Response

integer

addAvailable

addAvailable(\AvailableTask $a) : void
inherited

Arguments

Set the error text; all properties are expanded in the message.

addText(string $message) 

Arguments

$message

string

the text to use in a failure message

countConditions

countConditions() : integer
inherited

Response

integer

createAnd

createAnd() : \AndCondition
inherited

Response

\AndCondition

createContains

createContains() : \ContainsCondition
inherited

createEquals

createEquals() : \EqualsCondition
inherited

Response

\EqualsCondition

createFilesMatch

createFilesMatch() 
inherited

createHasFreeSpace

createHasFreeSpace() 
inherited

createHttp

createHttp() 
inherited

createIsFailure

createIsFailure() 
inherited

createIsFalse

createIsFalse() : \IsFalseCondition
inherited

createIsFileSelected

createIsFileSelected() 
inherited

createIsPropertyFalse

createIsPropertyFalse() : \IsPropertyFalseCondition
inherited

createIsPropertyTrue

createIsPropertyTrue() : \IsPropertyTrueCondition
inherited

createIsSet

createIsSet() : \IsSetCondition
inherited

Response

\IsSetCondition

createIsTrue

createIsTrue() : \IsTrueCondition
inherited

Response

\IsTrueCondition

createNot

createNot() : \NotCondition
inherited

Response

\NotCondition

createOr

createOr() : \OrCondition
inherited

Response

\OrCondition

createOs

createOs() : \OsCondition
inherited

Response

\OsCondition

createPhingVersion

createPhingVersion() 
inherited

createReferenceExists

createReferenceExists() : \ReferenceExistsCondition
inherited

createSocket

createSocket() 
inherited

createVersionCompare

createVersionCompare() 
inherited

createXor

createXor() : \XorCondition
inherited

Response

\XorCondition

Creates the object for the child element

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

Arguments

$elementName

string

the name of the element that has been requested

$project

\Project

The project the element is in

Response

\Condition

getConditions

getConditions() : array<mixed,\Condition>
inherited

Response

array<mixed,\Condition>

Required for IteratorAggregate

getIterator() 
inherited

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Returns the name to use in logging messages.

getTaskName() : string
inherited

Response

string

the name to use in logging messages.

Logs a message with the given priority.

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

Arguments

$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.

main() 
inherited
throws

processSuccess

processSuccess() 
inherited

processTimeout

processTimeout() 
inherited

Set the time between each check

setCheckEvery(integer $checkEvery) 
inherited

Arguments

$checkEvery

integer

Set the check every time unit

setCheckEveryUnit(string $checkEveryUnit) : void
inherited

Arguments

$checkEveryUnit

string

Set the maximum length of time to wait.

setMaxWait(integer $maxWait) 
inherited

Arguments

$maxWait

integer

Set the max wait time unit

setMaxWaitUnit(string $maxWaitUnit) 
inherited

Arguments

$maxWaitUnit

string

References the project to the current component.

setProject(\Project $project) : void
inherited

Arguments

$project

\Project

The reference to the current project

Sets the name to use in logging messages.

setTaskName(string $name) 
inherited

Arguments

$name

string

The name to use in logging messages. Should not be null.

Name of the property to set after a timeout.

setTimeoutProperty(string $timeoutProperty) : void
inherited

Arguments

$timeoutProperty

string

Constants

ONE_MILLISECOND

ONE_MILLISECOND
inherited

ONE_SECOND

ONE_SECOND
inherited

ONE_MINUTE

ONE_MINUTE
inherited

ONE_HOUR

ONE_HOUR
inherited

ONE_DAY

ONE_DAY
inherited

ONE_WEEK

ONE_WEEK
inherited

DEFAULT_MAX_WAIT_MILLIS

DEFAULT_MAX_WAIT_MILLIS
inherited

DEFAULT_CHECK_MILLIS

DEFAULT_CHECK_MILLIS
inherited

Properties

Text to include in a message

text : 

Type(s)

maxWait

maxWait : 
inherited

Type(s)

maxWaitMultiplier

maxWaitMultiplier : 
inherited

Type(s)

checkEvery

checkEvery : 
inherited

Type(s)

checkEveryMultiplier

checkEveryMultiplier : 
inherited

Type(s)

timeoutProperty

timeoutProperty : 
inherited

Type(s)

conditions

conditions : 
inherited

Type(s)

taskName

taskName : string
inherited
var

Type(s)

string

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