Files
luos/thirdparty/phing/tasks/system/ForeachTask.php
Paula Quispe 9eb7d6cac2 HOR-2689
2017-08-03 17:00:30 -04:00

139 lines
4.4 KiB
PHP

<?php
/*
* $Id: ForeachTask.php 3076 2006-12-18 08:52:12Z fabien $
*
* 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/TaskPhing.php';
include_once 'phing/tasks/system/PhingTask.php';
/**
* <foreach> task
*
* Task definition for the foreach task. This task takes a list with
* delimited values, and executes a target with set param.
*
* Usage:
* <foreach list="values" target="targ" param="name" delimiter="|" />
*
* Attributes:
* list --> The list of values to process, with the delimiter character,
* indicated by the "delimiter" attribute, separating each value.
* target --> The target to call for each token, passing the token as the
* parameter with the name indicated by the "param" attribute.
* param --> The name of the parameter to pass the tokens in as to the
* target.
* delimiter --> The delimiter string that separates the values in the "list"
* parameter. The default is ",".
*
* @author Jason Hines <jason@greenhell.com>
* @author Hans Lellelid <hans@xmpl.org>
* @version $Revision: 1.9 $
* @package phing.tasks.system
*/
class ForeachTask extends TaskPhing {
/** Delimter-separated list of values to process. */
private $list;
/** Name of parameter to pass to callee */
private $param;
/** Delimter that separates items in $list */
private $delimiter = ',';
/**
* PhingCallTask that will be invoked w/ calleeTarget.
* @var PhingCallTask
*/
private $callee;
/**
* Target to execute.
* @var string
*/
private $calleeTarget;
function init() {
$this->callee = $this->project->createTask("phingcall");
$this->callee->setOwningTarget($this->getOwningTarget());
$this->callee->setTaskName($this->getTaskName());
$this->callee->setLocation($this->getLocation());
$this->callee->init();
}
/**
* This method does the work.
* @return void
*/
function main() {
if ($this->list === null) {
throw new BuildException("Missing list to iterate through");
}
if (trim($this->list) === '') {
return;
}
if ($this->param === null) {
throw new BuildException("You must supply a property name to set on each iteration in param");
}
if ($this->calleeTarget === null) {
throw new BuildException("You must supply a target to perform");
}
$callee = $this->callee;
$callee->setTarget($this->calleeTarget);
$callee->setInheritAll(true);
$callee->setInheritRefs(true);
$arr = explode($this->delimiter, $this->list);
foreach ($arr as $value) {
$this->log("Setting param '$this->param' to value '$value'", PROJECT_MSG_VERBOSE);
$prop = $callee->createProperty();
$prop->setOverride(true);
$prop->setName($this->param);
$prop->setValue($value);
$callee->main();
}
}
function setList($list) {
$this->list = (string) $list;
}
function setTarget($target) {
$this->calleeTarget = (string) $target;
}
function setParam($param) {
$this->param = (string) $param;
}
function setDelimiter($delimiter) {
$this->delimiter = (string) $delimiter;
}
/**
* @return Property
*/
function createProperty() {
return $this->callee->createProperty();
}
}