ProjectConfigurator::__construct() - Code Metrics - Inspection of "Skipped Test (#1335)" - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1117df...fac7df )

by Siad

created 2020-05-01 19:52 UTC

ProjectConfigurator::__construct() A

↳ Parent: ProjectConfigurator

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	2
dl	0
loc	6
ccs	5
cts	5
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php
/**
 * 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>.
 */

/**
 * The datatype handler class.
 *
 * This class handles the occurrence of registered datatype tags like
 * FileSet
 *
 * @author    Andreas Aderhold <[email protected]>
 * @copyright 2001,2002 THYRELL. All rights reserved
 * @package   phing.parser
 */
class ProjectConfigurator
{
    public const PARSING_CONTEXT_REFERENCE = "phing.parsing.context";

    /**
     * @var Project $project
     */
    public $project;
    public $locator;

    public $buildFile;
    public $buildFileParent;

    /**
     * Synthetic target that will be called at the end to the parse phase
     */
    private $parseEndTarget;

    /**
     * Name of the current project
     */
    private $currentProjectName;

    private $isParsing = true;

    /**
     * Indicates whether the project tag attributes are to be ignored
     * when processing a particular build file.
     */
    private $ignoreProjectTag = false;

    /**
     * Static call to ProjectConfigurator. Use this to configure a
     * project. Do not use the new operator.
     *
     * @param Project $project the Project instance this configurator should use
     * @param PhingFile $buildFile the buildfile object the parser should use
     *
     * @throws \IOException
     * @throws \BuildException
     * @throws NullPointerException
     */
    public static function configureProject(Project $project, PhingFile $buildFile): void
    {
        (new self($project, $buildFile))->parse();
    }

    /**
     * Constructs a new ProjectConfigurator object
     * This constructor is private. Use a static call to
     * <code>configureProject</code> to configure a project.
     *
     * @param  Project $project the Project instance this configurator should use
     * @param  PhingFile $buildFile the buildfile object the parser should use
     * @throws IOException
     * @throws NullPointerException
     */
    private function __construct(Project $project, PhingFile $buildFile)
    {
        $this->project = $project;
        $this->buildFile = new PhingFile($buildFile->getAbsolutePath());
        $this->buildFileParent = new PhingFile($this->buildFile->getParent());
        $this->parseEndTarget = new Target();
    }

    /**
     * find out the build file
     *
     * @return PhingFile the build file to which the xml context belongs
     */
    public function getBuildFile()
    {
        return $this->buildFile;
    }

    /**
     * find out the parent build file of this build file
     *
     * @return PhingFile the parent build file of this build file
     */
    public function getBuildFileParent()
    {
        return $this->buildFileParent;
    }

    /**
     * find out the current project name
     *
     * @return string current project name
     */
    public function getCurrentProjectName()
    {
        return $this->currentProjectName;
    }

    /**
     * set the name of the current project
     *
     * @param string $name name of the current project
     */
    public function setCurrentProjectName($name)
    {
        $this->currentProjectName = $name;
    }

    /**
     * tells whether the project tag is being ignored
     *
     * @return bool whether the project tag is being ignored
     */
    public function isIgnoringProjectTag()
    {
        return $this->ignoreProjectTag;
    }

    /**
     * sets the flag to ignore the project tag
     *
     * @param bool $flag flag to ignore the project tag
     */
    public function setIgnoreProjectTag($flag)
    {
        $this->ignoreProjectTag = $flag;
    }

    /**
     * @return bool
     */
    public function isParsing()
    {
        return $this->isParsing;
    }

    /**
     * Creates the ExpatParser, sets root handler and kick off parsing
     * process.
     *
     * @throws BuildException if there is any kind of exception during
     *                        the parsing process
     */
    protected function parse()
    {
        try {
            // get parse context
            $ctx = $this->project->getReference(self::PARSING_CONTEXT_REFERENCE);
            if (null == $ctx) {
                // make a new context and register it with project
                $ctx = new PhingXMLContext($this->project);
                $this->project->addReference(self::PARSING_CONTEXT_REFERENCE, $ctx);
            }

            //record this parse with context
            $ctx->addImport($this->buildFile);

            if (count($ctx->getImportStack()) > 1) {
                $currentImplicit = $ctx->getImplicitTarget();
                $currentTargets = $ctx->getCurrentTargets();

                $newCurrent = new Target();
                $newCurrent->setProject($this->project);
                $newCurrent->setName('');
                $ctx->setCurrentTargets([]);
                $ctx->setImplicitTarget($newCurrent);

                // this is an imported file
                // modify project tag parse behavior
                $this->setIgnoreProjectTag(true);
                $this->_parse($ctx);
                $newCurrent->main();

                $ctx->setImplicitTarget($currentImplicit);
                $ctx->setCurrentTargets($currentTargets);
            } else {
                $ctx->setCurrentTargets([]);
                $this->_parse($ctx);
                $ctx->getImplicitTarget()->main();
            }

            $this->resolveExtensionOfAttributes($this->project, $ctx);
        } catch (Exception $exc) {
            //throw new BuildException("Error reading project file", $exc);
            throw $exc;
        }
    }

    /**
     * @param PhingXMLContext $ctx
     * @throws ExpatParseException
     */
    protected function _parse(PhingXMLContext $ctx)
    {
        // push action onto global stack
        $ctx->startConfigure($this);

        $reader = new BufferedReader(new FileReader($this->buildFile));
        $parser = new ExpatParser($reader);
        $parser->parserSetOption(XML_OPTION_CASE_FOLDING, 0);
        $parser->setHandler(new RootHandler($parser, $this, $ctx));
        $this->project->log("parsing buildfile " . $this->buildFile->getName(), Project::MSG_VERBOSE);
        $parser->parse();
        $reader->close();

        // mark parse phase as completed
        $this->isParsing = false;
        // execute delayed tasks
        $this->parseEndTarget->main();
        // pop this action from the global stack
        $ctx->endConfigure();
    }

    /**
     * Delay execution of a task until after the current parse phase has
     * completed.
     *
     * @param Task $task Task to execute after parse
     */
    public function delayTaskUntilParseEnd($task)
    {
        $this->parseEndTarget->addTask($task);
    }

    /**
     * Configures an element and resolves eventually given properties.
     *
     * @param  mixed $target element to configure
     * @param  array $attrs element's attributes
     * @param  Project $project project this element belongs to
     * @throws BuildException
     * @throws Exception
     */
    public static function configure($target, $attrs, Project $project)
    {
        if ($target instanceof TypeAdapter) {
            $target = $target->getProxy();
        }

        // if the target is an UnknownElement, this means that the tag had not been registered
        // when the enclosing element (task, target, etc.) was configured.  It is possible, however,
        // that the tag was registered (e.g. using <taskdef>) after the original configuration.
        // ... so, try to load it again:
        if ($target instanceof UnknownElement) {
            $tryTarget = $project->createTask($target->getTaskType());
            if ($tryTarget) {

                $target = $tryTarget;
            }
        }

        $bean = get_class($target);
        $ih = IntrospectionHelper::getHelper($bean);

        foreach ($attrs as $key => $value) {
            if ($key === 'id') {
                continue;
                // throw new BuildException("Id must be set Extermnally");
            }
            if (!is_string($value) && method_exists($value, 'main')) {
                $value = $value->main();
            } else {
                $value = $project->replaceProperties($value);
            }
            try { // try to set the attribute
                $ih->setAttribute($project, $target, strtolower($key), $value);
            } catch (BuildException $be) {
                // id attribute must be set externally
                if ($key !== 'id') {
                    throw $be;
                }
            }
        }
    }

    /**
     * Configures the #CDATA of an element.
     *
     * @param Project $project the project this element belongs to
     * @param object  the element to configure
     * @param string $text the element's #CDATA
     */
    public static function addText($project, $target, $text = null)
    {
        if ($text === null || strlen(trim($text)) === 0) {
            return;
        }
        $ih = IntrospectionHelper::getHelper(get_class($target));
        $text = $project->replaceProperties($text);
        $ih->addText($project, $target, $text);
    }

    /**
     * Stores a configured child element into its parent object
     *
     * @param object  the project this element belongs to
     * @param object  the parent element
     * @param object  the child element
     * @param string  the XML tagname
     */
    public static function storeChild($project, $parent, $child, $tag)
    {
        $ih = IntrospectionHelper::getHelper(get_class($parent));
        $ih->storeElement($project, $parent, $child, $tag);
    }

    /**
     * Scan Attributes for the id attribute and maybe add a reference to
     * project.
     *
     * @param object $target the element's object
     * @param array $attr the element's attributes
     */
    public function configureId($target, $attr)
    {
        if (isset($attr['id']) && $attr['id'] !== null) {
            $this->project->addReference($attr['id'], $target);
        }
    }

    /**
     * Add location to build exception.
     *
     * @param  BuildException $ex the build exception, if the build exception
     *                                    does not include
     * @param  Location $newLocation the location of the calling task (may be null)
     * @return BuildException a new build exception based in the build exception with
     *         location set to newLocation. If the original exception
     *         did not have a location, just return the build exception
     */
    public static function addLocationToBuildException(BuildException $ex, Location $newLocation)
    {
        if ($ex->getLocation() === null || $ex->getMessage() === null) {
            return $ex;
        }
        $errorMessage = sprintf(
            "The following error occurred while executing this line:%s%s %s%s",
            PHP_EOL,
            $ex->getLocation(),
            $ex->getMessage(),
            PHP_EOL
        );
        if ($ex instanceof ExitStatusException) {
            $exitStatus = $ex->getCode();
            if ($newLocation === null) {
                return new ExitStatusException($errorMessage, $exitStatus);
            }
            return new ExitStatusException($errorMessage, $exitStatus, $newLocation);
        }

        return new BuildException($errorMessage, $ex, $newLocation);
    }

    /**
     * Check extensionStack and inject all targets having extensionOf attributes
     * into extensionPoint.
     * <p>
     * This method allow you to defer injection and have a powerful control of
     * extensionPoint wiring.
     * </p>
     * <p>
     * This should be invoked by each concrete implementation of ProjectHelper
     * when the root "buildfile" and all imported/included buildfile are loaded.
     * </p>
     *
     * @param Project $project The project containing the target. Must not be
     *            <code>null</code>.
     * @throws BuildException if OnMissingExtensionPoint.FAIL and
     *                extensionPoint does not exist
     * @see OnMissingExtensionPoint
     */
    public function resolveExtensionOfAttributes(Project $project, PhingXMLContext $ctx)
    {
        /** @var PhingXMLContext $ctx */
        foreach ($ctx->getExtensionPointStack() as [$extPointName, $targetName, $missingBehaviour, $prefixAndSep]) {
            // find the target we're extending
            $projectTargets = $project->getTargets();
            $extPoint = null;
            if ($prefixAndSep === null) {
                // no prefix - not from an imported/included build file
                $extPoint = isset($projectTargets[$extPointName]) ? $projectTargets[$extPointName] : null;
            } else {
                // we have a prefix, which means we came from an include/import

                // FIXME: here we handle no particular level of include. We try
                // the fully prefixed name, and then the non-prefixed name. But
                // there might be intermediate project in the import stack,
                // which prefix should be tested before testing the non-prefix
                // root name.

                $extPoint = isset($projectTargets[$prefixAndSep . $extPointName]) ? $projectTargets[$prefixAndSep . $extPointName] : null;
                if ($extPoint === null) {
                    $extPoint = isset($projectTargets[$extPointName]) ? $projectTargets[$extPointName] : null;
                }
            }

            // make sure we found a point to extend on
            if ($extPoint === null) {
                $message = "can't add target " . $targetName
                    . " to extension-point " . $extPointName
                    . " because the extension-point is unknown.";
                if ($missingBehaviour === 'fail') {
                    throw new BuildException($message);
                }
                if ($missingBehaviour === 'warn') {
                    $t = $projectTargets[$targetName];

                    $project->log("Warning: " . $message, Project::MSG_WARN);
                }
            } else {
                if (!$extPoint instanceof ExtensionPoint) {
                    throw new BuildException("referenced target " . $extPointName
                        . " is not an extension-point");
                }
                $extPoint->addDependency($targetName);
            }
        }
    }
}


1		<?php
2		/**
3		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14		*
15		* This software consists of voluntary contributions made by many individuals
16		* and is licensed under the LGPL. For more information please see
17		* <http://phing.info>.
18		*/
19
20		/**
21		* The datatype handler class.
22		*
23		* This class handles the occurrence of registered datatype tags like
24		* FileSet
25		*
26		* @author Andreas Aderhold <[email protected]>
27		* @copyright 2001,2002 THYRELL. All rights reserved
28		* @package phing.parser
29		*/
30		class ProjectConfigurator
31		{
32		public const PARSING_CONTEXT_REFERENCE = "phing.parsing.context";
33
34		/**
35		* @var Project $project
36		*/
37		public $project;
38		public $locator;
39
40		public $buildFile;
41		public $buildFileParent;
42
43		/**
44		* Synthetic target that will be called at the end to the parse phase
45		*/
46		private $parseEndTarget;
47
48		/**
49		* Name of the current project
50		*/
51		private $currentProjectName;
52
53		private $isParsing = true;
54
55		/**
56		* Indicates whether the project tag attributes are to be ignored
57		* when processing a particular build file.
58		*/
59		private $ignoreProjectTag = false;
60
61		/**
62		* Static call to ProjectConfigurator. Use this to configure a
63		* project. Do not use the new operator.
64		*
65		* @param Project $project the Project instance this configurator should use
66		* @param PhingFile $buildFile the buildfile object the parser should use
67		*
68		* @throws \IOException
69		* @throws \BuildException
70		* @throws NullPointerException
71		*/
72	809	public static function configureProject(Project $project, PhingFile $buildFile): void
73		{
74	809	(new self($project, $buildFile))->parse();
75	809	}
76
77		/**
78		* Constructs a new ProjectConfigurator object
79		* This constructor is private. Use a static call to
80		* <code>configureProject</code> to configure a project.
81		*
82		* @param Project $project the Project instance this configurator should use
83		* @param PhingFile $buildFile the buildfile object the parser should use
84		* @throws IOException
85		* @throws NullPointerException
86		*/
87	809	private function __construct(Project $project, PhingFile $buildFile)
88		{
89	809	$this->project = $project;
90	809	$this->buildFile = new PhingFile($buildFile->getAbsolutePath());
91	809	$this->buildFileParent = new PhingFile($this->buildFile->getParent());
92	809	$this->parseEndTarget = new Target();
93	809	}
94
95		/**
96		* find out the build file
97		*
98		* @return PhingFile the build file to which the xml context belongs
99		*/
100	809	public function getBuildFile()
101		{
102	809	return $this->buildFile;
103		}
104
105		/**
106		* find out the parent build file of this build file
107		*
108		* @return PhingFile the parent build file of this build file
109		*/
110		public function getBuildFileParent()
111		{
112		return $this->buildFileParent;
113		}
114
115		/**
116		* find out the current project name
117		*
118		* @return string current project name
119		*/
120	92	public function getCurrentProjectName()
121		{
122	92	return $this->currentProjectName;
123		}
124
125		/**
126		* set the name of the current project
127		*
128		* @param string $name name of the current project
129		*/
130	809	public function setCurrentProjectName($name)
131		{
132	809	$this->currentProjectName = $name;
133	809	}
134
135		/**
136		* tells whether the project tag is being ignored
137		*
138		* @return bool whether the project tag is being ignored
139		*/
140	809	public function isIgnoringProjectTag()
141		{
142	809	return $this->ignoreProjectTag;
143		}
144
145		/**
146		* sets the flag to ignore the project tag
147		*
148		* @param bool $flag flag to ignore the project tag
149		*/
150	100	public function setIgnoreProjectTag($flag)
151		{
152	100	$this->ignoreProjectTag = $flag;
153	100	}
154
155		/**
156		* @return bool
157		*/
158		public function isParsing()
159		{
160		return $this->isParsing;
161		}
162
163		/**
164		* Creates the ExpatParser, sets root handler and kick off parsing
165		* process.
166		*
167		* @throws BuildException if there is any kind of exception during
168		* the parsing process
169		*/
170	809	protected function parse()
171		{
172		try {
173		// get parse context
174	809	$ctx = $this->project->getReference(self::PARSING_CONTEXT_REFERENCE);
175	809	if (null == $ctx) {
176		// make a new context and register it with project
177	809	$ctx = new PhingXMLContext($this->project);
178	809	$this->project->addReference(self::PARSING_CONTEXT_REFERENCE, $ctx);
179		}
180
181		//record this parse with context
182	809	$ctx->addImport($this->buildFile);
183
184	809	if (count($ctx->getImportStack()) > 1) {
185	100	$currentImplicit = $ctx->getImplicitTarget();
186	100	$currentTargets = $ctx->getCurrentTargets();
187
188	100	$newCurrent = new Target();
189	100	$newCurrent->setProject($this->project);
190	100	$newCurrent->setName('');
191	100	$ctx->setCurrentTargets([]);
192	100	$ctx->setImplicitTarget($newCurrent);
193
194		// this is an imported file
195		// modify project tag parse behavior
196	100	$this->setIgnoreProjectTag(true);
197	100	$this->_parse($ctx);
198	100	$newCurrent->main();
199
200	100	$ctx->setImplicitTarget($currentImplicit);
201	100	$ctx->setCurrentTargets($currentTargets);
202		} else {
203	809	$ctx->setCurrentTargets([]);
204	809	$this->_parse($ctx);
205	809	$ctx->getImplicitTarget()->main();
206		}
207
208	809	$this->resolveExtensionOfAttributes($this->project, $ctx);
209	4	} catch (Exception $exc) {
210		//throw new BuildException("Error reading project file", $exc);
211	4	throw $exc;
212		}
213	809	}
214
215		/**
216		* @param PhingXMLContext $ctx
217		* @throws ExpatParseException
218		*/
219	809	protected function _parse(PhingXMLContext $ctx)
220		{
221		// push action onto global stack
222	809	$ctx->startConfigure($this);
223
224	809	$reader = new BufferedReader(new FileReader($this->buildFile));
225	809	$parser = new ExpatParser($reader);
226	809	$parser->parserSetOption(XML_OPTION_CASE_FOLDING, 0);
227	809	$parser->setHandler(new RootHandler($parser, $this, $ctx));
228	809	$this->project->log("parsing buildfile " . $this->buildFile->getName(), Project::MSG_VERBOSE);
229	809	$parser->parse();
230	809	$reader->close();
231
232		// mark parse phase as completed
233	809	$this->isParsing = false;
234		// execute delayed tasks
235	809	$this->parseEndTarget->main();
236		// pop this action from the global stack
237	809	$ctx->endConfigure();
238	809	}
239
240		/**
241		* Delay execution of a task until after the current parse phase has
242		* completed.
243		*
244		* @param Task $task Task to execute after parse
245		*/
246		public function delayTaskUntilParseEnd($task)
247		{
248		$this->parseEndTarget->addTask($task);
249		}
250
251		/**
252		* Configures an element and resolves eventually given properties.
253		*
254		* @param mixed $target element to configure
255		* @param array $attrs element's attributes
256		* @param Project $project project this element belongs to
257		* @throws BuildException
258		* @throws Exception
259		*/
260	661	public static function configure($target, $attrs, Project $project)
261		{
262	661	if ($target instanceof TypeAdapter) {
263	231	$target = $target->getProxy();
264		}
265
266		// if the target is an UnknownElement, this means that the tag had not been registered
267		// when the enclosing element (task, target, etc.) was configured. It is possible, however,
268		// that the tag was registered (e.g. using <taskdef>) after the original configuration.
269		// ... so, try to load it again:
270	661	if ($target instanceof UnknownElement) {
271		$tryTarget = $project->createTask($target->getTaskType());
272		if ($tryTarget) {
		0 ignored issues – show introduced 2019-07-31 09:36 UTC by Report Bug Copy Issue Report `$tryTarget` is of type `Task`, thus it always evaluated to `true`. Loading history...
273		$target = $tryTarget;
274		}
275		}
276
277	661	$bean = get_class($target);
278	661	$ih = IntrospectionHelper::getHelper($bean);
279
280	661	foreach ($attrs as $key => $value) {
281	651	if ($key === 'id') {
282	67	continue;
283		// throw new BuildException("Id must be set Extermnally");
284		}
285	651	if (!is_string($value) && method_exists($value, 'main')) {
286		$value = $value->main();
287		} else {
288	651	$value = $project->replaceProperties($value);
289		}
290		try { // try to set the attribute
291	651	$ih->setAttribute($project, $target, strtolower($key), $value);
292	8	} catch (BuildException $be) {
293		// id attribute must be set externally
294	8	if ($key !== 'id') {
295	8	throw $be;
296		}
297		}
298		}
299	660	}
300
301		/**
302		* Configures the #CDATA of an element.
303		*
304		* @param Project $project the project this element belongs to
305		* @param object the element to configure
306		* @param string $text the element's #CDATA
307		*/
308	450	public static function addText($project, $target, $text = null)
309		{
310	450	if ($text === null \|\| strlen(trim($text)) === 0) {
311	412	return;
312		}
313	66	$ih = IntrospectionHelper::getHelper(get_class($target));
314	66	$text = $project->replaceProperties($text);
315	66	$ih->addText($project, $target, $text);
316	66	}
317
318		/**
319		* Stores a configured child element into its parent object
320		*
321		* @param object the project this element belongs to
322		* @param object the parent element
323		* @param object the child element
324		* @param string the XML tagname
325		*/
326		public static function storeChild($project, $parent, $child, $tag)
327		{
328		$ih = IntrospectionHelper::getHelper(get_class($parent));
329		$ih->storeElement($project, $parent, $child, $tag);
330		}
331
332		/**
333		* Scan Attributes for the id attribute and maybe add a reference to
334		* project.
335		*
336		* @param object $target the element's object
337		* @param array $attr the element's attributes
338		*/
339	804	public function configureId($target, $attr)
340		{
341	804	if (isset($attr['id']) && $attr['id'] !== null) {
342	96	$this->project->addReference($attr['id'], $target);
343		}
344	804	}
345
346		/**
347		* Add location to build exception.
348		*
349		* @param BuildException $ex the build exception, if the build exception
350		* does not include
351		* @param Location $newLocation the location of the calling task (may be null)
352		* @return BuildException a new build exception based in the build exception with
353		* location set to newLocation. If the original exception
354		* did not have a location, just return the build exception
355		*/
356	2	public static function addLocationToBuildException(BuildException $ex, Location $newLocation)
357		{
358	2	if ($ex->getLocation() === null \|\| $ex->getMessage() === null) {
359		return $ex;
360		}
361	2	$errorMessage = sprintf(
362	2	"The following error occurred while executing this line:%s%s %s%s",
363	2	PHP_EOL,
364	2	$ex->getLocation(),
365	2	$ex->getMessage(),
366	2	PHP_EOL
367		);
368	2	if ($ex instanceof ExitStatusException) {
369		$exitStatus = $ex->getCode();
370		if ($newLocation === null) {
371		return new ExitStatusException($errorMessage, $exitStatus);
372		}
373		return new ExitStatusException($errorMessage, $exitStatus, $newLocation);
374		}
375
376	2	return new BuildException($errorMessage, $ex, $newLocation);
377		}
378
379		/**
380		* Check extensionStack and inject all targets having extensionOf attributes
381		* into extensionPoint.
382		* <p>
383		* This method allow you to defer injection and have a powerful control of
384		* extensionPoint wiring.
385		* </p>
386		* <p>
387		* This should be invoked by each concrete implementation of ProjectHelper
388		* when the root "buildfile" and all imported/included buildfile are loaded.
389		* </p>
390		*
391		* @param Project $project The project containing the target. Must not be
392		* <code>null</code>.
393		* @throws BuildException if OnMissingExtensionPoint.FAIL and
394		* extensionPoint does not exist
395		* @see OnMissingExtensionPoint
396		*/
397	809	public function resolveExtensionOfAttributes(Project $project, PhingXMLContext $ctx)
398		{
399		/** @var PhingXMLContext $ctx */
400	809	foreach ($ctx->getExtensionPointStack() as [$extPointName, $targetName, $missingBehaviour, $prefixAndSep]) {
401		// find the target we're extending
402	7	$projectTargets = $project->getTargets();
403	7	$extPoint = null;
404	7	if ($prefixAndSep === null) {
405		// no prefix - not from an imported/included build file
406	7	$extPoint = isset($projectTargets[$extPointName]) ? $projectTargets[$extPointName] : null;
407		} else {
408		// we have a prefix, which means we came from an include/import
409
410		// FIXME: here we handle no particular level of include. We try
411		// the fully prefixed name, and then the non-prefixed name. But
412		// there might be intermediate project in the import stack,
413		// which prefix should be tested before testing the non-prefix
414		// root name.
415
416		$extPoint = isset($projectTargets[$prefixAndSep . $extPointName]) ? $projectTargets[$prefixAndSep . $extPointName] : null;
417		if ($extPoint === null) {
418		$extPoint = isset($projectTargets[$extPointName]) ? $projectTargets[$extPointName] : null;
419		}
420		}
421
422		// make sure we found a point to extend on
423	7	if ($extPoint === null) {
424	3	$message = "can't add target " . $targetName
425	3	. " to extension-point " . $extPointName
426	3	. " because the extension-point is unknown.";
427	3	if ($missingBehaviour === 'fail') {
428	1	throw new BuildException($message);
429		}
430	2	if ($missingBehaviour === 'warn') {
431	1	$t = $projectTargets[$targetName];
		0 ignored issues – show Unused Code introduced 2020-05-01 11:20 UTC by Report Bug Copy Issue Report The assignment to `$t` is dead and can be removed. Loading history...
432	1	$project->log("Warning: " . $message, Project::MSG_WARN);
433		}
434		} else {
435	4	if (!$extPoint instanceof ExtensionPoint) {
436	1	throw new BuildException("referenced target " . $extPointName
437	1	. " is not an extension-point");
438		}
439	3	$extPoint->addDependency($targetName);
440		}
441		}
442	809	}
443		}
444

phingofficial / phing

Push — master ( 1117df...fac7df )

ProjectConfigurator::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like