Viewing file:  ResolvePathTask.php (4.19 KB) -rw-rw-rw-
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* $Id: ResolvePathTask.php 552 2009-08-29 12:18:13Z mrook $
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information please see
* <http://phing.info>.
*/
require_once 'phing/Task.php';
/**
* 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.
*
* <code>
* <property name="relative_path" value="./dirname"/>
* <resolvepath propertyName="absolute_path" file="${relative_path}"/>
* <echo>Resolved [absolute] path: ${absolute_path}</echo>
* </code>
*
* TODO:
* - Possibly integrate this with PackageAsPath, for handling/resolving dot-path paths.
*
* @author Hans Lellelid <hans@xmpl.org>
* @version $Revision: 552 $
* @package phing.tasks.system
*/
class ResolvePathTask extends Task {
/** Name of property to set. */
private $propertyName;
/** The [possibly] relative file/path that needs to be resolved. */
private $file;
/** Base directory used for resolution. */
private $dir;
/**
* Set the name of the property to set.
* @param string $v Property name
* @return void
*/
public function setPropertyName($v) {
$this->propertyName = $v;
}
/**
* Sets a base dir to use for resolution.
* @param PhingFile $d
*/
function setDir(PhingFile $d) {
$this->dir = $d;
}
/**
* 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.
* @param string $f
* @see setFile()
*/
function setPath($f) {
$this->file = $f;
}
/**
* Sets a file that we want to resolve.
* @param string $f
*/
function setFile($f) {
$this->file = $f;
}
/**
* Perform the resolution & set property.
*/
public function main() {
if (!$this->propertyName) {
throw new BuildException("You must specify the propertyName attribute", $this->getLocation());
}
// Currently only files are supported
if ($this->file === null) {
throw new BuildException("You must specify a path to resolve", $this->getLocation());
}
$fs = FileSystem::getFileSystem();
// if dir attribute was specified then we should
// use that as basedir to which file was relative.
// -- unless the file specified is an absolute path
if ($this->dir !== null && !$fs->isAbsolute(new PhingFile($this->file))) {
$resolved = new PhingFile($this->dir->getPath(), $this->file);
} else {
// otherwise just resolve it relative to project basedir
$resolved = $this->project->resolveFile($this->file);
}
$this->log("Resolved " . $this->file . " to " . $resolved->getAbsolutePath(), Project::MSG_INFO);
$this->project->setProperty($this->propertyName, $resolved->getAbsolutePath());
}
}
|