tasks/system/UpToDateTask.php

Show: inherited
Table of Contents

\UpToDateTask

Package: phing\tasks\system

Sets the given property if the specified target has a timestamp greater than all of the source files.

Use {@link Project#createTask} to register a new Task.

Parent(s)
\Condition < \ProjectComponent
Author
Hans Lellelid (Phing)  
Author
William Ferguson (Ant)  
Author
Hiroaki Nakamura (Ant)  
Author
Stefan Bodewig (Ant)  
Copyright
2001,2002 THYRELL. All rights reserved  
Version
$Id$  

Properties

Propertyprivate  $_filelists= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $_property= ''
Details
Type
n/a
Propertyprivate  $_sourceFile= ''
Details
Type
n/a
Propertyprivate  $_targetFile= ''
Details
Type
n/a
Propertyprivate  $_value= ''
Details
Type
n/a
Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Propertyprotected  $mapperElement= 'null'
Default valuenullDetails
Type
n/a
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\Task::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Propertyprivate  $sourceFileSets= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  

Methods

methodpublicaddFileset(  $fs ) : void

Nested element.

Parameters
Name Type Description
$fs
methodpubliccreateFileList( ) : \FileList

Supports embedded element.

Returns
Type Description
\FileList
methodpubliccreateMapper( ) : void

Defines the FileNameMapper to use (nested mapper element).

methodpubliccreateSrcfiles( ) : void

Nested element.

Details
Deprecated
Deprecated since Phing 2.4.0  
methodpublicevaluate( ) : boolean

Evaluate (all) target and source file(s) to see if the target(s) is/are up-to-date.

Returns
Type Description
boolean
methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns
Type Description
string The text description of the task
methodpublicgetLocation( ) : \Location
inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()
Returns
Type Description
\Location The location object describing the position of this task within the buildfile.
methodpublicgetOwningTarget( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()
Returns
Type Description
\Project Reference to current porject object
methodpublicgetProperty( ) : void

Get property name

methodprotectedgetRegisterSlot( string $slotName ) : void
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()
Parameters
Name Type Description
$slotName string
methodpublicgetRuntimeConfigurableWrapper( ) : \RuntimeConfigurable
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()
Returns
Type Description
\RuntimeConfigurable The wrapper object used by this task
methodpublicgetTaskName( ) : string
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()
Returns
Type Description
string Name of this task
methodpublicgetTaskType( ) : string
inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()
Returns
Type Description
string The type of this task (XML Tag)
methodprivategetValue( ) : void

Returns the value, or "true" if a specific value wasn't provided.

methodpublicinit( ) : void
inherited

Called by the parser to let the task initialize properly.

Inherited from: \Task::init()

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

Throws
Exception Description
\BuildException
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()
Parameters
Name Type Description
$msg string

The message to log

$level integer

The priority of the message

Details
See
\BuildEvent  
See
\BuildListener  
methodpublicmain( ) : void

Sets property to true if target file(s) have a more recent timestamp than (each of) the corresponding source file(s).

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Throws
Exception Description
\BuildException
methodpublicmaybeConfigure( ) : void
inherited

Configure this task if it hasn't been done already.

Inherited from: \Task::maybeConfigure()
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()
methodprotectedscanDir(  $srcDir,  $files ) : void

Parameters
Name Type Description
$srcDir
$files
methodpublicsetDescription( string $desc ) : void
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()
Parameters
Name Type Description
$desc string

The text describing the task

methodpublicsetLocation( \Location $location ) : void
inherited

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

Inherited from: \Task::setLocation()
Parameters
Name Type Description
$location \Location

The location object describing the position of this task within the buildfile.

methodpublicsetOwningTarget( \Target $target ) : void
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()
Parameters
Name Type Description
$target \Target

Reference to owning target

methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetProperty( \property $property ) : void

The property to set if the target file is more up-to-date than (each of) the source file(s).

Parameters
Name Type Description
$property \property

the name of the property to set if Target is up-to-date.

methodpublicsetRuntimeConfigurableWrapper( \RuntimeConfigurable $wrapper ) : void
inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()
Parameters
Name Type Description
$wrapper \RuntimeConfigurable

The wrapper object this task should use

methodpublicsetSrcfile( \file $file ) : void

The file that must be older than the target file if the property is to be set.

Parameters
Name Type Description
$file \file

the file we are checking against the target file.

methodpublicsetTargetFile( \file $file ) : void

The file which must be more up-to-date than (each of) the source file(s) if the property is to be set.

Parameters
Name Type Description
$file \file

the file we are checking against.

methodpublicsetTaskName( string $name ) : string
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()
Parameters
Name Type Description
$name string
Returns
Type Description
string A string representing the name of this task for log
methodpublicsetTaskType( string $name ) : void
inherited

Sets the type of the task. Usually this is the name of the XML tag

Inherited from: \Task::setTaskType()
Parameters
Name Type Description
$name string

The type of this task (XML Tag)

methodpublicsetValue( \value $value ) : void

The value to set the named property to if the target file is more up-to-date than (each of) the source file(s). Defaults to 'true'.

Parameters
Name Type Description
$value \value

the value to set the property to if Target is up-to-date

Documentation was generated by DocBlox 0.18.1.