diff options
Diffstat (limited to 'buildscripts/phing/classes/phing/tasks/system/TypedefTask.php')
-rwxr-xr-x | buildscripts/phing/classes/phing/tasks/system/TypedefTask.php | 127 |
1 files changed, 127 insertions, 0 deletions
diff --git a/buildscripts/phing/classes/phing/tasks/system/TypedefTask.php b/buildscripts/phing/classes/phing/tasks/system/TypedefTask.php new file mode 100755 index 00000000..c03e716d --- /dev/null +++ b/buildscripts/phing/classes/phing/tasks/system/TypedefTask.php @@ -0,0 +1,127 @@ +<?php +/* + * $Id: 6122dcb36b79ffe3c3fb430a0b4586d9d145410b $ + * + * 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'; + +/** + * Register a datatype for use within a buildfile. + * + * This is for registering your own datatypes for use within a buildfile. + * + * If you find that you are using a particular class frequently, you may want to edit the + * phing/types/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> + * <typedef name="mytype" classname="path.to.MyHandlingClass"/> + * . + * <sometask ...> + * <mytype param1="val1" param2="val2"/> + * </sometask> + * </pre> + * + * TODO: + * -- possibly refactor since this is almost the same as TaskDefTask + * (right now these are just too simple to really justify creating an abstract class) + * + * @author Hans Lellelid <hans@xmpl.org> + * @version $Id$ + * @package phing.tasks.system + */ +class TypedefTask extends Task { + + /** Tag name for datatype 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; + + /** + * 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); + } + + /** Main entry point */ + public function main() { + if ($this->name === null || $this->classname === null) { + throw new BuildException("You must specify name and class attributes for <typedef>."); + } + $this->project->addDataTypeDefinition($this->name, $this->classname, $this->classpath); + } + + /** + * 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; + } +} |