tasks/system/ConditionTask.php

Show: inherited
Table of Contents

<condition> task as a generalization of <available>

This task supports boolean logic as well as pluggable conditions to decide, whether a property should be set.

This task does not extend Task to take advantage of ConditionBase.

Access
public  
Author
Andreas Aderhold  
Copyright
2001,2002 THYRELL. All rights reserved  
Package
phing.tasks.system  
Version
$Id$  

\ConditionTask

Package: phing\tasks\system

<condition> task as a generalization of <available>

This task supports boolean logic as well as pluggable conditions to decide, whether a property should be set.

This task does not extend Task to take advantage of ConditionBase.

Parent(s)
\ConditionBase < \ProjectComponent
Access
public  
Author
Andreas Aderhold  
Copyright
2001,2002 THYRELL. All rights reserved  
Version
$Id$  

Properties

Propertypublic  $conditions= 'array()'
inheritedInherited from: \ConditionBase::$$conditions
Default valuearray()Details
Type
n/a
Inherited_from
\ConditionBase::$$conditions  
Propertyprotected\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  
Propertyprivate  $property= ''
Details
Type
n/a
Propertyprivate  $value= '"true"'
Default value"true"Details
Type
n/a

Methods

methodpublicaddAvailable(  $a ) : void
inherited

Inherited from: \ConditionBase::addAvailable()
Parameters
Name Type Description
$a
methodpubliccountConditions( ) : void
inherited

Inherited from: \ConditionBase::countConditions()
methodpubliccreateAnd( ) : \AndCondition
inherited

Inherited from: \ConditionBase::createAnd()
Returns
Type Description
\AndCondition
methodpubliccreateContains( ) : \ContainsCondition
inherited

Inherited from: \ConditionBase::createContains()
Returns
Type Description
\ContainsCondition
methodpubliccreateEquals( ) : \EqualsCondition
inherited

Inherited from: \ConditionBase::createEquals()
Returns
Type Description
\EqualsCondition
methodpubliccreateIsFalse( ) : \IsFalseCondition
inherited

Inherited from: \ConditionBase::createIsFalse()
Returns
Type Description
\IsFalseCondition
methodpubliccreateIsSet( ) : \IsSetCondition
inherited

Inherited from: \ConditionBase::createIsSet()
Returns
Type Description
\IsSetCondition
methodpubliccreateIsTrue( ) : \IsTrueCondition
inherited

Inherited from: \ConditionBase::createIsTrue()
Returns
Type Description
\IsTrueCondition
methodpubliccreateNot( ) : \NotCondition
inherited

Inherited from: \ConditionBase::createNot()
Returns
Type Description
\NotCondition
methodpubliccreateOr( ) : \OrCondition
inherited

Inherited from: \ConditionBase::createOr()
Returns
Type Description
\OrCondition
methodpubliccreateOs( ) : \OsCondition
inherited

Inherited from: \ConditionBase::createOs()
Returns
Type Description
\OsCondition
methodpubliccreateReferenceExists( ) : \ReferenceExistsCondition
inherited

Inherited from: \ConditionBase::createReferenceExists()
Returns
Type Description
\ReferenceExistsCondition
methodpublicgetConditions( ) : void
inherited

Inherited from: \ConditionBase::getConditions()
methodpublicgetIterator( ) : void
inherited

Required for IteratorAggregate

Inherited from: \ConditionBase::getIterator()
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\ConditionBase::getProject()
Returns
Type Description
\Project Reference to current porject object
methodpubliclog( 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

methodpublicmain( ) : void

See whether our nested condition holds and set the property.

methodpublicsetProject( \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

methodpublicsetProperty(  $p ) : void

The name of the property to set. Required.

Parameters
Name Type Description
$p
methodpublicsetValue(  $v ) : void

The value for the property to set. Defaults to "true".

Parameters
Name Type Description
$v
Documentation was generated by DocBlox 0.18.1.