1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
|
<?php
/*
* $Id: Mapper.php 532 2009-08-21 13:32: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>.
*/
include_once 'phing/types/DataType.php';
include_once 'phing/types/Path.php';
/**
* Filename Mapper maps source file name(s) to target file name(s).
*
* Built-in mappers can be accessed by specifying they "type" attribute:
* <code>
* <mapper type="glob" from="*.php" to="*.php.bak"/>
* </code>
* Custom mappers can be specified by providing a dot-path to a include_path-relative
* class:
* <code>
* <mapper classname="myapp.mappers.DevToProdMapper" from="*.php" to="*.php"/>
* <!-- maps all PHP files from development server to production server, for example -->
* </code>
*
* @author Hans Lellelid <hans@xmpl.org>
* @package phing.types
*/
class Mapper extends DataType {
protected $type;
protected $classname;
protected $from;
protected $to;
protected $classpath;
protected $classpathId;
function __construct(Project $project) {
$this->project = $project;
}
/**
* Set the classpath to be used when searching for component being defined
*
* @param Path $classpath An Path object containing the classpath.
*/
public function setClasspath(Path $classpath) {
if ($this->isReference()) {
throw $this->tooManyAttributes();
}
if ($this->classpath === null) {
$this->classpath = $classpath;
} else {
$this->classpath->append($classpath);
}
}
/**
* Create the classpath to be used when searching for component being defined
*/
public function createClasspath() {
if ($this->isReference()) {
throw $this->tooManyAttributes();
}
if ($this->classpath === null) {
$this->classpath = new Path($this->project);
}
return $this->classpath->createPath();
}
/**
* Reference to a classpath to use when loading the files.
*/
public function setClasspathRef(Reference $r) {
if ($this->isReference()) {
throw $this->tooManyAttributes();
}
$this->classpathId = $r->getRefId();
$this->createClasspath()->setRefid($r);
}
/** Set the type of FileNameMapper to use. */
function setType($type) {
if ($this->isReference()) {
throw $this->tooManyAttributes();
}
$this->type = $type;
}
/** Set the class name of the FileNameMapper to use. */
function setClassname($classname) {
if ($this->isReference()) {
throw $this->tooManyAttributes();
}
$this->classname = $classname;
}
/**
* Set the argument to FileNameMapper.setFrom
*/
function setFrom($from) {
if ($this->isReference()) {
throw $this->tooManyAttributes();
}
$this->from = $from;
}
/**
* Set the argument to FileNameMapper.setTo
*/
function setTo($to) {
if ($this->isReference()) {
throw $this->tooManyAttributes();
}
$this->to = $to;
}
/**
* Make this Mapper instance a reference to another Mapper.
*
* You must not set any other attribute if you make it a reference.
*/
function setRefid(Reference $r) {
if ($this->type !== null || $this->from !== null || $this->to !== null) {
throw DataType::tooManyAttributes();
}
parent::setRefid($r);
}
/** Factory, returns inmplementation of file name mapper as new instance */
function getImplementation() {
if ($this->isReference()) {
$tmp = $this->getRef();
return $tmp->getImplementation();
}
if ($this->type === null && $this->classname === null) {
throw new BuildException("either type or classname attribute must be set for <mapper>");
}
if ($this->type !== null) {
switch($this->type) {
case 'identity':
$this->classname = 'phing.mappers.IdentityMapper';
break;
case 'flatten':
$this->classname = 'phing.mappers.FlattenMapper';
break;
case 'glob':
$this->classname = 'phing.mappers.GlobMapper';
break;
case 'regexp':
case 'regex':
$this->classname = 'phing.mappers.RegexpMapper';
break;
case 'merge':
$this->classname = 'phing.mappers.MergeMapper';
break;
default:
throw new BuildException("Mapper type {$this->type} not known");
break;
}
}
// get the implementing class
$cls = Phing::import($this->classname, $this->classpath);
$m = new $cls;
$m->setFrom($this->from);
$m->setTo($this->to);
return $m;
}
/** Performs the check for circular references and returns the referenced Mapper. */
private function getRef() {
if (!$this->checked) {
$stk = array();
$stk[] = $this;
$this->dieOnCircularReference($stk, $this->project);
}
$o = $this->ref->getReferencedObject($this->project);
if (!($o instanceof Mapper)) {
$msg = $this->ref->getRefId()." doesn't denote a mapper";
throw new BuildException($msg);
} else {
return $o;
}
}
}
|