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
|
<?php
/*
* $Id: df52def0bb44ce1b0909f5e8858e79b2ef88ca0f $
*
* 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';
include_once 'phing/system/io/PhingFile.php';
/**
* Register a task for use within a buildfile.
*
* This is for registering your own tasks -- or any non-core Task -- for use within a buildfile.
* If you find that you are using a particular class frequently, you may want to edit the
* phing/tasks/defaults.properties file so that it is included by default. You may also
* want to submit it (if LGPL or compatible license) to be included in Phing distribution.
*
* <pre>
* <taskdef name="mytag" classname="path.to.MyHandlingClass"/>
* .
* .
* <mytag param1="val1" param2="val2"/>
* </pre>
*
* TODO:
* -- possibly refactor since this is almost the same as TypeDefTask
* (right now these are just too simple to really justify creating an abstract class)
*
* @author Hans Lellelid <hans@xmpl.org>
* @version $Id: df52def0bb44ce1b0909f5e8858e79b2ef88ca0f $
* @package phing.tasks.system
*/
class TaskdefTask extends Task {
/** Tag name for task that will be used in XML */
private $name;
/**
* Classname of task to register.
* This can be a dot-path -- relative to a location on PHP include_path.
* E.g. path.to.MyClass -> path/to/MyClass.php
* @var string
*/
private $classname;
/**
* Path to add to PHP include_path to aid in finding specified class.
* @var Path
*/
private $classpath;
/**
* Refid to already defined classpath
*/
private $classpathId;
/**
* Name of file to load multiple definitions from.
* @var string
*/
private $typeFile;
/**
* Set the classpath to be used when searching for component being defined
*
* @param Path $classpath A Path object containing the classpath.
*/
public function setClasspath(Path $classpath) {
if ($this->classpath === null) {
$this->classpath = $classpath;
} else {
$this->classpath->append($classpath);
}
}
/**
* Create the classpath to be used when searching for component being defined
*
* @return Path
*/
public function createClasspath() {
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) {
$this->classpathId = $r->getRefId();
$this->createClasspath()->setRefid($r);
}
/**
* Sets the name that will be used in XML buildfile.
* @param string $name
*/
public function setName($name) {
$this->name = $name;
}
/**
* Sets the class name / dotpath to use.
* @param string $class
*/
public function setClassname($class) {
$this->classname = $class;
}
/**
* Sets the file of definitionas to use to use.
* @param string $file
*/
public function setFile($file) {
$this->typeFile = $file;
}
/** Main entry point */
public function main() {
if ($this->typeFile === null &&
($this->name === null || $this->classname === null)) {
throw new BuildException("You must specify name and class attributes for <taskdef>.");
}
if ($this->typeFile == null) {
$this->log("Task " . $this->name . " will be handled by class " . $this->classname, Project::MSG_VERBOSE);
$this->project->addTaskDefinition($this->name, $this->classname, $this->classpath);
} else {
try { // try to load taskdefs given in file
$props = new Properties();
$in = new PhingFile((string) $this->typeFile);
if ($in === null) {
throw new BuildException("Can't load task list {$this->typeFile}");
}
$props->load($in);
$enum = $props->propertyNames();
foreach($enum as $key) {
$value = $props->getProperty($key);
$this->project->addTaskDefinition($key, $value, $this->classpath);
}
} catch (IOException $ioe) {
throw new BuildException("Can't load task list {$this->typeFile}");
}
}
}
}
|
