tasks/system/ResolvePathTask.php

Show: inherited
Table of Contents

Task for resolving relative paths and setting absolute path in property value.

This task was created to address a need for resolving absolute paths of files / directories. In many cases a relative directory (e.g. "./build") is specified, but it needs to be treated as an absolute path since other build files (e.g. in subdirs) should all be using the same path -- and not treating it as a relative path to their own directory.



Resolved [absolute] path: ${absolute_path}

TODO: - Possibly integrate this with PackageAsPath, for handling/resolving dot-path paths.

Author
Hans Lellelid  
Package
phing.tasks.system  
Version
$Revision: 552 $  

\ResolvePathTask

Package: phing\tasks\system

Task for resolving relative paths and setting absolute path in property value.

This task was created to address a need for resolving absolute paths of files / directories. In many cases a relative directory (e.g. "./build") is specified, but it needs to be treated as an absolute path since other build files (e.g. in subdirs) should all be using the same path -- and not treating it as a relative path to their own directory.



Resolved [absolute] path: ${absolute_path}

TODO: - Possibly integrate this with PackageAsPath, for handling/resolving dot-path paths.

Parent(s)
\Task < \ProjectComponent
Author
Hans Lellelid  
Version
$Revision: 552 $  

Properties

Propertyprivate  $dir= ''

Base directory used for resolution.

Details
Type
n/a
Propertyprivate  $file= ''

The [possibly] relative file/path that needs to be resolved.

Details
Type
n/a
Propertyprivate  $propertyName= ''

Name of property to set.

Details
Type
n/a

Methods

methodpublicgetDescription( ) : void

methodpublicgetLocation( ) : void

methodpublicgetOwningTarget( ) : void

methodpublicgetProject( ) : void

methodprotectedgetRegisterSlot( ) : void

methodpublicgetRuntimeConfigurableWrapper( ) : void

methodpublicgetTaskName( ) : void

methodpublicgetTaskType( ) : void

methodpublicinit( ) : void

methodpubliclog( ) : void

methodpublicmain( ) : void

Perform the resolution & set property.

methodpublicmaybeConfigure( ) : void

methodpublicperform( ) : void

methodpublicsetDescription( ) : void

methodpublicsetDir( \PhingFile $d ) : void

Sets a base dir to use for resolution.

Parameters
Name Type Description
$d \PhingFile
methodpublicsetFile( string $f ) : void

Sets a file that we want to resolve.

Parameters
Name Type Description
$f string
methodpublicsetLocation( ) : void

methodpublicsetOwningTarget( ) : void

methodpublicsetPath( string $f ) : void

Sets a path (file or directory) that we want to resolve.

This is the same as setFile() -- just more generic name so that it's clear that you can also use it to set directory.

Parameters
Name Type Description
$f string
Details
See
\setFile()  
methodpublicsetProject( ) : void

methodpublicsetPropertyName( string $v ) : void

Set the name of the property to set.

Parameters
Name Type Description
$v string

Property name

methodpublicsetRuntimeConfigurableWrapper( ) : void

methodpublicsetTaskName( ) : void

methodpublicsetTaskType( ) : void

Documentation was generated by DocBlox 0.17.1.